Vonage SIM Swap API

SIM Swap API provides the ability to obtain information on any recent SIM pairing change related to a mobile account.

NB: This API is based on the Camara SimSwap API v0.4.0 https://github.com/camaraproject/SimSwap/releases/tag/v0.4.0.

Download OpenAPI Specification
Available Operations

Check SIM swap

Check if SIM swap has been performed during a past period

posthttps://api-eu.vonage.com/camara/sim-swap/v040/check

Authentication

OAuth 2.0 (three_legged_check)

For detailed information on authentication with the SIM Swap API, please refer to our authentication guide.

pages.documentation.api.security.scopes:
  • openid dpv:FraudPreventionAndDetection#check-sim-swap - Check SIM swap

Request Body
Content Type
application/json

phoneNumber
string
Required
example+346661113334

Subscriber number in E.164 format starting with country code and optionally prefixed with '+'.

maxAge
integer(int32)
Min1
Max2400
Default240
example240

Period in hours to be checked for SIM swap (optional).

Example Request

{
   "phoneNumber": "+346661113334",
   "maxAge": 240
}

Responses
Content Type
application/json

Returns if the SIM card associated with a phone number has changed within a specified time

swapped
boolean

Indicates whether the SIM card has been swapped during the period within the provided age.

Example Response

{
   "swapped": true
}

Retrieve SIM swap date

Get timestamp of last link between the phone number and a SIM card.

posthttps://api-eu.vonage.com/camara/sim-swap/v040/retrieve-date

Authentication

OAuth 2.0 (three_legged_retrieve)

For detailed information on authentication with the SIM Swap API, please refer to our authentication guide.

pages.documentation.api.security.scopes:
  • openid dpv:FraudPreventionAndDetection#retrieve-sim-swap-date - Retrieve SIM Swap date

Request Body
Content Type
application/json

phoneNumber
string
Required
example+346661113334

Subscriber number in E.164 format starting with country code and optionally prefixed with '+'.

Example Request

{
   "phoneNumber": "+346661113334"
}

Responses
Content Type
application/json

Contains information about SIM swap change

latestSimChange
string(date-time)

Timestamp of latest SIM swap performed.

Example Response

{
   "latestSimChange": "2019-08-24T14:15:22Z"
}