Multi-Bureau Check
Last updated
Was this helpful?
Last updated
Was this helpful?
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
.
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
options
object 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.
The result
object is only returned when the status of the check is complete
. It has two components - outcome
and breakdown
.
The outcome attribute represents the overall check result. Returned values include:
clear
: Indicates sufficient client attributes are successfully matched against bureaus, and hence the client's identity is verified.
attention
: Indicates that at least one of the client attributes is only partially matched, or none were matched at all, requiring attention.
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.
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 .