Services and Workflows Reference

A Jumio workflow is a business process definition that orchestrates calls to one or more Jumio service(s) or risk signal(s). Each service or risk signal is a step in the workflow. Each step is a sub-flow that orchestrates one or more Jumio capabilities. A capability is a modular service that handles a specific task.

Each workflow specifies the credentials that will be evaluated by the steps.

Jumio provides workflows that meet the requirements of many customers. For example, the Standard Services are each available as standalone workflows. You can also work with your Jumio Soulutions Engineer (SE) to define a custom workflow that integrates any of the Risk Signals to meet your requirements.

Standard Services

The following table lists some standard Jumio services that can be used as standalone workflows or as steps in other workflows.

Service	Standalone Workflow Key	Description	Credentials	Capabilities
ID & Identity Verification	10163	Includes both ID Verification and Identity Verification. Takes a government-issued ID (e.g., passport, driver’s license, or national ID card) and a selfie as credentials. It also requires Uploading Supporting Data. Verifies that the government-issued ID is authentic and valid, the selfie is of a real person, and the person in the selfie is the same person that is pictured on the ID.	ID Selfie Facemap	Usability Extraction Image Checks Data Checks Liveness Similarity
ID Verification	10165	Verifies that a government-issued photo ID (e.g., passport, driver’s license, or national ID card) is authentic and valid. It also requires Uploading Supporting Data.	ID	Usability Extraction Image Checks Data Checks
ID & Identity Verification, plus Watchlist Screening*	10167	All the same functionality as ID & Identity Verification (10163) plus watchlist screening. ID & Identity Verification are performed first. If no fraud is detected then the Watchlist Screening capability is called to screen the user against global and regional sanctions and watchlists, to identify PEPs.	ID Selfie Facemap	Usability Extraction Image Checks Data Checks Liveness Similarity Watchlist Screening
Authentication	10014	Compares a new selfie to an existing face map. For additional information see Authentication Workflow.	Selfie Facemap	Authentication
Document Proof*	10169	Jumio Document Verification enables your customers to quickly scan and upload documents such as utility bills, credit card statements, bank statements, or Social Security cards, even if the documents are crumpled or creased. It also requires Uploading Supporting Data. Relevant data is extracted from the document and may be used with other services or risk signals.	Document	Usability Extraction Image Checks
ID Capture and Storage	10171	Extracts and stores data from a government-issued ID. It also requires Uploading Supporting Data.	ID	Usability Extraction

* Please work with your Jumio Account Manager to ensure you have proper access to this service for this workflow to function as intended.

Identification Document and Identity Verification (IDIV) Workflow

IDIV is a multi-step workflow that:

Evaluates a government-issued identification document (ID) to verify that it is valid.
Evaluates a “selfie” to verify that it is of an actual live person.
Compares the selfie to the picture on the ID to verify that they are the same person.

It is often used for onboarding new users when you are entering into sensitive relationships. By verifying the ID you can determine that the new user is a real, known identity, and that the user is actually the person that the identity describes.

See the following sections for information on:

Account Creation or Update
All Jumio Platform transactions are initiated by an API call to create a new or update an existing account. The response provides the data required to launch the “customer journey” in your selected integration channels.
IDIV Customer Journey
The Jumio web client and mobile SDKs provide the user interfaces that guide your users through the process of taking the required pictures of their ID and the selfie (the credentials required for the IDIV workflow), which are then uploaded to the account. Jumio refers to this process as the “customer journey.” Once the credentials are uploaded the user is redirected back to your app, and the transaction is executed.
IDIV Steps and Capabilities
The workflow execution is a sequence of executedcalls to Jumio services known as capabilities. The workflow key identifies the workflow that comprises the capabilities that best implement your use case. For IDIV, workflow 10011 calls the capabilities required to evaluate the credentials and compare the selfie to the ID picture.
Handling the IDIV Response
IDIV is an asynchronous transaction that usually takes a few minutes to complete. When it is finished you can view the results in the Jumio Portal or retrieve them with an API call.

Account Creation or Update

All Jumio Platform transactions are associated with an account. The account is nothing more than a unique identifier that is used to associate the transactions and credentials for a unique identity. If you are onboarding a new user and this is the first Jumio transaction executed for the user, then you would create a new account.

Note: While IDIV transactions are often executed as the first transaction associated with an account, there are valid scenarios where you would run IDIV on an existing account. An example of that would be if you performed an email verification and/or address verification on the user prior to the IDIV. Simple verifications are often faster and less expensive than a full IDIV transaction, so it may be worthwhile to perform an initial verification to eliminate known bad actors prior to incurring the expense of the IDIV transaction. In this case you would create the account for the initial verification, and then update the account to run the IDIV transaction if the user appears to be legitimate.

Creating or updating an account is always done with a call to the Accounts REST API. For technical details on calling the API see: Creating or Updating Accounts in the Jumio Integration Guide.

Account Response

The response to the request to create or update an account contains the information you need to proceed with the workflow, including:

The URL and authorization token for the Jumio Web Client.
You use this when your end-user is working in a web browser.
The authorization token (JWT) for initializing the Jumio SDK implementation in the mobile apps you have implemented. Your organization implements the SDKs when your end-users use a mobile app.
A list of the credentials that will be uploaded during the customer journey. These include:
The government-issued ID document
The selfie
The Facemap (a facemap is created and uploaded as part of the customer journey when your Jumio integration uses either the Web Client or the mobile SDKs. If your integration uses the raw REST APIs, you cannot upload a facemap).

Sample Account Creation Request and Response

Following are sample request and response bodies, in JSON format, for the account creation API call.

Sample Account Creation Request Body

