POST
/
v3
/
validate
curl --request POST \
  --url https://api.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"
  },
  "success": true,
  "challengeMissing": true
}

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

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

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
correlationId
string
default:
713189b8-5555-4b08-83ba-75d08780aebd
required

Correlation ID is the unique ID of the flow. To continue the flow, the field will also be used for each of the subsequent API calls in the same flow.

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.

​
next
object
required

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

​
success
boolean
required

Success returns true if the phone number was validated.

Start flow.Submit challenge.