Vonage Number Verification API

The Number Verification API helps you verify the phone number associated with the SIM used in the device connected to the mobile data network.

This API is based on the Camara NumberVerification v.0.3.1 https://github.com/camaraproject/NumberVerification/releases/tag/v0.3.1

Please note: If you are using the Number Verification API in Germany, you must include specific wording in your application to gain consent for IP matching and processing. See here for more information.

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

Phone number verify

Verifies if the specified phone number (plain text or hashed format) matches the one that the user is currently using. The number verification will be done for the user that has authenticated via mobile network.

posthttps://api-eu.vonage.com/camara/number-verification/v031/verify

Authentification

OAuth 2.0 (three_legged)

For detailed information on authentication with the Number Verification API, please refer to our authentication guide.

pages.documentation.api.security.scopes:
  • openid dpv:FraudPreventionAndDetection#number-verification-verify-read - Phone number verify and share

Corps de la demande
Type de contenu
application/json

L'un des
phoneNumber
string
Exigée
exemple+34123456789

A phone number belonging to the user in E.164 format (starting with country code). Optionally prefixed with '+'.

Exemple Demande»Phone number

{
   "phoneNumber": "+34123456789"
}

Réponses
Type de contenu
application/json

OK

devicePhoneNumberVerified
boolean
Exigée

Number verification. True, if it matches

Exemple Réponse

{
   "devicePhoneNumberVerified": true
}