Vonage SIM Swap API

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

OpenAPI-Spezifikation herunterladen
Verfügbare Operationen

Check SIM swap

Check if SIM swap has been performed during a past period

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

Authentifizierung

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

Anfrage Körper
Inhalt Typ
application/json

phoneNumber
string
Erforderlich
Beispiel+346661113334

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

maxAge
integer(int32)
Min1
Max2400
Standard240
Beispiel240

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

Beispiel Anfrage

Antworten
Inhalt Typ
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.

Beispiel Antwort

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

Authentifizierung

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

Anfrage Körper
Inhalt Typ
application/json

phoneNumber
string
Erforderlich
Beispiel+346661113334

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

Beispiel Anfrage

Antworten
Inhalt Typ
application/json

Contains information about SIM swap change

latestSimChange
string(date-time)

Timestamp of latest SIM swap performed.

Beispiel Antwort