POST
/
v3
/
validate
curl --request POST \
  --url https://platform.uat.proveapis.com/v3/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "correlationId": "713189b8-5555-4b08-83ba-75d08780aebd"
}'
{
  "next": {
    "v3-challenge": "/v3/challenge"
  },
  "phoneNumber": "2001001686",
  "success": true,
  "challengeMissing": true
}

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.

Prove Pre-Fill and Prove Identity are available in the United States and Canada. Verified Users is available in additional countries.

Use the following base URLs when integrating Prove Pre-Fill or Prove Identity:

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

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
correlationId
string
required

Correlation ID is the unique ID that Prove generates for the flow. It is returned from the Start endpoint and cannot be reused outside of a single flow.

Example:

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

Response

200
application/json
Successful request.
​
challengeMissing
boolean
required

Challenge missing returns true if a DOB or SSN needs to be passed in on the next step.

Example:

true

​
next
object
required

Next contains the next set of allowed calls in the same flow.

Example:
{ "v3-challenge": "/v3/challenge" }
​
success
boolean
required

Success returns true if the phone number was validated.

Example:

true

​
phoneNumber
string

PhoneNumber is the number of the mobile phone for which validation was performed.

Example:

"2001001686"