Understanding CheckSummary Results

Suggest Edits

🚧

Note

The individual checkTypes are being phased out.

Unless there is a specific reason to not do so, please move to using Entity Profiles, rather than running individual checks..

The following section details how to interpret the results of a /verify check on an entity.


Whenever a check is performed upon an entity, a summary record is returned as part of the response data. This is found in the checkSummary object and represents the sum total of information about this entity and all previous relevant checks.


🚧

If you’re just after the results of the latest check, look for the most recent summary record in the checkSummaries list.


As part of the primary summary object, there is an array of typed Key-Value Pairs called CheckResults.

In there, we will return any specific flags or data that we think might be useful for the developer to take immediate action on, rather than having to dig through the individual results.

The kvpKey is generally made up of 2 parts: <Level>.<Flag>

<Level> is designed to indicate the level of importance of the flag. Valid values are:

  • Info - Flag is purely informational.
  • Issue - Flag is highlighting something that is a potential issue.
  • Important - Flag is indicating something we feel is Important and requires potential intervention.
  • Action - Flag indicates a recommended action.
  • Fail.Reason - Why the entity is currently in a failed state.
  • Review.Reason - Why the entity is currently marked as REFER.

<Flag> is the name of the flag and is generally self-explanatory (see notes below).

The kvpType is one of the enumerated KVP types found in our OpenAPI specification. We’ve translated that to a more readable form here.

kvpKey

kvpType

kvpValues

Notes

Recommended Disposition

Action.Recommended

String

One of:

PASS

PASS_MANUAL

REFER

FAIL

FAIL_MANUAL

UNCHECKED

Recommended action to take, based on risk, confidence, and all other data.

The _MANUAL suffix on pass/fail indicate that manual intervention was required to make the entity pass/fail.

UNCHECKED means that no checks have been attempted against this entity as yet.

Failure / Refer Reason Indicators

Fail.Reason.*

String

The * can include:

Risk

NoMatch

Duplicate

Blacklist

Partial

Sanction

PEP

Fraud

FraudList

Device

The * in the kvpKey will give a single word indicator of the primary failure reason.

The kvpValue will give a short note on why.

Review.Reason.*

 

The * can include:

PEP

Media

Risk

Fraud

Device



The * in the kvpKey will give a single word indicator of the primary referral reason.

The kvpValue will give a short note on why.

Info.ManualChanges

Integer

1+

If there have been manual interventions on this account, indicate how many

portal.issue.summary

String

Comma separated list of issues

Issue codes are:

404: No match

500: Service error

PTL: Partial match only

PEP: PEP match

S: Sanctions match

WL: AML Watchlist match

M: Adverse Media match

FRAUD: Fraud list or check match

DUP: Duplicate

BL: Blacklist

ATT: No IDV data 

ATT-IDV: ID Validation failed

ATT-PHT: Photo comparison failed

ATT-OCR: OCR scanned document was modified

FRAUD: Fraud list match

DEVICE: There was a device-fraud related issue

Biometrics Related Notes

Fail.Reason.AttestationFailed.*

String

The kvpValue will give a short note on why it failed

When any of the Biometrics reports get rejected/ failed, you will get this KVP in the response which gives you the reasons. The * can include:

MissingDocs: Missing documents

PHT: Photo Comparison

OCR: OCR Comparison

FACE: Facial Duplicate

IDV: ID Validation



Important.AttestationFailed.*

String

true

When any of the Biometrics reports get rejected/ failed, you will get this KVP in the response which tells you there's an important issue. The * can include:

MissingDocs: Missing documents

PHT: Photo Comparison

OCR: OCR Comparison

FACE: Facial Duplicate

IDV: ID Validation



Review.Reason.Attestation

String

The kvpValue will give a short reason on why it needs review

When actioned recommended is "REFER", and there's a potential issue about any of the Biometrics reports, you will get this KVP in the response so that you can review.

Info.AttestationMessage

String

The kvpValue will give some info on the potential warnings and issues

When none of the Biometrics reports are rejected, but there's a warning or suspicious, you will get this KVP in the response.

