POST
/
v3
/
verify
curl --request POST \
  --url https://platform.uat.proveapis.com/v3/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "finalTargetUrl": "https://www.example.com/landing-page",
  "firstName": "Sheilakathryn",
  "lastName": "Butrimovich",
  "emailAddress": "sbutrimovichb@who.int",
  "possessionType": "mobile",
  "phoneNumber": "2001004011",
  "smsMessage": "1234 is your temporary code to continue your application. Caution: for your security, don'\''t share this code with anyone.",
  "clientRequestId": "71010d88-d0e7-4a24-9297-d1be6fefde81",
  "clientCustomerId": "e0f78bc2-f748-4eda-9d29-d756844507fc"
}'
{
  "success": "pending",
  "authToken": "eyJhbGciOi...",
  "possessionResult": "pending",
  "verifyResult": "pending",
  "correlationId": "713189b8-5555-4b08-83ba-75d08780aebd"
}

Use the following base URLs when integrating :

https://platform.uat.proveapis.com - North America Sandbox Environment

https://platform.proveapis.com - North America Production Environment

https://platform.uat.eu.proveapis.com - European Union Sandbox 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.

SMSMessage will use a default message as described below if no custom message is passed in. This default message will always be in English. Prove recommends using a native-language custom SMS Message for non-English speaking countries.

Authorizations

​
Authorization
string
header
required

The access token received from the /token endpoint. Refer to the Authentication page for more details.

Body

application/json

Response

200
application/json
Successful request.

The response is of type object.