POST
/
v3
/
challenge
curl --request POST \
  --url https://platform.uat.proveapis.com/v3/challenge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "dob": "1981-01",
  "correlationId": "713189b8-5555-4b08-83ba-75d08780aebd",
  "ssn": "0596"
}'
{
  "next": {
    "v3-complete": "/v3/complete"
  },
  "individual": {
    "firstName": "Tod",
    "lastName": "Weedall",
    "addresses": [
      {
        "address": "39 South Trail",
        "city": "San Antonio",
        "extendedAddress": "Apt 23",
        "postalCode": "78285",
        "region": "TX"
      },
      {
        "address": "4861 Jay Junction",
        "city": "Boston",
        "extendedAddress": "Apt 78",
        "postalCode": "02208",
        "region": "MS"
      }
    ],
    "emailAddresses": [
      "jdoe@example.com",
      "dsmith@example.com"
    ],
    "dob": "1981-01-17",
    "ssn": "265228370"
  },
  "success": 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"

​
dob
string

DOB, an optional challenge, is the date of birth in one of these formats: YYYY-MM-DD, YYYY-MM, or MM-DD. Acceptable characters are: numeric with symbol '-'.

Example:

"1981-01"

​
ssn
string

SSN is either the full or last 4 numbers of the social security number. Acceptable characters are: numeric.

Example:

"0596"

Response

200
application/json
Successful request.
​
next
object
required

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

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

Success returns true if the challenge was accepted and user info retrieved.

Example:

true

​
individual
object
Example:
{
  "firstName": "Tod",
  "lastName": "Weedall",
  "addresses": [
    {
      "address": "39 South Trail",
      "city": "San Antonio",
      "extendedAddress": "Apt 23",
      "postalCode": "78285",
      "region": "TX"
    },
    {
      "address": "4861 Jay Junction",
      "city": "Boston",
      "extendedAddress": "Apt 78",
      "postalCode": "02208",
      "region": "MS"
    }
  ],
  "emailAddresses": ["jdoe@example.com", "dsmith@example.com"],
  "dob": "1981-01-17T00:00:00.000Z",
  "ssn": "265228370"
}