{
    "customerInternalReference":"myCompany",
    "callbackUrl":"https://portal.mycompany.com/callback",
    "workflowDefinition":{
        "key": 10011
    }

Sample Account Creation Response Body

{
    "timestamp": "2022-11-28T23:45:02.536Z",
    "account": {
        "id": "572ac7b5-9f83-409d-ba8e-f0014e411c7e"
    },
    "web": {
        "href": "https://greenunion.web.amer-1.jumio.ai/web/v4/app?authorizationToken=eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XOMQ7CMAwF0LtkxpKdOk7MxsjKDRInYWkBiUogIe5O2huw_v_09T-uvU-rOzoSUYka0XNSd3DZ7FxHHqLPFksA7WkCRq1QcmrQEYkbE1lsG98xU4-k5IFMCnDzHcrECFWqEVoVLWngV2__cLu0PvTj_lyXfIP1vlzB8jz7rduHvHRGDAmIMQB7GSeFK0zGOan2ZiG57w9fvJLI7AAAAA.0NpDK192_6kMSYfxFuqHPFkhdsKQBqieRvSqt3XAGLWRe7Y8u0aJalMa8TLEY8eA0XEw4TqRapVLDraRHUz4kQ&amp;locale=en-US"
    },
    "sdk": {
        "token": "eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XOMQ7CMAwF0LtkxpKdOk7MxsjKDRInYWkBiUogIe5O2huw_v_09T-uvU-rOzoSUYka0XNSd3DZ7FxHHqLPFksA7WkCRq1QcmrQEYkbE1lsG98xU4-k5IFMCnDzHcrECFWqEVoVLWngV2__cLu0PvTj_lyXfIP1vlzB8jz7rduHvHRGDAmIMQB7GSeFK0zGOan2ZiG57w9fvJLI7AAAAA.0NpDK192_6kMSYfxFuqHPFkhdsKQBqieRvSqt3XAGLWRe7Y8u0aJalMa8TLEY8eA0XEw4TqRapVLDraRHUz4kQ"
    },
    "workflowExecution": {
        "id": "41f71912-1c6b-4e2f-b340-d6dc10cd69b8",
        "credentials": [
            {
                "id": "fdb1bc31-99a0-4671-8f2a-2bf7ca2faace",
                "category": "ID",
                "allowedChannels": [
                    "WEB",
                    "API",
                    "SDK"
                ],
                "api": {
                    "token": "eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XOMQ7CMAwF0LtkxpKdOk7MxsjKDRInYWkBiUogIe5O2huw_v_09T-uvU-rOzoSUYka0XNSd3DZ7FxHHqLPFksA7WkCRq1QcmrQEYkbE1lsG98xU4-k5IFMCnDzHcrECFWqEVoVLWngV2__cLu0PvTj_lyXfIP1vlzB8jz7rduHvHRGDAmIMQB7GSeFK0zGOan2ZiG57w9fvJLI7AAAAA.0NpDK192_6kMSYfxFuqHPFkhdsKQBqieRvSqt3XAGLWRe7Y8u0aJalMa8TLEY8eA0XEw4TqRapVLDraRHUz4kQ",
                    "parts": {
                        "front": "https://api.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/workflow-executions/41f71912-1c6b-4e2f-b340-d6dc10cd69b8/credentials/fdb1bc31-99a0-4671-8f2a-2bf7ca2faace/parts/FRONT",
                        "back": "https://api.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/workflow-executions/41f71912-1c6b-4e2f-b340-d6dc10cd69b8/credentials/fdb1bc31-99a0-4671-8f2a-2bf7ca2faace/parts/BACK"
                    },
                    "workflowExecution": "https://api.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/workflow-executions/41f71912-1c6b-4e2f-b340-d6dc10cd69b8"
                }
            },
            {
                "id": "e25c0737-5753-4812-ab5c-94813e067ec9",
                "category": "FACEMAP",
                "allowedChannels": [
                    "WEB",
                    "SDK"
                ]
            },
            {
                "id": "bce8a24b-16ba-46a8-994e-fa76e4c4845b",
                "category": "SELFIE",
                "allowedChannels": [
                    "WEB",
                    "API",
                    "SDK"
                ],
                "api": {
                    "token": "eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XOMQ7CMAwF0LtkxpKdOk7MxsjKDRInYWkBiUogIe5O2huw_v_09T-uvU-rOzoSUYka0XNSd3DZ7FxHHqLPFksA7WkCRq1QcmrQEYkbE1lsG98xU4-k5IFMCnDzHcrECFWqEVoVLWngV2__cLu0PvTj_lyXfIP1vlzB8jz7rduHvHRGDAmIMQB7GSeFK0zGOan2ZiG57w9fvJLI7AAAAA.0NpDK192_6kMSYfxFuqHPFkhdsKQBqieRvSqt3XAGLWRe7Y8u0aJalMa8TLEY8eA0XEw4TqRapVLDraRHUz4kQ",
                    "parts": {
                        "face": "https://api.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/workflow-executions/41f71912-1c6b-4e2f-b340-d6dc10cd69b8/credentials/bce8a24b-16ba-46a8-994e-fa76e4c4845b/parts/FACE"
                    },
                    "workflowExecution": "https://api.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/workflow-executions/41f71912-1c6b-4e2f-b340-d6dc10cd69b8"
                }
            }
        ]
    }
}

IDIV Customer Journey

The customer journey is usually managed by the Jumio Web Client and/or mobile SDKs. When you integrate Jumio with your web or mobile applications you redirect your end-users to the UI screens Jumio provides for guiding them through the process of taking pictures of the ID and taking the selfie. The images are automatically uploaded to Jumio and associated with the account.

Optionally you can upload supporting data you have already collected from the end user, such as a phone number, address, or email address. Providing this information enhances fraud detection increases the probability of correctly matching the end user with other data sources.

ℹ️ If you already have a Jumio customer account and would like to experience the IDIV customer journey, you can use the Jumio Showcase app from your personal device. Log in to the Jumio Portal and go to Settings > Identity Verification > App Showcase for details. See also: App Showcase.

Uploading Supporting Data

If you are using a version of the IDIV workflow that supports uploading supporting data you upload it as Prepared Data.

Launching the Web Client

If you are implementing the Jumio Web Client, the URL including the authorization token is available from the Account response body:

Web Client URL from Account Response

"web": {
        "href": "https://greenunion.web.amer-1.jumio.ai/web/v4/app?authorizationToken=eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XOMQ7CMAwF0LtkxpKdOk7MxsjKDRInYWkBiUogIe5O2huw_v_09T-uvU-rOzoSUYka0XNSd3DZ7FxHHqLPFksA7WkCRq1QcmrQEYkbE1lsG98xU4-k5IFMCnDzHcrECFWqEVoVLWngV2__cLu0PvTj_lyXfIP1vlzB8jz7rduHvHRGDAmIMQB7GSeFK0zGOan2ZiG57w9fvJLI7AAAAA.0NpDK192_6kMSYfxFuqHPFkhdsKQBqieRvSqt3XAGLWRe7Y8u0aJalMa8TLEY8eA0XEw4TqRapVLDraRHUz4kQ&amp;locale=en-US"
},

Initializing the SDKs

If you are using a Jumio SDK, the authorization token for initializing the SDK is also available from the Account response body:

"sdk": {
        "token": "eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XOMQ7CMAwF0LtkxpKdOk7MxsjKDRInYWkBiUogIe5O2huw_v_09T-uvU-rOzoSUYka0XNSd3DZ7FxHHqLPFksA7WkCRq1QcmrQEYkbE1lsG98xU4-k5IFMCnDzHcrECFWqEVoVLWngV2__cLu0PvTj_lyXfIP1vlzB8jz7rduHvHRGDAmIMQB7GSeFK0zGOan2ZiG57w9fvJLI7AAAAA.0NpDK192_6kMSYfxFuqHPFkhdsKQBqieRvSqt3XAGLWRe7Y8u0aJalMa8TLEY8eA0XEw4TqRapVLDraRHUz4kQ"
},

Uploading ID and Selfie Credentials

It is possible to develop your own implementation of the customer journey. In that case you are responsible for guiding the end user to provide the required ID and Selfie, and then using the URLs and token provided in the Account response body to upload the credentials to Jumio.

Important: If you implement your own customer journey, you cannot upload a Facemap. The reliability of the Liveness capability will be reduced, since it has only the single Selfie credential to work with. In the example below, notice that the JSON object for the FACEMAP credential only supports the WEB and SDK channels, and does not provide an api object.

Credential Upload URLs from the Account Response

"workflowExecution": {
        "id": "41f71912-1c6b-4e2f-b340-d6dc10cd69b8",
        "credentials": [
            {
                "id": "fdb1bc31-99a0-4671-8f2a-2bf7ca2faace",
                "category": "ID",
                "allowedChannels": [
                    "WEB",
                    "API",
                    "SDK"
                ],
                "api": {
                    "token": "eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XOMQ7CMAwF0LtkxpKdOk7MxsjKDRInYWkBiUogIe5O2huw_v_09T-uvU-rOzoSUYka0XNSd3DZ7FxHHqLPFksA7WkCRq1QcmrQEYkbE1lsG98xU4-k5IFMCnDzHcrECFWqEVoVLWngV2__cLu0PvTj_lyXfIP1vlzB8jz7rduHvHRGDAmIMQB7GSeFK0zGOan2ZiG57w9fvJLI7AAAAA.0NpDK192_6kMSYfxFuqHPFkhdsKQBqieRvSqt3XAGLWRe7Y8u0aJalMa8TLEY8eA0XEw4TqRapVLDraRHUz4kQ",
                    "parts": {
                        "front": "https://api.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/workflow-executions/41f71912-1c6b-4e2f-b340-d6dc10cd69b8/credentials/fdb1bc31-99a0-4671-8f2a-2bf7ca2faace/parts/FRONT",
                        "back": "https://api.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/workflow-executions/41f71912-1c6b-4e2f-b340-d6dc10cd69b8/credentials/fdb1bc31-99a0-4671-8f2a-2bf7ca2faace/parts/BACK"
                    },
                    "workflowExecution": "https://api.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/workflow-executions/41f71912-1c6b-4e2f-b340-d6dc10cd69b8"
                }
            },
            {
                "id": "e25c0737-5753-4812-ab5c-94813e067ec9",
                "category": "FACEMAP",
                "allowedChannels": [
                    "WEB",
                    "SDK"
                ]
            },
            {
                "id": "bce8a24b-16ba-46a8-994e-fa76e4c4845b",
                "category": "SELFIE",
                "allowedChannels": [
                    "WEB",
                    "API",
                    "SDK"
                ],
                "api": {
                    "token": "eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XOMQ7CMAwF0LtkxpKdOk7MxsjKDRInYWkBiUogIe5O2huw_v_09T-uvU-rOzoSUYka0XNSd3DZ7FxHHqLPFksA7WkCRq1QcmrQEYkbE1lsG98xU4-k5IFMCnDzHcrECFWqEVoVLWngV2__cLu0PvTj_lyXfIP1vlzB8jz7rduHvHRGDAmIMQB7GSeFK0zGOan2ZiG57w9fvJLI7AAAAA.0NpDK192_6kMSYfxFuqHPFkhdsKQBqieRvSqt3XAGLWRe7Y8u0aJalMa8TLEY8eA0XEw4TqRapVLDraRHUz4kQ",
                    "parts": {
                        "face": "https://api.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/workflow-executions/41f71912-1c6b-4e2f-b340-d6dc10cd69b8/credentials/bce8a24b-16ba-46a8-994e-fa76e4c4845b/parts/FACE"
                    },
                    "workflowExecution": "https://api.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/workflow-executions/41f71912-1c6b-4e2f-b340-d6dc10cd69b8"
                }
            }
        ]
    }

IDIV Steps and Capabilities

When the customer journey has been completed successfully the workflow is executed on the Jumio servers.

Each capability renders an independent decision about the credentials it evaluates. The overall decision returned by the workflow is based on an evaluation of the capability decisions.

Usability

The usability capability is the first service called by the workflow. It provides a number of checks on each of the images that were uploaded during the customer journey. The checks verify that the images are suitable for further evaluation. A decision is rendered for each image. If the decision is something other than PASSED then a label is provided with a reason for why it did not pass.

For additional information, including descriptions of the decision labels, see: Usability.

Extraction

The extraction capability extracts the relevant data values from the government-issued ID. These values are then used by the data checks capability. Exactly what values are extracted depends on the country and type of ID.

For additional information, including descriptions of the decision labels, see: Extraction.

Image Checks

The image checks capability evaluates the government-issued ID to ensure that it is valid and authentic.

For additional information, including descriptions of the decision labels, see: Image Checks.

Data Checks

The data checks capability runs a number of fraud checks against the extracted data, selfie, and facemap.

For additional information, including descriptions of the decision labels, see: Data Checks.

Similarity

The similarity capability compares the image in the selfie to the picture on the government-issued ID.

For additional information, including descriptions of the decision labels, see: Similarity.

Liveness

If a Facemap is uploaded during the customer journey (Web Client and mobile SDK integrations only) the Facemap is evaluated to ensure that the subject is a live person.

For additional information, including descriptions of the decision labels, see: Liveness.

Handling the IDIV Response

The workflow transaction generates data that you can access and use to determine subsequent actions to take regarding the account. The data can be viewed manually in the Jumio Portal, or obtained by Calling Retrieval APIs. The data includes:

Metadata about the transaction, including:
- Transaction ID
  The unique identifier for the transaction.
- Account ID
  The unique identifier for the end user account.
- Initiated
  The UTC timestamp when the end user started the customer journey.
- Started
  The UTC timestamp when the workflow execution started, following the call to finalize after all credentials were uploaded.
- Completed
  The UTC timestamp when the transaction was completed, the decision was available, and the documents saved.
- Token Expiry
  The UTC timestamp when the authorization token for uploading credentials expired.
The overall workflow decision and risk score.
Results from each capability, including the capability decision, labels describing why the decision was made, and the credentials that were evaluated.
URLs for downloading the credentials that were evaluated.

The information is also available from the retrieval API response, as shown in the following example:

Retrieval API Response

{
    "workflow": {
        "id": "41f71912-1c6b-4e2f-b340-d6dc10cd69b8",
        "status": "PROCESSED",
        "definitionKey": "10164",
        "userReference": "MyUser",
        "customerInternalReference": "MyCompany"
    },
    "account": {
        "id": "572ac7b5-9f83-409d-ba8e-f0014e411c7e"
    },
    "createdAt": "2022-11-28T23:45:02.528Z",
    "startedAt": "2022-11-28T23:50:37.221Z",
    "completedAt": "2022-11-28T23:50:55.232Z",
    "credentials": [
        {
            "id": "bce8a24b-16ba-46a8-994e-fa76e4c4845b",
            "category": "SELFIE",
            "parts": [
                {
                    "classifier": "FACE",
                    "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/credentials/bce8a24b-16ba-46a8-994e-fa76e4c4845b/parts/FACE"
                }
            ]
        },
        {
            "id": "e25c0737-5753-4812-ab5c-94813e067ec9",
            "category": "FACEMAP",
            "parts": [
                {
                    "classifier": "FACEMAP"
                },
                {
                    "classifier": "LIVENESS_1",
                    "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/credentials/e25c0737-5753-4812-ab5c-94813e067ec9/parts/LIVENESS_1"
                },
                {
                    "classifier": "LIVENESS_3",
                    "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/credentials/e25c0737-5753-4812-ab5c-94813e067ec9/parts/LIVENESS_3"
                },
                {
                    "classifier": "LIVENESS_2",
                    "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/credentials/e25c0737-5753-4812-ab5c-94813e067ec9/parts/LIVENESS_2"
                },
                {
                    "classifier": "LIVENESS_5",
                    "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/credentials/e25c0737-5753-4812-ab5c-94813e067ec9/parts/LIVENESS_5"
                },
                {
                    "classifier": "LIVENESS_4",
                    "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/credentials/e25c0737-5753-4812-ab5c-94813e067ec9/parts/LIVENESS_4"
                },
                {
                    "classifier": "LIVENESS_6",
                    "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/credentials/e25c0737-5753-4812-ab5c-94813e067ec9/parts/LIVENESS_6"
                }
            ]
        },
        {
            "id": "fdb1bc31-99a0-4671-8f2a-2bf7ca2faace",
            "category": "ID",
            "parts": [
                {
                    "classifier": "FRONT",
                    "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/credentials/fdb1bc31-99a0-4671-8f2a-2bf7ca2faace/parts/FRONT"
                },
                {
                    "classifier": "BACK",
                    "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/credentials/fdb1bc31-99a0-4671-8f2a-2bf7ca2faace/parts/BACK"
                }
            ]
        }
    ],
    "decision": {
        "type": "WARNING",
        "details": {
            "label": "WARNING"
        },
        "risk": {
            "score": 50.0
        }
    },
    "steps": {
        "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/workflow-executions/41f71912-1c6b-4e2f-b340-d6dc10cd69b8/steps"
    },
    "capabilities": {
        "extraction": [
            {
                "id": "5483e41e-08a7-4d9d-a09d-9f21e41b9e72",
                "credentials": [
                    {
                        "id": "fdb1bc31-99a0-4671-8f2a-2bf7ca2faace",
                        "category": "ID"
                    }
                ],
                "decision": {
                    "type": "PASSED",
                    "details": {
                        "label": "OK"
                    }
                },
                "data": {
                    "type": "DRIVING_LICENSE",
                    "subType": "REGULAR_DRIVING_LICENSE",
                    "issuingCountry": "USA",
                    "firstName": "JOHN",
                    "lastName": "DOE",
                    "dateOfBirth": "1964-08-20",
                    "expiryDate": "2026-08-20",
                    "issuingDate": "2020-08-20",
                    "documentNumber": "A12345676",
                    "state": "CA",
                    "gender": "M",
                    "currentAge": "58"
                }
            }
        ],
        "similarity": [
            {
                "id": "1fc799e4-f0ba-4dde-aaae-af857eef7b6e",
                "credentials": [
                    {
                        "id": "bce8a24b-16ba-46a8-994e-fa76e4c4845b",
                        "category": "SELFIE"
                    },
                    {
                        "id": "fdb1bc31-99a0-4671-8f2a-2bf7ca2faace",
                        "category": "ID"
                    }
                ],
                "decision": {
                    "type": "PASSED",
                    "details": {
                        "label": "MATCH"
                    }
                },
                "data": {
                    "similarity": "MATCH"
                }
            }
        ],
        "liveness": [
            {
                "id": "789f4e4a-7c2f-4764-a98d-c519d082ba6d",
                "validFaceMapForAuthentication": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/credentials/e25c0737-5753-4812-ab5c-94813e067ec9/parts/FACEMAP",
                "credentials": [
                    {
                        "id": "bce8a24b-16ba-46a8-994e-fa76e4c4845b",
                        "category": "SELFIE"
                    },
                    {
                        "id": "e25c0737-5753-4812-ab5c-94813e067ec9",
                        "category": "FACEMAP"
                    }
                ],
                "decision": {
                    "type": "PASSED",
                    "details": {
                        "label": "OK"
                    }
                },
                "data": {
                    "type": "IPROOV_STANDARD",
                    "predictedAge": 44,
                    "ageConfidenceRange": "32-56"
                }
            }
        ],
        "dataChecks": [
            {
                "id": "da2a93b5-8a1f-4db6-bdfa-fb57ada57b12",
                "credentials": [
                    {
                        "id": "fdb1bc31-99a0-4671-8f2a-2bf7ca2faace",
                        "category": "ID"
                    }
                ],
                "decision": {
                    "type": "PASSED",
                    "details": {
                        "label": "OK"
                    }
                }
            }
        ],
        "imageChecks": [
            {
                "id": "b336a404-7775-4793-9cf6-30a7e5be1d0b",
                "credentials": [
                    {
                        "id": "bce8a24b-16ba-46a8-994e-fa76e4c4845b",
                        "category": "SELFIE"
                    },
                    {
                        "id": "fdb1bc31-99a0-4671-8f2a-2bf7ca2faace",
                        "category": "ID"
                    }
                ],
                "decision": {
                    "type": "WARNING",
                    "details": {
                        "label": "REPEATED_FACE"
                    }
                },
                "data": {
                    "faceSearchFindings": {
                        "status": "DONE",
                        "findings": [
                            "22771260-8cb0-42a2-a38a-d8f853063cc2",
                            "27232651-4b18-4cf1-8d4a-df0451abc717",
                            "9541ae91-834e-4914-a30d-6534fed4eb6d",
                            "9414413d-2c76-44d2-9052-8876fa327a02"
                        ]
                    }
                }
            }
        ],
        "usability": [
            {
                "id": "1bb41666-2745-4c9a-bd5f-d0e338d0242b",
                "credentials": [
                    {
                        "id": "fdb1bc31-99a0-4671-8f2a-2bf7ca2faace",
                        "category": "ID"
                    }
                ],
                "decision": {
                    "type": "PASSED",
                    "details": {
                        "label": "OK"
                    }
                }
            },
            {
                "id": "db0fd83a-5f9f-4739-94f7-7868194ba1dc",
                "credentials": [
                    {
                        "id": "e25c0737-5753-4812-ab5c-94813e067ec9",
                        "category": "FACEMAP"
                    }
                ],
                "decision": {
                    "type": "PASSED",
                    "details": {
                        "label": "OK"
                    }
                }
            },
            {
                "id": "e991586b-3345-4a2d-bfc3-1690ccb477b3",
                "credentials": [
                    {
                        "id": "bce8a24b-16ba-46a8-994e-fa76e4c4845b",
                        "category": "SELFIE"
                    }
                ],
                "decision": {
                    "type": "PASSED",
                    "details": {
                        "label": "OK"
                    }
                }
            }
        ]
    }
}

Authentication Workflow

When someone claiming to be an end user you have already onboarded returns to your platform, use Jumio Authentication to make sure they really are the same person. Jumio Authentication captures a fresh Selfie and Facemap and compares them to an existing Facemap that is already associated with the end-user account.

Typically the existing Facemap is the one that was acquired when the end user was first onboarded using the Identification Document and Identity Verification (IDIV) Workflow. Depending on your organization's Data Retention policy (See Data Settings) that Facemap is:

Stored on Jumio's servers, and associated with the account if it is within the configured Data retention period.
Deleted from Jumio's servers if it is beyond the configured Data retention period. In that case if you want to use Authentication you must download the Facemap, store it on your own servers, and upload it prior to running Authentication with a new Facemap. See Authentication On-Premises for detailed instructions.

ℹ️ You must record and retain the account ID generated by the on-boarding transaction. The account ID value can be obtained from the Portal or from the API responses. For additional information see Creating or Updating Accounts.

When you have an existing end user account with an existing Facemap, the process to authenticate the same user is as follows:

Update the Account to Initiate an Authentication Transaction
Complete the Customer Journey for the Authentication Transaction
Retrieve the Decision

Update the Account to Initiate an Authentication Transaction

Use the PUT request for the Accounts API to update the existing end user account. The account ID value saved from the on-boarding transaction is used as a path parameter in the request URL.

In the request body, specify workflow key 10014 to use the standard Authorization workflow.

ℹ️ Workflow 10014 uses the Authentication capability to compare a newly-acquired Facemap to the existing Facemap. If you require a custom workflow with additional services or risk signals contact your Jumio representative.

Example Request Body

{
   "customerInternalReference":"MyCompany",
   "workflowDefinition":{
     "key": 10014
   }
}

If your integration uses one of the Mobile SDKs with a custom user interface you can use the original consent obtained when the end user was onboarded instead of requiring the end user to provide an explicit consent for each authentication transaction. In this case you must have recorded the timestamp from the onboarding, and be able to use it to set the userConsent values, as shown in the example below. The original consent can be valid for a maximum of 3 years. Beyond that the end user must explicitly provide the consent, as described in End-User Consent to Collect Personal Data.

{
   "customerInternalReference":"MyCompany",
   "workflowDefinition":{
     "key": 10014
   },
   "userConsent":
     "consent": {
       "obtained": "yes",
       "obtainedAt": "2022-07-20T17:20:35.000Z"
     }
  }
}

