POST
/
v3
/
unify
curl --request POST \
  --url https://platform.uat.proveapis.com/v3/unify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "finalTargetUrl": "https://www.example.com/landing-page",
  "possessionType": "mobile",
  "phoneNumber": "2001004011",
  "smsMessage": "#### is your verification code",
  "clientRequestId": "71010d88-d0e7-4a24-9297-d1be6fefde81",
  "clientCustomerId": "e0f78bc2-f748-4eda-9d29-d756844507fc"
}'
{
  "success": "success",
  "authToken": "eyJhbGciOi...",
  "correlationId": "713189b8-5555-4b08-83ba-75d08780aebd"
}

Welcome to the Prove Platform documentation. This documentation applies if you use the client-side SDK and Prove Platform APIs.

For access to classic documentation, contact support@prove.com or your Prove representative.

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
​
possessionType
string
required

The type of device being used - either desktop if using a desktop, mobile for iOS/Android native apps and mobile web, or none if no possession check is required.

Example:

"mobile"

​
clientCustomerId
string

A client-generated unique ID for a specific customer.

Example:

"e0f78bc2-f748-4eda-9d29-d756844507fc"

​
clientRequestId
string

A client-generated unique ID for a specific session.

Example:

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

​
finalTargetUrl
string

The final target URL is where the end user will be redirected at the end of Instant Link flow. Required when possessionType=desktop. Acceptable characters are: alphanumeric with symbols '-._+=/:?'.

Example:

"https://www.example.com/landing-page"

​
phoneNumber
string

The number of the mobile phone. Optional in US, required in EU. Not allowed when possessionType is none. Acceptable characters are: alphanumeric with symbols '+'.

Example:

"2001004011"

​
smsMessage
string

The message body sent in the Instant Link (possessionType=desktop) or OTP (possessionType=mobile) SMS message.

Example:

"#### is your verification code"

Response

200
application/json
Successful Request.
​
correlationId
string
required

The unique ID that Prove generates for the flow.

Example:

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

​
success
string
required
​
authToken
string

The one-time use JWT for the client-side SDK.

Example:

"eyJhbGciOi..."