PEP/Sanctions Related Notes

Issue.HasAdverseMedia

Boolean

True/false

Adverse media was picked up during the check. Only included if true

Issue.IsPEP

Boolean

True/False

Entity appears on at least one PEP list

Only included if true

Important.HasSanctions

Boolean

True/false

Entity appears on at least one sanctions list

Only included if true

Issue.OnWatchlist

Boolean

True/false

Entity appears on at least one watchlist

Only included if true

Confidence Score Related Notes

Important.VERY_LOW_CONFIDENCE

Boolean

True/false

The confidence score is considered to be very low

Only included if true

Issue.LOW_CONFIDENCE

Boolean

True/false

Confidence levels in the result are considered low

Only included if true

Matching Statistics

Info.MissingChecks

String

Comma separated list of checkTypes that have not yet completed.

This will indicate which of the checks you requested have not completed successfully.

Inclusion of “two_plus” or “one_plus” indicates that name/DoB/address checks have not passed.

“id” indicates that no ID checks have passed. “pep” or “pep_media” indicate that you requested AML check has not been run.

Info.NameMatchCount

Integer

0 or more

The number of times we matched the name provided

Info.AddressMatchCount

Integer

0 or more

The number of times we matched the address provided

Info.DoBMatchCount

Integer

0 or more

The number of times we matched the date of birth provided

Info.GovIDMatchCount

Integer

0 or more

The number of supplied documents we succeeded in verifying

Info.OtherIDMatchCount

Integer

0 or more

If Other IDs were matched (e.g. email, mobile, etc) then that count appears here.

Info.ManualMatchCount

Integer

1 or more

Only included if Manual KYC process used. Provides the number of documents used to pass KYC

Info.ManualKYCMessage

string

Manual KYC details

Lists the matching documents used to pass a manually verified KYC check

Important.Blacklisted

Boolean

True/false

Indicates if the entity in question was found on the internal Blacklist.

Only included if true

Important.Whitelisted

Boolean

True/false

Indicates if the entity in question was found on the internal Whitelist. 

Only included if true

Important.Duplicate

Boolean

True/False

Indicates if the entity in question is potentially a duplicate.

Important.CreditBureauMatch.XXX

Boolean

True/False

Indicates a match/fail with a credit header source that may require notification be sent to the customer.


If set to true, the match was successful


If set to false, the match failed and the customer may need to be notified of this fact.


The XXX would be replaced with the reporting bureau. Valid values are:

  • Equifax
  • Experian

It is possible for there to be more than one of these, depending on how your failover/cascade works.

Risk Score Related Notes

Risk.Level

String

One of:
LOW

MEDIUM

HIGH

UNACCEPTABLE

Gives the risk rating for the entity at this time

Risk.Policy

String

Customer specific, but defaults nclude

SDD

EDD

Fail

The configured risk checking policy that was applied

Important.VERY_HIGH_RISK

Boolean

True/false

Risk score is considered very high (over 75)

Only included if true

Issue.HIGH_RISK

Boolean

True/false

Risk score is considered High (over 50)

Only included if true

Issue.MEDIUM_RISK

Boolean

True/false

Risk Score is considered Medium (over 30)

Only included if true

Example check summaries

Biometrics

  1. Biometrics overall FAIL, with OCR and Document report as suspected, but photo comparison rejected:
