POST
/
v3
/
unify-bind
curl --request POST \
  --url https://platform.uat.proveapis.com/v3/unify-bind \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "phoneNumber": "2001004011",
  "clientRequestId": "71010d88-d0e7-4a24-9297-d1be6fefde81",
  "correlationId": "713189b8-5555-4b08-83ba-75d08780aebd"
}'
{
  "phoneNumber": "2001004011",
  "success": "success"
}

Use the following base URLs when integrating :

https://platform.uat.proveapis.com - North America Staging Environment https://platform.proveapis.com - North America Production Environment https://platform.uat.eu.proveapis.com - European Union Staging Environment https://platform.eu.proveapis.com - European Union Production Environment

For international calls, add a plus sign + to the front, followed by the phone number. This is optional for North America mobile numbers.

Verify North America numbers against the North America Prove Platform endpoint. Verify international numbers against the European Union Prove Platform endpoint.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
clientRequestId
string

A client-generated unique ID for a specific request.

Example:

"71010d88-d0e7-4a24-9297-d1be6fefde81"

​
correlationId
string

The unique ID that Prove generates for the flow. It is returned from the v3/unify endpoint and cannot be reused outside of a single flow.

Example:

"713189b8-5555-4b08-83ba-75d08780aebd"

​
phoneNumber
string

The number of the mobile phone. Required when possessionType=none in the initial Unify request.

Example:

"2001004011"

Response

200
application/json
Successful Request.
​
phoneNumber
string
required

The number of the mobile phone used during the process.

Example:

"2001004011"

​
success
string
required