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.

Download OpenAPI Specification

Available Operations

Phone number verify

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

Authentication

OAuth 2.0 (three_legged)
For detailed information on authentication with the Number Verification API, please refer to our authentication guide.
Scopes: `openid dpv:FraudPreventionAndDetection#number-verification-verify-read` - Phone number verify and share

Request Body
Content Type
application/json

One Of

phoneNumber

string

Required

example+34123456789

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

Example Request»Phone number

{
   "phoneNumber": "+34123456789"
}

{
   "phoneNumber": "+34123456789"
}

Responses
Content Type
application/json

devicePhoneNumberVerified

boolean

Required

Number verification. True, if it matches

Example Response

{
   "devicePhoneNumberVerified": true
}