Vonage SIM Swap API

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

Télécharger la spécification OpenAPI
Opérations disponibles

Check SIM swap

Check if SIM swap has been performed during a past period

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

Authentification

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

Corps de la demande
Type de contenu
application/json

phoneNumber
string
Exigée
exemple+346661113334

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

maxAge
integer(int32)
Min1
Max2400
Défaut240
exemple240

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

Exemple Demande

Réponses
Type de contenu
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.

Exemple Réponse

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

Authentification

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

Corps de la demande
Type de contenu
application/json

phoneNumber
string
Exigée
exemple+346661113334

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

Exemple Demande

Réponses
Type de contenu
application/json

Contains information about SIM swap change

latestSimChange
string(date-time)

Timestamp of latest SIM swap performed.

Exemple Réponse