Identity Fraud Check
Run an identity fraud check
To run an Identity Fraud Check, you must create a check with type set to identity_fraud_check.
Learn more about Identity Fraud Checks.
Check request
clientId
string
The ID of the client associated with this check. (Required)
type
string
This must be set to identity_fraud_check. (Required)
addressId
string
The ID of the address. (Required)
Example requests
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": "identity_fraud_check"
}'
const check = await complycube.check.create("CLIENT_ID", {
addressId: "ADDRESS_ID",
type: "identity_fraud_check"
});check = cc_api.check.create(
'CLIENT_ID',
'identity_fraud_check',
addressId='ADDRESS_ID'
)$result = $ccapi->checks()->create('CLIENT_ID',
['type' => 'identity_fraud_check',
'addressId' => 'ADDRESS_ID']);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:
clear: Indicates every analysis type conducted returned a successful result.attention: Indicates at least one of the analysis results requires attention.
Breakdown
The breakdown comprises the following objects:
identityVerification object
identityVerification objectThe identity verification results. It has the following constituents:
name: Indicates whether the client's name matches authoritative sources.dob: Indicates whether the client's date of birth matches authoritative sources.address: Indicates whether the client's address matches authoritative sources.telephone: Indicates whether the client's telephone number matches authoritative sources.mobile: Indicates whether the client's mobile number matches authoritative sources.email: Indicates whether the client's email matches authoritative sources.activity: Indicates whether the client's UK activity/footprint are as expected.breakdown: This is an array that comprises of objects with the following constituents:field: The attribute verified (e.g.dob).source: The source type that has matched the attribute. Values include:credit_agencygovernment_authorityconsumer_databaseutility_authorityproprietary_databasetelecom_agencypostal_authorityother_source
status: A status will have one of the following values:clear: Indicates an attribute fully matched with data held by sources.attention: Indicates an attribute partially matched with data held by sources.
databaseAnalysis object
databaseAnalysis objectThe database analysis results. It has the following constituents:
mortality: Indicates a match against mortality/deceased records.fraud: Indicates a match against fraud databases.fakeProfile: Indicates a match against synthetic or fake identities.police: Indicates a match against police records.breakdown: This is an array that comprises of objects with the following constituents:field: The dataset screened (e.g.police).sourceDescription: The description of the source (e.g. "Amberhill").status: A status will have one of the following values:clear: Indicates no records held by the source.attention: Indicates matching records held by the source.
Sample Response
Last updated
Was this helpful?