Perform Multi-Bureau Check
Overview of flow

1. Create a client
The first step in creating any check is to create a client from your backend server. For this type of check, a client of type person must be created.
Example request for creating a client
curl -X POST https://api.complycube.com/v1/clients \
-H 'Authorization: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"type": "person",
"email": "[email protected]",
"personDetails": {
"firstName": "John",
"lastName": "Doe",
"dob": "1990-01-01",
"ssn": "123-45-6789"
}
}'
Example response
The response will contain an id
(the Client ID). It is required for the next step.
{
"id": "5eb04fcd0f3e360008035eb1",
"type": "person",
"email": "[email protected]",
"personDetails": {
"firstName": "John",
"lastName": "Doe",
"dob": "1990-01-01",
"ssn": "123-45-6789"
},
"createdAt": "2021-01-04T17:24:29.146Z",
"updatedAt": "2021-01-04T17:24:29.146Z"
}
2. Create an address
Create an address by providing the Client ID and address details.
Example request for creating an address
curl -X POST https://api.complycube.com/v1/addresses \
-H 'Authorization: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"clientId":"5eb04fcd0f3e360008035eb1",
"line": "47th Test Avenue 323",
"city": "Manhattan",
"postalCode": "10001",
"state": "NY",
"country": "US"
}'
Example response
The response will contain an id
(the Address ID). It is required for the next step.
{
"id": "5ebd40714f23960008c81528",
"clientId":"5eb04fcd0f3e360008035eb1",
"line": "47th Test Avenue 323",
"city": "Manhattan",
"postalCode": "10001",
"state": "NY",
"country": "US",
"createdAt": "2021-01-04T17:25:21.116Z",
"updatedAt": "2021-01-04T17:25:21.116Z"
}
3. Create a check
Create a check by providing the Client ID, Address ID and check type.
Example request for creating a check
curl -X POST https://api.complycube.com/v1/checks \
-H 'Authorization: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"clientId":"5eb04fcd0f3e360008035eb1",
"addressId":"5ebd40714f23960008c81528",
"type": "multi_bureau_check"
}'
Example response
The response will contain an id
(the Check ID). It is required for the next step.
{
"id": "65c12a6426d2ab000814037e",
"entityName": "John Doe",
"type": "multi_bureau_check",
"clientId": "5eb04fcd0f3e360008035eb1",
"addressId": "5ebd40714f23960008c81528",
"status": "pending",
"createdAt": "2021-01-04T17:25:21.116Z",
"updatedAt": "2021-01-04T17:25:21.116Z"
}
4. Retrieve outcome
ComplyCube will perform the check. You can retrieve a check's outcome and breakdown via the API.
If you have set up webhooks, a notification is sent upon completion of the check.
Example request for retrieving the check outcome
curl -X GET https://api.complycube.com/v1/checks/5ebd40714f23960008c81527 \
-H 'Authorization: <YOUR_API_KEY>'
Example response
{
"id": "65c12a6426d2ab000814037e",
"entityName": "John Doe",
"type": "multi_bureau_check",
"clientId": "5eb04fcd0f3e360008035eb1",
"addressId": "5ebd40714f23960008c81528",
"status": "complete",
"result": {
"outcome": "clear",
"breakdown": {
"name": {
"outcome": "clear",
"breakdown": [
{
"status": "clear",
"source": "commercial_database",
"country": "US",
"hits": 1
},
{
"status": "clear",
"source": "government_authority",
"country": "US",
"hits": 1
}
]
},
"address": {
"outcome": "clear",
"breakdown": [
{
"status": "clear",
"source": "government_authority",
"country": "US",
"hits": 1
}
]
},
"dob": {
"outcome": "clear",
"breakdown": [
{
"status": "clear",
"source": "commercial_database",
"country": "US",
"hits": 1
},
{
"status": "clear",
"source": "government_authority",
"country": "US",
"hits": 1
}
]
},
"idNumber": {
"outcome": "clear",
"breakdown": [
{
"status": "clear",
"source": "commercial_database",
"country": "US",
"hits": 1
}
]
},
"additionalChecks": {
"outcome": "not_processed"
}
}
},
"createdAt": "2021-01-04T17:25:21.116Z",
"updatedAt": "2021-01-04T17:25:21.116Z"
}
Last updated
Was this helpful?