Complete the Customer Journey for the Authentication Transaction

Authentication requires your integration to use either the Web Client or one of the Mobile SDKs. A new Facemap is required, which cannot be uploaded through the REST APIs. See Implementing the Customer Journey for additional information.

The end user is guided to take the new Selfie and Facemap. When they have been successfully uploaded the workflow is finalized.

Retrieve the Decision

If your integration has integrated a Callback service it will be notified when the transaction is complete. Alternatively you can call the Transaction Status API to determine if the transaction has been PROCESSED.

Once the transaction has completed you can call the Workflow Details API to retrieve the decision and other workflow data.

Example Details Response

{
   "workflow": {
      "id": "a6692412-a1e1-4fbc-a3fa-79c210af25b6",
      "status": "PROCESSED",
      "definitionKey": "10014",
      "customerInternalReference": "MyCompany"
   },
   "account": {
      "id": "2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f"
   },
   "createdAt": "2023-04-19T17:54:28.218Z",
   "startedAt": "2023-04-19T17:55:15.170Z",
   "completedAt": "2023-04-19T17:55:16.126Z",
   "credentials": \[
      {
         "id": "c4daab5f-bbe7-4fea-8d0e-1e6a9fa0094a",
         "category": "SELFIE",
         "parts": \[
            {
               "classifier": "FACE",
               "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/credentials/c4daab5f-bbe7-4fea-8d0e-1e6a9fa0094a/parts/FACE"
            }
         \]
      },
      {
         "id": "4915434a-9b0f-4bbf-b088-dfea00b4b680",
         "category": "FACEMAP",
         "parts": \[
            {
               "classifier": "FACEMAP"
            },
            {
               "classifier": "LIVENESS\_1",
               "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/credentials/4915434a-9b0f-4bbf-b088-dfea00b4b680/parts/LIVENESS\_1"
            },
            {
               "classifier": "LIVENESS\_3",
               "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/credentials/4915434a-9b0f-4bbf-b088-dfea00b4b680/parts/LIVENESS\_3"
            },
            {
               "classifier": "LIVENESS\_2",
               "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/credentials/4915434a-9b0f-4bbf-b088-dfea00b4b680/parts/LIVENESS\_2"
            },
            {
               "classifier": "LIVENESS\_5",
               "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/credentials/4915434a-9b0f-4bbf-b088-dfea00b4b680/parts/LIVENESS\_5"
            },
            {
               "classifier": "LIVENESS\_4",
               "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/credentials/4915434a-9b0f-4bbf-b088-dfea00b4b680/parts/LIVENESS\_4"
            },
            {
               "classifier": "LIVENESS\_6",
               "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/credentials/4915434a-9b0f-4bbf-b088-dfea00b4b680/parts/LIVENESS\_6"
            }
         \]
      }
   \],
   "decision": {
      "type": "PASSED",
      "details": {
         "label": "PASSED"
      },
      "risk": {
         "score": 0.0
      }
   },
   "steps": {
      "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/workflow-executions/a6692412-a1e1-4fbc-a3fa-79c210af25b6/steps"
   },
   "capabilities": {
      "usability": \[
         {
            "id": "7023c47c-6c61-4bba-acd7-b00d053318dc",
            "credentials": \[
               {
                  "id": "c4daab5f-bbe7-4fea-8d0e-1e6a9fa0094a",
                  "category": "SELFIE"
               }
            \],
            "decision": {
               "type": "PASSED",
               "details": {
                  "label": "OK"
               }
            }
         },
         {
            "id": "0bc1e60d-e33e-47aa-8f72-c3eb6348ea81",
            "credentials": \[
               {
                  "id": "4915434a-9b0f-4bbf-b088-dfea00b4b680",
                  "category": "FACEMAP"
               }
            \],
            "decision": {
               "type": "PASSED",
               "details": {
                  "label": "OK"
               }
            }
         }
      \],
      "authentication": \[
         {
            "id": "9f25965a-4073-4051-a02c-aa5a4d175a77",
            "validFaceMapForAuthentication": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/credentials/4915434a-9b0f-4bbf-b088-dfea00b4b680/parts/FACEMAP",
            "credentials": \[
               {
                  "id": "4915434a-9b0f-4bbf-b088-dfea00b4b680",
                  "category": "FACEMAP"
               }
            \],
            "decision": {
               "type": "PASSED",
               "details": {
                  "label": "OK"
               }
            },
            "data": {
               "type": "IPROOV\_STANDARD"
            }
         }
      \]
   }
}

