Number Verification V1

PhoneNumberVerifyRequest

object
phoneNumberstringrequired

MSISDN in E.164 format entered by the end user

Example:+919036499174

Example

NumberVerificationResult

object
devicePhoneNumberVerifiedbooleanrequired

Indicates whether the provided MSISDN matches the phone number of the device/SIM on the network

Example:true

assessedAtstring(date-time)

Timestamp when verification was performed

Example

TokenRequest

object
grant_typestringrequired

Allowed values:authorization_code

Example:authorization_code

codestringrequired

Authorization code received from authorize endpoint

redirect_uristring(uri)required

Must match the redirect URI used in the authorize request

client_idstringrequired

Client identifier

client_secretstringrequired

Client secret

Example

TokenResponse

object
access_tokenstringrequired

Access token for API calls

token_typestringrequired

Allowed values:Bearer

Example:Bearer

expires_inintegerrequired

Token expiration time in seconds

Example:3600

scopestringrequired

Granted scopes

Example:openid number-verification:verify

refresh_tokenstring

Refresh token if offline_access was requested

id_tokenstring

OpenID Connect ID token if openid scope was requested

Example

Error

object
statusintegerrequired

Example:400

codestringrequired

Example:INVALID_ARGUMENT

messagestringrequired

Example:Invalid request

Example