POST
/
v3
/
complete
curl --request POST \
  --url https://platform.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": "1981-01",
    "ssn": "265228370"
  },
  "correlationId": "713189b8-5555-4b08-83ba-75d08780aebd"
}'
{
  "success": true,
  "next": {
    "done": "done"
  }
}

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"

​
individual
object
required
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-17",
  "ssn": "265228370"
}

Response

200
application/json
Successful request.
​
next
object
required

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

Example:
{ "done": "done" }
​
success
boolean
required

Success returns true if the individual was verified successfully.

Example:

true

​
idv
object
Example:
{
  "multiCIPConfidence": "multiCIPConfidence",
  "dataSource2": {
    "cipConfidence": "cipConfidence",
    "reasonCodes": ["reasonCodes", "reasonCodes"],
    "address": {
      "distance": 6.027456183070403,
      "city": true,
      "streetNumber": 1,
      "street": true,
      "postalCode": true,
      "region": true,
      "addressScore": 0
    },
    "identifiers": { "last4": true, "dob": true, "ssn": true },
    "name": {
      "firstName": 5,
      "lastName": 5,
      "nameScore": 2
    },
    "email": { "emailAddress": true }
  },
  "dataSource1": {
    "cipConfidence": "cipConfidence",
    "reasonCodes": ["reasonCodes", "reasonCodes"],
    "address": {
      "distance": 6.027456183070403,
      "city": true,
      "streetNumber": 1,
      "street": true,
      "postalCode": true,
      "region": true,
      "addressScore": 0
    },
    "identifiers": { "last4": true, "dob": true, "ssn": true },
    "name": {
      "firstName": 5,
      "lastName": 5,
      "nameScore": 2
    },
    "email": { "emailAddress": true }
  }
}
​
kyc
object
Example:
{
  "totalHits": 9,
  "amlTypeLists": [
    {
      "listHits": 7,
      "amlType": "amlType",
      "fields": [
        {
          "name": "name",
          "source": "source",
          "value": "value"
        },
        {
          "name": "name",
          "source": "source",
          "value": "value"
        }
      ]
    },
    {
      "listHits": 7,
      "amlType": "amlType",
      "fields": [
        {
          "name": "name",
          "source": "source",
          "value": "value"
        },
        {
          "name": "name",
          "source": "source",
          "value": "value"
        }
      ]
    }
  ]
}