"checkSummary": {
        "checkDate": "2022-11-28T06:24:18.488Z",
        "checkId": "d606d55f-87cf-ccb8-4bcd-ecd757aacd5d",
        "checkPerformedBy": "various",
        "checkSource": "various",
        "checkType": "visa,id,two_plus,idvalidate",
        "confidenceLevel": 80,
        "providerCheckID": "2b482608-c58b-8eb3-0d40-6442e9e0835c",
        "resultNotes": [
            {
                "kvpKey": "Info.visa",
                "kvpType": "general.string",
                "kvpValue": "No eligible visa document found, skipped visa check"
            },
            {
                "kvpKey": "Action.Recommended",
                "kvpType": "general.string",
                "kvpValue": "FAIL"
            },
            {
                "kvpKey": "Fail.Reason.AttestationFailed.PHT",
                "kvpType": "general.string",
                "kvpValue": "The Photo Comparison result was set as 'REJECTED'"
            },
            {
                "kvpKey": "Important.AttestationFailed.PHT",
                "kvpType": "general.string",
                "kvpValue": "true"
            },
            {
                "kvpKey": "Info.NameMatchCount",
                "kvpType": "general.integer",
                "kvpValue": "2"
            },
            {
                "kvpKey": "Info.AddressMatchCount",
                "kvpType": "general.integer",
                "kvpValue": "0"
            },
            {
                "kvpKey": "Info.DoBMatchCount",
                "kvpType": "general.integer",
                "kvpValue": "2"
            },
            {
                "kvpKey": "Info.GovIDMatchCount",
                "kvpType": "general.integer",
                "kvpValue": "2"
            },
            {
                "kvpKey": "Info.OtherIDMatchCount",
                "kvpType": "general.integer",
                "kvpValue": "0"
            },
            {
                "kvpKey": "Important.VERY_HIGH_RISK",
                "kvpType": "general.bool",
                "kvpValue": "true"
            },
            {
                "kvpKey": "profile_status.risk",
                "kvpType": "general.string",
                "kvpValue": "FAIL"
            },
            {
                "kvpKey": "Risk.Level",
                "kvpType": "general.string",
                "kvpValue": "UNACCEPTABLE"
            },
            {
                "kvpKey": "Risk.Bracket",
                "kvpType": "general.integer",
                "kvpValue": "4"
            },
            {
                "kvpKey": "Confidence.Level",
                "kvpType": "general.string",
                "kvpValue": "HIGH"
            },
            {
                "kvpKey": "portal.issue.summary",
                "kvpType": "general.string",
                "kvpValue": "ATT-PHT,RISK"
            },
            {
                "kvpKey": "Risk.ResultID",
                "kvpType": "result.id",
                "kvpValue": "d8af3dcd-d400-4095-9cba-04cbb6493eea"
            }
        ],
        "resultState": "CHECKED_FAILED",
        "riskLevel": 100
},
  1. Biometrics overall FAIL, with all the reports as suspected:
"checkSummary": {
        "checkDate": "2022-11-29T06:47:14.297Z",
        "checkId": "d606d55f-87cf-ccb8-4bcd-ecd757aacd5d",
        "checkPerformedBy": "various",
        "checkSource": "various",
        "checkType": "visa,id,two_plus,idvalidate",
        "confidenceLevel": 82,
        "providerCheckID": "2b482608-c58b-8eb3-0d40-6442e9e0835c",
        "resultNotes": [
            {
                "kvpKey": "Info.visa",
                "kvpType": "general.string",
                "kvpValue": "No eligible visa document found, skipped visa check"
            },
            {
                "kvpKey": "profile_status.main",
                "kvpType": "general.string",
                "kvpValue": "REFER"
            },
            {
                "kvpKey": "Action.Recommended",
                "kvpType": "general.string",
                "kvpValue": "FAIL"
            },
            {
                "kvpKey": "Info.AttestationMessage",
                "kvpType": "general.string",
                "kvpValue": "Attestation check with DRIVERS_LICENCE (AUS) completed with warnings. The ID Validation result was set as 'SUSPECTED'. The Photo Comparison result was set as 'SUSPECTED'"
            },
            {
                "kvpKey": "Info.NameMatchCount",
                "kvpType": "general.integer",
                "kvpValue": "2"
            },
            {
                "kvpKey": "Info.AddressMatchCount",
                "kvpType": "general.integer",
                "kvpValue": "0"
            },
            {
                "kvpKey": "Info.DoBMatchCount",
                "kvpType": "general.integer",
                "kvpValue": "2"
            },
            {
                "kvpKey": "Info.GovIDMatchCount",
                "kvpType": "general.integer",
                "kvpValue": "2"
            },
            {
                "kvpKey": "Info.OtherIDMatchCount",
                "kvpType": "general.integer",
                "kvpValue": "0"
            },
            {
                "kvpKey": "Important.VERY_HIGH_RISK",
                "kvpType": "general.bool",
                "kvpValue": "true"
            },
            {
                "kvpKey": "profile_status.risk",
                "kvpType": "general.string",
                "kvpValue": "FAIL"
            },
            {
                "kvpKey": "Fail.Reason.Risk",
                "kvpType": "general.string",
                "kvpValue": "UNACCEPTABLE"
            },
            {
                "kvpKey": "Risk.Level",
                "kvpType": "general.string",
                "kvpValue": "UNACCEPTABLE"
            },
            {
                "kvpKey": "Risk.Bracket",
                "kvpType": "general.integer",
                "kvpValue": "4"
            },
            {
                "kvpKey": "Confidence.Level",
                "kvpType": "general.string",
                "kvpValue": "HIGH"
            },
            {
                "kvpKey": "portal.issue.summary",
                "kvpType": "general.string",
                "kvpValue": "ATT-IDV,ATT-OCR,ATT-PHT,RISK"
            },
            {
                "kvpKey": "Risk.ResultID",
                "kvpType": "result.id",
                "kvpValue": "d8af3dcd-d400-4095-9cba-04cbb6493eea"
            }
        ],
        "resultState": "CHECKED_FAILED",
        "riskLevel": 100
},
  1. Biometrics overall REFER, with OCR report as suspected, but Document report and Photo comparison as clear:
