Manual Check Results

Suggest Edits

Whenever an entity is manually passed through KYC, the details of that will be found in the manualCheckResults section.

This is an array of ProcessResultObjects, but will generally only have one entry (unless for some reason the entity has been through the manual KYC process more than once, but this is extremely rare).

Each ProcessResultObject will contain the following values:

Field Name	Description
checkDate	UTC timestamp as to when the entity was manually passed.
checkId	The check Identifier for the manual pass.
checkPerformedBy	Will always be `mkyc`
checkSource	Will always be `manual_kyc`
checkType	Will be the updated full list of checks that are scheduled to be run as part of the modified recipe (or as requested in an ad-hoc query) NOTE: When selecting a manual KYC process, the service will remove such checks as “two_plus” or “id” as the manual_kyc check is designed to replace these.
providerCheckId	Will always be the same as `checkId` above.
resultState	Will be one of: `CHECKED_SUCCESS_CLEAR`: manual check was run and validated without incident. `CHECKED_FAILED`: there was an error running the manual KYC check. Ideally, this will not occur as manual KYC checks are generally run from the portal and it will ensure that all prerequisites are in place.

The following resultNote Key-Value-Pairs will also be set.

Key Name	Description
kyc_document_id.*	The documentID that was used to supply ID that was acceptable as a manual KYC requirement
message	Human readable description of the matching requirements for Manual KYC

Example

"manualCheckResults": [
        {
            "checkDate": "2021-08-16T08:59:00.708Z",
            "checkId": "535a5b76-98c4-3eb7-8c94-0f234e01e76a",
            "checkPerformedBy": "mkyc",
            "checkSource": "manual_kyc",
            "checkType": "visa,namev,manual,pep",
            "providerCheckID": "535a5b76-98c4-3eb7-8c94-0f234e01e76a",
            "resultNotes": [
                {
                    "kvpKey": "message",
                    "kvpType": "general.string",
                    "kvpValue": "Found 1 primary photographic ID (AUS:PASSPORT) which satisfies the ID requirements"
                },
                {
                    "kvpKey": "kyc_document_id.all",
                    "kvpType": "general.string",
                    "kvpValue": "2618e851-c84f-f06c-dde6-67dcf0993cd5"
                },
                {
                    "kvpKey": "kyc_document_id",
                    "kvpType": "general.string",
                    "kvpValue": "2618e851-c84f-f06c-dde6-67dcf0993cd5"
                },
                {
                    "kvpKey": "original_checksource",
                    "kvpType": "general.string",
                    "kvpValue": "manual_kyc"
                }
            ],
            "resultState": "CHECKED_SUCCESS_CLEAR"
        }
    ],

Updated 12 months ago