Making a Request with the SIM Swap API
This guide explains how to make your first request using the SIM Swap API.
Prerequisites
Before using the SIM Swap API, you will need to register your application with Vonage and the mobile operators. If you already have an approved registration, you are ready to start building your solution. If not, head to our guide on Vonage Network Registration for more information.
You must also generate an access token using the backend authentication flow. See the guide on Network API Authentication for more information.
If your registration has not been accepted by Vonage or any operator, for example, the Network API Registration status is ‘Pending’ or “Rejected’, you are not authorized to use or send any Network API requests.
Make the SIM Swap API Request
Make a
- Check: Has a SIM swap occurred during the last
nhours? - Retrieve Date: When did the last SIM swap occur?
To make the request, you'll use the access_token created as part of the prerequisites.
check request
https://api-eu.vonage.com/camara/sim-swap/v040/checkParameters
| Parameter | Description |
|---|---|
phoneNumber | The MSISDN / full phone number of the user you want to run a SIM Swap check for, e.g. 447700900000. |
maxAge | Period in hours to be checked, from 1 to 2400 (optional, default set to 240) |
Successful check response (200)
A successful response will contain the swapped field, a Boolean value that indicates whether a SIM swap has been performed during the period specified in your request.
retrieve-date request
Parameters
| Parameter | Description |
|---|---|
phoneNumber | The MSISDN / full phone number of the user you want to run a SIM Swap check for, e.g. 447700900000. |
Successful retrieve-date response (200)
A successful response will contain the latestSimChange field showing the timestamp of the latest SIM swap performed.