Guides
Check Types
Useful Resources
Perform Multi-Bureau Check
You can run this check immediately via our Demo Postman collection. It's publicly available and doesn't require an account.
Overview of flow
Multi-Bureau check API 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
Node.js
Python
PHP
.NET
1
curl -X POST https://api.complycube.com/v1/clients \
2
-H 'Authorization: <YOUR_API_KEY>' \
3
-H 'Content-Type: application/json' \
4
-d '{
5
"type": "person",
6
"email": "[email protected]",
7
"personDetails": {
8
"firstName": "John",
9
"lastName": "Doe",
10
"dob": "1990-01-01",
11
"ssn": "123456789"
12
}
13
}'
Copied!
1
const { ComplyCube } = require("@complycube/api");
2
3
const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });
4
5
const client = await complycube.client.create({
6
type: "person",
7
email: "[email protected]",
8
personDetails: {
9
firstName: "John",
10
lastName: "Doe",
11
dob: "1990-01-01",
12
ssn: "123456789"
13
}
14
});
Copied!
1
from complycube import ComplyCubeClient
2
cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')
3
4
new_client = {
5
'type':'person',
6
'email':'[email protected]',
7
'personDetails': {
8
'firstName':'John',
9
'lastName':'Doe',
10
'dob': '1990-01-01',
11
'ssn': '123456789'
12
}
13
}
14
15
client = cc_api.clients.create(**new_client)
Copied!
1
use ComplyCube\ComplyCubeClient;
2
3
$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');
4
5
$result = $ccapi->clients()->create(['type' => 'person',
6
'email' => '[email protected]',
7
'personDetails' => ['firstName' => 'John',
8
'lastName' => 'Doe',
9
'dob' => '1990-01-01',
10
'ssn' => '123456789']]);
Copied!
1
using ComplyCube.Net;
2
using ComplyCube.Net.Resources.Clients;
3
4
var clientApi = new ClientApi(new ComplyCubeClient("<YOUR_API_KEY>"));
5
6
var newClient = new ClientRequest {
7
type = "person",
8
email = "[email protected]",
9
personDetails = new PersonDetails {
10
firstName = "John",
11
lastName = "Doe",
12
dob = "1990-01-01",
13
ssn = "123456789"
14
}
15
}
16
17
var client = await clientApi.CreateAsync(newClient);
Copied!
Example response
The response will contain an
id (the Client ID). It is required for the next step.1
{
2
"id": "5eb04fcd0f3e360008035eb1",
3
"type": "person",
4
"email": "[email protected]",
5
"personDetails": {
6
"firstName": "John",
7
"lastName": "Doe",
8
"dob": "1990-01-01",
9
"ssn": "123456789"
10
},
11
"createdAt": "2021-01-04T17:24:29.146Z",
12
"updatedAt": "2021-01-04T17:24:29.146Z"
13
}
Copied!
2. Create an address
Create an address by providing the Client ID and address details.
Example request for creating an address
cURL
Node.js
Python
PHP
.NET
1
curl -X POST https://api.complycube.com/v1/addresses \
2
-H 'Authorization: <YOUR_API_KEY>' \
3
-H 'Content-Type: application/json' \
4
-d '{
5
"clientId":"5eb04fcd0f3e360008035eb1",
6
"line": "47th Test Avenue 323",
7
"city": "Manhattan",
8
"postalCode": "10001",
9
"state": "NY",
10
"country": "US"
11
}'
Copied!
1
const address = await complycube.address.create("5eb04fcd0f3e360008035eb1", {
2
line: "47th Test Avenue 323",
3
city: "Manhattan",
4
postalCode: "10001",
5
state: "NY",
6
country: "US"
7
});
Copied!
1
new_address = {
2
'line': '47th Test Avenue 323',
3
'city': 'Manhattan',
4
'postalCode': '10001',
5
'state': 'NY',
6
'country': 'US'
7
}
8
9
address = cc_api.addresses.create('5eb04fcd0f3e360008035eb1',**new_address)
Copied!
1
$address = $ccapi->address()->create('5eb04fcd0f3e360008035eb1',
2
['line'=>'47th Test Avenue 323',
3
'city'=>'Manhattan',
4
'postalCode'=>'10001',
5
'state'=>'NY',
6
'country'=>'US']);
Copied!
1
var addressRequest = new AddressRequest
2
{
3
clientId = "5eb04fcd0f3e360008035eb1",
4
line = "47th Test Avenue 323",
5
city = "Manhattan",
6
postalCode = "10001",
7
state = "NY",
8
country = "US"
9
};
10
11
12
var address = await addressApi.CreateAsync(addressRequest);
Copied!
Example response
The response will contain an
id (the Address ID). It is required for the next step.1
{
2
"id": "5ebd40714f23960008c81528",
3
"clientId":"5eb04fcd0f3e360008035eb1",
4
"line": "47th Test Avenue 323",
5
"city": "Manhattan",
6
"postalCode": "10001",
7
"state": "NY",
8
"country": "US",
9
"createdAt": "2021-01-04T17:25:21.116Z",
10
"updatedAt": "2021-01-04T17:25:21.116Z"
11
}
Copied!
3. Create a check
Create a check by providing the Client ID, Address ID and check type.
Example request for creating a check
cURL
Node.js
Python
PHP
.NET
1
curl -X POST https://api.complycube.com/v1/checks \
2
-H 'Authorization: <YOUR_API_KEY>' \
3
-H 'Content-Type: application/json' \
4
-d '{
5
"clientId":"5eb04fcd0f3e360008035eb1",
6
"addressId":"5ebd40714f23960008c81528",
7
"type": "multi_bureau_check"
8
}'
Copied!
1
const check = await complycube.check.create("5eb04fcd0f3e360008035eb1", {
2
addressId: "5ebd40714f23960008c81528",
3
type: "multi_bureau_check"
4
});
Copied!
1
check = cc_api.checks.create( '5eb04fcd0f3e360008035eb1',
2
'multi_bureau_check',
3
addressId='5ebd40714f23960008c81528' )
Copied!
1
$result = $ccapi->checks()->create('5eb04fcd0f3e360008035eb1',
2
['type' => 'multi_bureau_check',
3
'addressId' => '5ebd40714f23960008c81528']);
Copied!
1
var checkRequest = new CheckRequest
2
{
3
clientId = "5eb04fcd0f3e360008035eb1",
4
addressId = "5ebd40714f23960008c81528",
5
type = "multi_bureau_check"
6
};
7
8
var check = await checkApi.CreateAsync(checkRequest);
Copied!
Example response
The response will contain an
id (the Check ID). It is required for the next step.1
{
2
"id": "5ebd40714f23960008c81527",
3
"entityName": "John Doe",
4
"type": "multi_bureau_check",
5
"clientId": "5eb04fcd0f3e360008035eb1",
6
"addressId": "5ebd40714f23960008c81528",
7
"status": "pending",
8
"createdAt": "2021-01-04T17:25:21.116Z",
9
"updatedAt": "2021-01-04T17:25:21.116Z"
10
}
Copied!
Perform check
ComplyCube will perform the check. You can retrieve a check's outcome and breakdown via the API.
Example request for retrieving the check outcome
cURL
Node.js
Python
PHP
.NET
1
curl -X GET https://api.complycube.com/v1/checks/5ebd40714f23960008c81527 \
2
-H 'Authorization: <YOUR_API_KEY>'
Copied!
1
const check = await complycube.check.get("5ebd40714f23960008c81527");
Copied!
1
check = cc_api.checks.get('5ebd40714f23960008c81527')
Copied!
1
$check = $ccapi->checks()->get('5ebd40714f23960008c81527');
Copied!
1
var check = await checkApi.GetAsync("5ebd40714f23960008c81527");
Copied!
Example response
1
{
2
"id": "5ebd40714f23960008c81527",
3
"entityName": "John Doe",
4
"type": "multi_bureau_check",
5
"clientId": "5eb04fcd0f3e360008035eb1",
6
"addressId": "5ebd40714f23960008c81528",
7
"status": "complete",
8
"result": {
9
"outcome": "clear",
10
"breakdown": {
11
"name": {
12
"outcome": "clear",
13
"breakdown": [
14
{
15
"status": "clear",
16
"source": "commercial_database",
17
"country": "US",
18
"hits": 1
19
},
20
{
21
"status": "clear",
22
"source": "government_authority",
23
"country": "US",
24
"hits": 1
25
}
26
]
27
},
28
"address": {
29
"outcome": "clear",
30
"breakdown": [
31
{
32
"status": "clear",
33
"source": "government_authority",
34
"country": "US",
35
"hits": 1
36
}
37
]
38
},
39
"dob": {
40
"outcome": "clear",
41
"breakdown": [
42
{
43
"status": "clear",
44
"source": "commercial_database",
45
"country": "US",
46
"hits": 1
47
},
48
{
49
"status": "clear",
50
"source": "government_authority",
51
"country": "US",
52
"hits": 1
53
}
54
]
55
},
56
"idNumber": {
57
"outcome": "clear",
58
"breakdown": [
59
{
60
"status": "clear",
61
"source": "commercial_database",
62
"country": "US",
63
"hits": 1
64
}
65
]
66
},
67
"additionalChecks": {
68
"outcome": "not_processed"
69
}
70
}
71
},
72
"createdAt": "2021-01-04T17:25:21.116Z",
73
"updatedAt": "2021-01-04T17:25:21.116Z"
74
}
Copied!
Last modified 3mo ago