Prove Pre-Fill and Identity API Reference

Complete flow

Send this request to verify the user and complete the flow. It will return a correlation ID, user information, and the next step to call in the flow. There is a validation check that requires at least first + last name or SSN passed in, else an HTTP 400 is returned. Additionally, specific to the Pre-Fill® or Prove Identity® with KYC use case, you need to pass in first name, last name, DOB and SSN (or address) to ensure you receive back the KYC elements and correct CIP values.

POST

complete

curl --request POST \
  --url https://api.uat.proveapis.com/v3/complete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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"
  },
  "correlationId": "713189b8-5555-4b08-83ba-75d08780aebd"
}'

{
  "next": {
    "done": null
  },
  "success": true,
  "changeDetected": false
}

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.

individual

object

required

Response

200

application/json

Successful request.

changeDetected

boolean

required

ChangeDetected returns true if the individual information changed.

object

required

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

success

boolean

required

Success returns true if the individual was verified successfully.

Submit challenge.Initiate verified users session.

curl --request POST \
  --url https://api.uat.proveapis.com/v3/complete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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"
  },
  "correlationId": "713189b8-5555-4b08-83ba-75d08780aebd"
}'

{
  "next": {
    "done": null
  },
  "success": true,
  "changeDetected": false
}

Prove APIs

Authorizations

Body

Response