camara / original /DeviceLocation /documentation /API_documentation /location-verification-User-Story.md
Location Verification API User Story
| Item | Details |
|---|---|
| Summary | As an enterprise application developer, I want to verify the location of a user's device, so that I can ensure the device is within a specified area for security and contextual-based services. |
| Actors and Scope | Actors: Application service provider (ASP), ASP:User, ASP: BusinessManager, ASP:Administrator, Channel Partner, End-User, Communication Service Provider (CSP). Scope: - Verifies if the specified device is located within a predefined geographical area (e.g.circle with given coordinates and radius, polygon...). |
| Pre-conditions | The preconditions are listed below:
|
| Activities/Steps | Starts when: The ASP:User makes a POST request via the Location Verification API providing the End-User's device identifier (e.g., phone number), the area information (center coordinates and radius, polygon...) and the maximum age of the location information. Ends when: The CSP's Location Verification server responds with the verification result indicating if the End-User's device is within the specified area, partially matches the area, or is unknown. When the device partially matches the area, the server additionally responds with a match-rate, which defines a percent value of the intersection of both areas. |
| Post-conditions | The ASP:User could continue offering its service to the End-User with the confirmation of the End-User's device location. |
| Exceptions | Several exceptions might occur during the Location Verification API operations - Unauthorized: Invalid credentials (e.g., expired access token). - Incorrect input data (e.g., malformed phone number). - Not able to provide: Network unable to locate the device due to various reasons (e.g., device not connected, outdated location data). |