Failure Scenarios

Overview

The identity verification process will attempt to exhaust all available options with a user before eventually terminating the verification process. This will happen as early as possible, if there's a strong evidence suggesting that the user will not achieve the relevant identity checking requirements for the requested scheme.

In the event that multiple schemes are requested , the identity verification flow will continue as long as one scheme could still be met.

Failures may include:

• 'Aborted' identity checks: Aborted identity checks are the result of a complete 'dead end' in the journey, meaning an identity profile will not be returned
• Requirements not met: Occurs when an identity profile can be returned, however scheme compliance couldn't be met
  • Requirements not met details: Additional information around the failure, explaining which checks were involved, and why they may have failed

When a journey is incomplete, either entirely (aborted) or due to not reaching scheme compliance (requirements not met), a reason code will be returned to explain the failure.

These tables list the reason codes, a description of why they may occur, and the integration type in which they may be returned.

Since some failures can be triggered for multiple reasons, there is a priority for which overall reason code will be used. Details of all failed checks would be available in the failure details.

Retrieving the Profile

The Identity Profile and any failures returned can be retrieved through the Yoti SDKs

IDVClient.getSession(sessionId)

  .then((session) => {

    const advancedIdentityProfile = session.getAdvancedIdentityProfile();

​

    const result = advancedIdentityProfile.getResult();

​

    const failureReason = advancedIdentityProfile.getFailureReason();

​

    const failureCode = failureReason.getReasonCode();

​

    const requirementsNotMetDetails =

      failureReason.getRequirementsNotMetDetails();

​

    // Check if there are any requirements not met details

    // This may be empty

    // There may be multiple details provided

    if (requirementsNotMetDetails.length === 0) {

      console.log("No requirements not met details found.");

    } else {

      const failureType = requirementsNotMetDetails[0].getFailureType();

​

      const documentType = requirementsNotMetDetails[0].getDocumentType();

​

      const countryCode = requirementsNotMetDetails[0].getDocumentCountryIsoCode();

​

      const auditId = requirementsNotMetDetails[0].getAuditId();

​

      const details = requirementsNotMetDetails[0].getDetails();

    }

  })

  .catch((error) => {

    console.log(error);

  });

Example Failure

"advanced_identity_profile": {

        "result": "ABORTED",

        "failure_reason": {

            "reason_code": "MISSING_LIVENESS",

            "requirements_not_met_details": [

                {

                    "failure_type": "LIVENESS",

                    "details": "USER_FAILED_LIVENESS"

                }

            ]

        }

    }

Requirements not Met

Aborted

Requirements not met details

The requirements not met details structure is a list of objects which contains information to supplement the overall returned reason code. This surfaces information around the specific check, or multiple checks, which may have led to the failure.

The following fields are returned per each object in the structure:

• failure_type
• document_type
• document_country_iso_code
• audit_id
• details

Info Documents where an end user has select that they are unable to provide it, or do not have it, will not appear in the failure details, therefore it is possible to have an aborted session with no failure details (for example mandatory document not provide without any attempt by the user).

ID Check

This table lists the failure details codes that can be returned alongside the failure type of IDENTITY_CHECK.

ID Doc Extraction

This table lists the failure details codes that can be returned alongside the failure type of ID_DOCUMENT_EXTRACTION.