Prove Pre-Fill and Identity API Reference

Submit challenge.

Send this request to submit challenge information. Either a DOB or last 4 of SSN needs to be submitted if neither was submitted to the /start endpoint (challenge fields submitted to this endpoint will overwrite the /start endpoint fields submitted). It will return a correlation ID, user information, and the next step to call in the flow. This capability is only available in Pre-Fill®, it’s not available in Prove Identity®. You’ll notice that when using Prove Identity®, if /validate is successful, it will then return v3-complete as one of the keys in the Next field map instead of v3-challenge.

POST

challenge

curl --request POST \
  --url https://api.uat.proveapis.com/v3/challenge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "last4SSN": "1234",
  "dob": "2024-05-02T00:00:00.000Z",
  "correlationId": "713189b8-5555-4b08-83ba-75d08780aebd"
}'

{
  "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": "2024-05-02T00:00:00.000Z",
    "ssn": "265228370"
  },
  "success": 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.

dob

string

default:

2024-05-02T00:00:00.000Z

DOB is the date of birth in this format: YYYYY-MM-DD. Acceptable characters are: numeric with symbol '-'.

last4SSN

string

default:

1234

Last4SSN is the last 4 numbers of the social security number. Acceptable characters are: numeric.

Response

200

application/json

Successful request.

individual

object

required

object

required

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

success

boolean

required

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

Validate phone number.Complete flow

curl --request POST \
  --url https://api.uat.proveapis.com/v3/challenge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "last4SSN": "1234",
  "dob": "2024-05-02T00:00:00.000Z",
  "correlationId": "713189b8-5555-4b08-83ba-75d08780aebd"
}'

{
  "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": "2024-05-02T00:00:00.000Z",
    "ssn": "265228370"
  },
  "success": true
}

Prove APIs

Authorizations

Body

Response