Authentication On-Premises

Authentication On-Premises is similar to the Authentication Workflow but is used when your organization's Data Retention policies (See Data Settings) specify that end user credentials must be deleted after some period of time. As with the Authentication Workflow, when someone claiming to be an end user you have already onboarded returns to your platform, a fresh Selfie and Facemap are captured and compared to an existing Facemap. However, since the original Facemap generated by the onboarding process may have been deleted from Jumio's servers, you must upload the existing Facemap that will be used for the comparison. In this case you must have downloaded and stored the Facemap that was acquired as part of the end user onboarding before it was deleted. You can then upload the stored Facemap and use it with the Authentication On-Premises workflow.

Retrieve the Onboarding Facemap

After the end user has successfully onboarded, but before the credentials are deleted in accordance with your Data Retention policies, you can download the Facemap and store it for future use with Authentication On-Premises.

ℹ️ Important! Your tenant must be configured to allow downloading a Facemap. Contact Jumio Support to make sure that the Allow download of facemap option is enabled.

When Allow download of facemap is enabled the Workflow Details response from the on-boarding workflow includes the URL you can use to retrieve the Facemap as a single binary file. See also: GET parts API.

Download and store the Facemap file, along with the account ID so they can be accessed as needed for subsequent authentications.

Example FACEMAP href

   "credentials": \[
      {
         ...
      },
      {
         "id": "4915434a-9b0f-4bbf-b088-dfea00b4b680",
         "category": "FACEMAP",
         "parts": \[
            {
               "classifier": "FACEMAP",
               "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/credentials/4915434a-9b0f-4bbf-b088-dfea00b4b680/parts/FACEMAP"
            },

...

Update the Account to Initiate an Authentication On-Premises Transaction

Use the PUT request for the Accounts API to update the existing end user account. The account ID value saved from the on-boarding transaction is used as a path parameter in the request URL.

In the request body, specify workflow key 10071 to use the standard Authorization On-Premises workflow.

ℹ️ Workflow 10071 uses the Authentication capability to compare a newly-acquired Facemap to a Facemap you upload using the API. If you require a custom workflow with additional services or risk signals contact your Jumio representative.

The response body will include three credential objects:

A FACEMAP that will have allowed channels for WEB and SDK. This is the new FACEMAP that will be generated as part of the WEB or SDK customer journey.
A FACEMAP with the API allowed channel, and an api:parts:facemap URL you can use to upload the stored FACEMAP.
A SELFIE that will have allowed channels for WEB and SDK. This is the new SELFIE that will be generated as part of the WEB or SDK customer journey.

Example Request Body

{
   "customerInternalReference":"MyCompany",
   "workflowDefinition":{
     "key": 10071
  }
}

Example Response Credentials

{
...
   "workflowExecution": {
      "id": "078e9c6b-e2d9-4c41-8c28-627106387d31",
      "credentials": \[
         {
            "id": "ab05065f-f8f0-4892-a34e-47dfbf1c5689",
            "category": "FACEMAP",
            "allowedChannels": \[
               "WEB",
               "SDK"
            \]
         },
         {
            "id": "eda8ebae-8c84-4fa0-8f9d-6538e907e04f",
            "category": "FACEMAP",
            "allowedChannels": \[
               "API"
            \],
            "api": {
               "token": "eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA\_5XOMQ7CMAxA0btkxpLjOI7DxsjKDRInYWkBiUogIe5Oi7gA69cb\_sv152Fxe-dFvUaRQIHI7VwxO7a1UxS1JAhYYgUumKBWG9BS4R6txUpj41-MSXs2qdCpZWBjD2qkIJQ8StDUgl\_xY\_R\_uJ36WPXtel\_mcoHlOp\_ByjRtm79JGYwYFTxjBCZpUIUbBOOiOY9uUd37Azm5chvsAAAA.We0X\_lp4xFxKS8C4nz5nY5y13R9UJvm4uaobVof5o8qCV4eBA-bXmPkSiEAaqRNGAnXfp5fdZSgz5zxIJUprzg",
               "parts": {
                  "facemap": "https://api.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/workflow-executions/078e9c6b-e2d9-4c41-8c28-627106387d31/credentials/eda8ebae-8c84-4fa0-8f9d-6538e907e04f/parts/FACEMAP"
               },
               "workflowExecution": "https://api.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/workflow-executions/078e9c6b-e2d9-4c41-8c28-627106387d31"
            }
         },
         {
            "id": "5888b4ce-59fe-43e4-bd00-c9bc582798f7",
            "category": "SELFIE",
            "allowedChannels": \[
               "WEB",
               "SDK"
            \]
         }
      \]
   }
}

Upload the Stored Facemap

After the account is updated but before the customer journey is initiated, upload the stored Facemap using a POST request with the api:parts:facemap URL in the response to the account update.

ℹ️ Do not make the call to finalize the workflow after uploading the Facemap. Instead, once the Facemap is successfully uploaded, initiate the customer journey as you would with any other WEB Client or SDK workflow.

Retrieve the Decision

Once the transaction has completed you can call the Workflow Details API to retrieve the decision and other workflow data.

Example Details Response

{
   "workflow": {
      "id": "334179b3-196f-4a11-a7bf-f3d5e9e4ec4f",
      "status": "PROCESSED",
      "definitionKey": "10071",
      "customerInternalReference": "MyCompany"
   },
   "account": {
      "id": "2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f"
   },
   "createdAt": "2023-04-27T21:17:44.771Z",
   "startedAt": "2023-04-27T21:20:22.086Z",
   "completedAt": "2023-04-27T21:20:22.915Z",
   "credentials": \[
      {
         "id": "7b9f5a06-76bf-483c-ab9c-041fc3cff2c6",
         "category": "SELFIE",
         "parts": \[
            {
               "classifier": "FACE",
               "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/credentials/7b9f5a06-76bf-483c-ab9c-041fc3cff2c6/parts/FACE"
            }
         \]
      },
      {
         "id": "63fb3a15-fdea-472c-9b81-6771f26df043",
         "category": "FACEMAP",
         "parts": \[
            {
               "classifier": "FACEMAP"
            },
            {
               "classifier": "LIVENESS\_1",
               "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/credentials/63fb3a15-fdea-472c-9b81-6771f26df043/parts/LIVENESS\_1"
            },
            {
               "classifier": "LIVENESS\_3",
               "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/credentials/63fb3a15-fdea-472c-9b81-6771f26df043/parts/LIVENESS\_3"
            },
            {
               "classifier": "LIVENESS\_2",
               "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/credentials/63fb3a15-fdea-472c-9b81-6771f26df043/parts/LIVENESS\_2"
            },
            {
               "classifier": "LIVENESS\_5",
               "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/credentials/63fb3a15-fdea-472c-9b81-6771f26df043/parts/LIVENESS\_5"
            },
            {
               "classifier": "LIVENESS\_4",
               "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/credentials/63fb3a15-fdea-472c-9b81-6771f26df043/parts/LIVENESS\_4"
            },
            {
               "classifier": "LIVENESS\_6",
               "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/credentials/63fb3a15-fdea-472c-9b81-6771f26df043/parts/LIVENESS\_6"
            }
         \]
      },
      {
         "id": "d1a3e2c9-539f-487e-9937-62bd11f6a07b",
         "category": "FACEMAP",
         "parts": \[
            {
               "classifier": "FACEMAP"
            }
         \]
      }
   \],
   "decision": {
      "type": "PASSED",
      "details": {
         "label": "PASSED"
      },
      "risk": {
         "score": 0.0
      }
   },
   "steps": {
      "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/workflow-executions/334179b3-196f-4a11-a7bf-f3d5e9e4ec4f/steps"
   },
   "capabilities": {
      "usability": \[
         {
            "id": "da066373-6aff-4fdb-a63b-84b933b02740",
            "credentials": \[
               {
                  "id": "d1a3e2c9-539f-487e-9937-62bd11f6a07b",
                  "category": "FACEMAP"
               }
            \],
            "decision": {
               "type": "PASSED",
               "details": {
                  "label": "OK"
               }
            }
         },
         {
            "id": "92439dde-dda6-4789-b398-be28c8c2c2e8",
            "credentials": \[
               {
                  "id": "7b9f5a06-76bf-483c-ab9c-041fc3cff2c6",
                  "category": "SELFIE"
               }
            \],
            "decision": {
               "type": "PASSED",
               "details": {
                  "label": "OK"
               }
            }
         },
         {
            "id": "d057ab3c-7b84-46f8-8c5f-8248147367ba",
            "credentials": \[
               {
                  "id": "63fb3a15-fdea-472c-9b81-6771f26df043",
                  "category": "FACEMAP"
               }
            \],
            "decision": {
               "type": "PASSED",
               "details": {
                  "label": "OK"
               }
            }
         }
      \],
      "authentication": \[
         {
            "id": "08772b5b-a443-4eb6-964b-47705ac631ac",
            "validFaceMapForAuthentication": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/2568c760-0a5b-4a07-bbcf-d7a4e5cd5b2f/credentials/63fb3a15-fdea-472c-9b81-6771f26df043/parts/FACEMAP",
            "credentials": \[
               {
                  "id": "63fb3a15-fdea-472c-9b81-6771f26df043",
                  "category": "FACEMAP"
               }
            \],
            "decision": {
               "type": "PASSED",
               "details": {
                  "label": "OK"
               }
            },
            "data": {
               "type": "IPROOV\_STANDARD"
            }
         }
      \]
   }
}

Standard Services​

Identification Document and Identity Verification (IDIV) Workflow​

Account Creation or Update​

Account Response​

Sample Account Creation Request and Response​

IDIV Customer Journey​

Uploading Supporting Data​

Launching the Web Client​

Initializing the SDKs​

Uploading ID and Selfie Credentials​

IDIV Steps and Capabilities​

Usability​

Extraction​

Image Checks​

Data Checks​

Similarity​

Liveness​

Handling the IDIV Response​

Authentication Workflow​

Update the Account to Initiate an Authentication Transaction​

Example Request Body​

Providing the End-User Consent​

Complete the Customer Journey for the Authentication Transaction​

Retrieve the Decision​

Example Details Response​

Authentication On-Premises​

Retrieve the Onboarding Facemap​

Update the Account to Initiate an Authentication On-Premises Transaction​

Upload the Stored Facemap​

Retrieve the Decision​

Table of Contents

Standard Services

Identification Document and Identity Verification (IDIV) Workflow

Account Creation or Update

Account Response

Sample Account Creation Request and Response

IDIV Customer Journey

Uploading Supporting Data

Launching the Web Client

Initializing the SDKs

Uploading ID and Selfie Credentials

IDIV Steps and Capabilities

Usability

Extraction

Image Checks

Data Checks

Similarity

Liveness

Handling the IDIV Response

Authentication Workflow

Update the Account to Initiate an Authentication Transaction

Example Request Body

Providing the End-User Consent

Complete the Customer Journey for the Authentication Transaction

Retrieve the Decision

Example Details Response

Authentication On-Premises

Retrieve the Onboarding Facemap

Update the Account to Initiate an Authentication On-Premises Transaction

Upload the Stored Facemap

Retrieve the Decision