API Reference
Log inSign up
v1.7.3
v1.7.3
  • ComplyCube API Reference
  • Integration
  • Test and Live
  • Authentication
  • Rate Limits
  • Service Quota
  • Errors
  • Pagination
  • Filtering
  • Versioning
  • Core resources
    • Clients
      • Create a client
      • Get a client
      • Update a client
      • Delete a client
      • List clients
      • Filtering clients
    • Addresses
      • Create an address
      • Get an address
      • Update an address
      • Delete an address
      • List addresses
      • Filtering addresses
    • Documents
      • Create a document
      • Get a document
      • Update a document
      • Upload image attachment
      • Delete image attachment
      • Download image attachment
      • Redact image attachment
      • Delete a document
      • List documents
      • Filtering documents
    • Live Photos
      • Upload a live photo
      • Get a live photo
      • Download live photo
      • Redact live photo
      • Delete a live photo
      • List live photos
    • Live Videos
      • Get a live video
      • Redact live video
      • Delete live video
      • List live videos
    • Checks
      • Create a check
      • Get a check
      • Update a check
      • Validate check outcome
      • Redact check outcome
      • List checks
      • Filtering checks
    • Risk Profile
      • Get a risk profile
  • Check types
    • AML Screening Check
    • Document Check
    • Identity Check
    • Enhanced Identity Check
    • Proof of Address Check
    • Multi-Bureau Check
    • Face Authentication Check
    • Age Estimation Check
  • Lookups
    • Company Search
      • Search company
      • Get company details
    • Address Search
      • Search address
  • Tools
    • Custom Lists
      • Get a custom list
      • Add entity to custom list
      • List custom lists
  • Static Data
    • Screening Lists
    • Supported Documents
  • Other Resources
    • Flow (Hosted Solution)
      • Create a session
    • Webhooks
      • Create a webhook
      • Get a webhook
      • Update a webhook
      • Delete a webhook
      • List webhooks
      • Filtering webhooks
    • SDK Tokens
      • Generate a token
    • Autofill
      • Perform autofill
    • Reports
      • Generate a client report
      • Generate a check report
    • Team Members
      • Get a team member
      • List team members
      • Filtering team members
    • Audit Logs
      • Get an audit log
      • List audit logs
      • Filtering audit logs
    • Account Info
      • Get account info
  • Useful Resources
    • Testing Data
    • User Docs
Powered by GitBook
On this page
  • Run a multi-bureau check
  • Check request
  • The options object
  • Example requests
  • Result object
  • Outcome
  • Breakdown
  • Sample Response

Was this helpful?

  1. Check types

Multi-Bureau Check

PreviousProof of Address CheckNextFace Authentication Check

Last updated 7 months ago

Was this helpful?

Run a multi-bureau check

To run a Multi-Bureau Check, you must with type set to multi_bureau_check.

This check can only be performed on a of type person. Furthermore, the provided address must contain all required attributes in line with our

.

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 to enable it.

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)

options

object

The options object

Attribute
Type
Description

twoPlusTwo

boolean

This will verify at least two identity attributes with two or more separate bureaus. When this attribute is not provided, it will default to false.

Example requests

Simple request

curl -X POST https://api.complycube.com/v1/checks \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          "clientId":"CLIENT_ID",
          "addressId":"ADDRESS_ID",
          "type": "multi_bureau_check"
        }'
const check = await complycube.check.create("CLIENT_ID", {
        addressId: "ADDRESS_ID",
        type: "multi_bureau_check"
});
check = cc_api.check.create(
    'CLIENT_ID', 
    'multi_bureau_check', 
    addressId='ADDRESS_ID'
)
$result = $ccapi->checks()->create('CLIENT_ID',
                                   ['type' => 'multi_bureau_check',
                                   'addressId' => 'ADDRESS_ID']);
var checkRequest = new CheckRequest {
  clientId = "CLIENT_ID",
  addressId = "ADDRESS_ID",
  type = "multi_bureau_check"
};

var check = await checkApi.CreateAsync(checkRequest);

Request with optional attributes

curl -X POST https://api.complycube.com/v1/checks \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          "clientId":"CLIENT_ID",
          "addressId":"ADDRESS_ID",
          "type": "multi_bureau_check",
          "options": {
                    "twoPlusTwo": true
          }
        }'
const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const check = await complycube.check.create("CLIENT_ID", {
    type: "multi_bureau_check",
    addressId: "ADDRESS_ID",
    options: {
        twoPlusTwo: true
    }
});
from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

request = {
    'addressId': 'ADDRESS_ID',
    'options': {
        'twoPlusTwo': True
    }
}

check = cc_api.checks.create('CLIENT_ID', 'multi_bureau_check', **request)
use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');
$check = [
    'type' => 'multi_bureau_check',
    'addressId' => 'ADDRESS_ID',
    'options' => [
        'twoPlusTwo' => true
    ]
];

$result = $ccapi->checks()->create('CLIENT_ID', $check);
using ComplyCube.Net;
using ComplyCube.Net.Resources.Checks;

var checkApi = new CheckApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var checkRequest = new CheckRequest {
  clientId = "CLIENT_ID",
  type = "multi_bureau_check",
  addressId = "ADDRESS_ID"
};

checkRequest.options = new CheckRequestOptions {
  twoPlusTwo = true
};

var check = await checkApi.CreateAsync(checkRequest);

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. clear: Indicates sufficient client attributes are successfully matched against bureaus, and hence the client's identity is verified.

  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.

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:

      • credit_agency

      • government_authority

      • commercial_database

      • consumer_database

      • utility_authority

      • proprietary_database

      • telecom_agency

      • postal_authority

      • other_source

  • hits: The number of times an attribute has been fully or partially matched by sources of a given type.

Sample Response

{
   "id": "614cfa9460fe4700098f3af1",
   "entityName": "John Doe",
   "type": "multi_bureau_check",
   "clientId": "5e94b75d01bce00008c86f02",
   "addressId": "6149f415cb31190008991522",
   "status": "complete",
   "result": {
      "outcome": "attention",
      "breakdown": {
         "name": {
            "outcome": "clear",
            "breakdown": [
               {
                  "status": "clear",
                  "source": "credit_agency",
                  "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": "credit_agency",
                  "country": "US",
                  "hits": 1
               }
            ]
         },
         "idNumber": {
            "outcome": "attention",
            "breakdown": [
               {
                  "status": "attention",
                  "source": "government_authority",
                  "country": "US",
                  "hits": 1
               }
            ]
         },
         "additionalChecks": {
            "outcome": "not_processed"
         }
      }
   },
   "createdAt": "2021-04-04T17:25:21.116Z",
   "updatedAt": "2021-04-04T17:25:26.116Z"
}

The optional settings for the check. Also, see the object below. (Optional)

idNumber: Result and breakdown of whether the client's ID number has been matched. An ID number may to an .

country: The country of the source or bureau that has matched the attribute. This will be the .

create a check
client
verifiable client attributes table.
Learn more about Multi-Bureau Checks
contact us
SSN, Social Insurance Number, National Identity Number, or Tax Number
two-letter country ISO code
options