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"
      }
    ],
    "emailAddresses": [
      "jdoe@example.com"
    ],
    "dob": "1981-01",
    "ssn": "265228370"
  },
  "correlationId": "713189b8-5555-4b08-83ba-75d08780aebd"
}'
{
"success": true,
"next": {
"done": "done"
}
}

Use the following base URLs when integrating:

https://platform.uat.proveapis.com - North America Sandbox Environment

https://platform.proveapis.com - North America Production Environment

When implementing the KYC add-on, you need to pass in first name, last name, DOB, and SSN (or address) to ensure you receive back the KYC and CIP fields.

Authorizations

Authorization
string
header
required

The access token received from the /token endpoint. Refer to the Authentication page for more details.

Body

application/json

Response

200
application/json

Successful request.

The response is of type object.