Request Number Verify
Number Verify is a service that checks if a provided phone number is valid and online.
It requires the person whose phone number is being checked to use their mobile data to load a web address.
Request
URL
POST https://api.cm.com/mobile-identity/v1/number-verify
Headers
Content-Type: application/json
Authorization: Bearer GENERATED_TOKEN_HERE
Body
{
"phoneNumber": "+31612345678",
"callbackUrl": "https://mycallbackurl"
}
Parameters
Property | Type | Required | Description |
---|---|---|---|
phoneNumber | string | Yes | The phone number to verify. This must be a valid phone number in E.164 format. |
callbackUrl | string | Yes | Updates regarding the number verify transaction will be sent to the callback URL. The URL must begin with https:// . See Events for more information. |
Response
{
"id": "6f8d0a9d-b85c-4c3f-9e69-5699f1e00f49",
"state": "pending",
"match": null,
"sessionUrl": "http://example.com/v1/dm/session/d635424bb0a54d388477cb17fa308655"
}
Parameters
Property | Description |
---|---|
id | Unique identifier of the number verify transaction. In GUID format. Use this to retrieve this number verify transaction in the future. |
state | Status of the number verify transaction. Will always be pending when requesting. |
match | true or false , depending on whether the number is verified. The value will be null unless state is completed . |
sessionUrl | The URL to be loaded from the mobile device using mobile data. |
Updated 2 months ago