"checkSummary": {
        "checkDate": "2022-11-29T06:47:14.297Z",
        "checkId": "d606d55f-87cf-ccb8-4bcd-ecd757aacd5d",
        "checkPerformedBy": "various",
        "checkSource": "various",
        "checkType": "visa,id,two_plus,idvalidate",
        "confidenceLevel": 82,
        "providerCheckID": "2b482608-c58b-8eb3-0d40-6442e9e0835c",
        "resultNotes": [
            {
                "kvpKey": "Action.Recommended",
                "kvpType": "general.string",
                "kvpValue": "REFER"
            },
            {
                "kvpKey": "Review.Reason.Attestation",
                "kvpType": "general.string",
                "kvpValue": "SUSPECTED"
            },
            {
                "kvpKey": "Info.AttestationMessage",
                "kvpType": "general.string",
                "kvpValue": "Attestation check with DRIVERS_LICENCE (AUS) completed with warnings. The ID Validation result was set as 'CLEAR'. The Photo Comparison result was set as 'CLEAR'"
            },
            {
                "kvpKey": "Info.NameMatchCount",
                "kvpType": "general.integer",
                "kvpValue": "2"
            },
            {
                "kvpKey": "Info.AddressMatchCount",
                "kvpType": "general.integer",
                "kvpValue": "0"
            },
            {
                "kvpKey": "Info.DoBMatchCount",
                "kvpType": "general.integer",
                "kvpValue": "2"
            },
            {
                "kvpKey": "Info.GovIDMatchCount",
                "kvpType": "general.integer",
                "kvpValue": "0"
            },
            {
                "kvpKey": "Info.OtherIDMatchCount",
                "kvpType": "general.integer",
                "kvpValue": "0"
            },
            {
                "kvpKey": "Risk.Level",
                "kvpType": "general.string",
                "kvpValue": "LOW"
            },
            {
                "kvpKey": "Risk.Bracket",
                "kvpType": "general.integer",
                "kvpValue": "1"
            },
            {
                "kvpKey": "Confidence.Level",
                "kvpType": "general.string",
                "kvpValue": "HIGH"
            },
            {
                "kvpKey": "portal.issue.summary",
                "kvpType": "general.string",
                "kvpValue": "ATT-OCR"
            },
            {
                "kvpKey": "Risk.ResultID",
                "kvpType": "result.id",
                "kvpValue": "c61e4c54-e6c9-765a-9752-e73d7001788d"
            }
        ],
        "resultState": "CHECKED_FAILED",
        "riskLevel": 100
},

Updated 4 months ago