Network API Purposes
Network APIs require each participating mobile network operator to know the purpose for which you are making the API call to ensure that you intend to use the services for a purpose acceptable and approved by the mobile network operator. Any other use of the services is prohibited. For further information please visit the Supplemental Terms and the Acceptable Use Policy.
The full list of purposes and their descriptions are as follows:
| Purpose | Purpose Description |
|---|---|
NotApplicable | No personal data is shared, so a purpose is not required. |
FraudPreventionAndDetection | Use of the APIs to detect and prevent fraudulent activity in your applications. |
Each API has one or more API scopes that relate to the endpoint you will invoke when using the API, which are used as part of the authentication process. The purposes and scopes allowed for each operation differ by regulatory area and mobile network support.
Below is a list of all possible purposes and scopes per API:
| API | API Scope | Purposes |
|---|---|---|
| Device Status | device-status:roaming:read | NotApplicable |
device-status:connectivity:read | NotApplicable | |
| SIM Swap | retrieve-sim-swap-date | FraudPreventionAndDetection |
check-sim-swap | FraudPreventionAndDetection |