API Reference
Search…
Multi-Bureau Check

Run a multi-bureau check

To run a Multi-Bureau Check, you must create a check with type set to multi_bureau_check.
This check can only be performed on a client of type person. Furthermore, the provided address must contain all required attributes in line with our verifiable client attributes table.
This service includes a 2+2 check variant that applies a more exhaustive and stringent matching engine. Get in touch with your Account Manager or contact us to enable it.

Multi-bureau check request

Attribute
Type
Description
clientId
string
The ID of the client associated with this check. (Required)
type
string
This must be set to multi_bureau_check. (Required)
addressId
string
The ID of the address. (Required)

Example request

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":"CLIENT_ID",
6
"addressId":"ADDRESS_ID",
7
"type": "multi_bureau_check"
8
}'
Copied!
1
const check = await complycube.check.create("CLIENT_ID", {
2
addressId: "ADDRESS_ID",
3
type: "multi_bureau_check"
4
});
Copied!
1
check = cc_api.check.create('CLIENT_ID',
2
'multi_bureau_check',
3
addressId='ADDRESS_ID')
Copied!
1
$result = $ccapi->checks()->create('CLIENT_ID',
2
['type' => 'multi_bureau_check',
3
'addressId' => 'ADDRESS_ID']);
Copied!
1
var checkRequest = new CheckRequest
2
{
3
clientId = "CLIENT_ID",
4
addressId = "ADDRESS_ID",
5
type = "multi_bureau_check"
6
};
7
8
var check = await checkApi.CreateAsync(checkRequest);
Copied!

Result object

The result object is only returned when the status of the check is complete . It has two components - outcome and breakdown.

Outcome

The outcome attribute represents the overall check result. Returned values include:
  1. 1.
    clear: Indicates sufficient client attributes are successfully matched against bureaus, and hence the client's identity is verified.
  2. 2.
    attention: Indicates that at least one of the client attributes is only partially matched, or none were matched at all, requiring attention.

Breakdown

The breakdown comprises the following objects, which correspond to client attributes that are matched:
  • name: Result and breakdown of whether the client's name has been matched.
  • dob: Result and breakdown of whether the client's DOB has been matched.
  • address: Result and breakdown of whether the client's address has been matched.
  • idNumber: Result and breakdown of whether the client's ID number has been matched. An ID number may to an SSN, Social Insurance Number, National Identity Number, or Tax Number.
Each of the aforementioned objects will constitute the following:
  • outcome: For a given attribute, indicates whether a match was found with any of the bureaus. An outcome will have one of the following values:
    • clear: Indicates an attribute fully matched with data held by bureaus.
    • attention: Indicates an attribute partially matched with data held by bureaus.
    • not_processed: Indicates an attribute was not found by bureaus.
  • breakdown: An array of objects detailing the match source. The object has the following attributes:
    • status: Indicates whether a source or bureau has matched a client attribute.
      • clear: Indicates the source has fully matched the data attribute.
      • attention: Indicates the source has partially matched the data attribute.
    • source: The source or bureau type that has matched the attribute. Values include:
      • government_authority
      • commercial_database
      • consumer_database
      • utility_authority
      • proprietary_database
      • telecom_agency
      • postal_authority
      • other_source
  • country: The country of the source or bureau that has matched the attribute. This will be the two-letter country ISO code.
  • hits: The number of times an attribute has been fully or partially matched by sources of a given type.

Sample Response

1
{
2
"id": "614cfa9460fe4700098f3af1",
3
"entityName": "John Doe",
4
"type": "multi_bureau_check",
5
"clientId": "5e94b75d01bce00008c86f02",
6
"addressId": "6149f415cb31190008991522",
7
"status": "complete",
8
"result": {
9
"outcome": "attention",
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": "attention",
58
"breakdown": [
59
{
60
"status": "attention",
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-04-04T17:25:21.116Z",
73
"updatedAt": "2021-04-04T17:25:26.116Z"
74
}
Copied!