Verifies if the specified phone number (plain text or hashed format) matches the one associated with the access token.

  • The number verification will be done for the user that has authenticated via mobile network and so their sub is in the access token
  • It returns true/false depending on if the hashed phone number received as input matches the authenticated user's device phone number associated to the access token

Check the Authorization guide on how to get an OAuth2 token, with the following scope:

dpv:FraudPreventionAndDetection#number-verification-verify-read

Create an app on our Sandbox to get credentials and retrieve tokens so you can perform API calls to our operators' production environments, or use the following convenience token to test in mock mode:

mock_sandbox_access_token

You can explore our Number Verification sample code for additional guidance on using this API.

Body Params
Responses

Response body
object
boolean
required

Number verification. True, if it matches

PERMISSION_DENIED, other scenarios may exist:

  • Client authentication was not via mobile network. In order to check the authentication method, AMR parameter value in the 3-legged user's access token can be used and make sure that the authentication was not either by SMS+OTP nor username/password ({"code": "NUMBER_VERIFICATION.USER_NOT_AUTHENTICATED_BY_MOBILE_NETWORK","message": "Client must authenticate via the mobile network to use this service"})
  • Phone number cannot be deducted from access token context.({"code": "NUMBER_VERIFICATION.INVALID_TOKEN_CONTEXT","message": "Phone number cannot be deducted from access token context"})

Language
Credentials
OAuth2
URL