Skip to main content

API Endpoints in Jumio

Jumio provides a set of REST API endpoints that enable seamless integration for account management, credential handling, data retrieval, and real-time status checks. Each endpoint is designed to support secure and efficient workflows for identity verification and related operations.

  • Account API Endpoints – Manage account setup, updates, and configuration to control how Jumio services interact with your systems.

  • Credentials API – Handle secure creation, management, and rotation of API credentials for authentication.

  • Retrieval API – Fetch identity verification results, images, and related data for completed transactions.

  • Status Endpoint API – Get real-time updates on the processing status of identity verification requests.

REST APIs for Credential Acquisition​

In addition to the REST APIs for Creating or Updating Accounts and Viewing or Retrieving Workflow Transactions that are used for all integration channels, Jumio provides REST APIs for:

tip

If you use the APIs to upload credentials to Jumio you must first obtain the end-user's consent on Jumio's behalf. See to Collect Personal Data and Creating or Updating Accounts.

Uploading Credentials​

URLs with the correct path parameters and authorization bearer tokens for these APIs are available from the workflowExecution:credentials objects in the response from the account creation or update call, as shown in the following example:

{
  "timestamp": "2022-11-28T23:45:02.536Z",
  "account": {
    "id": "<ACCOUNT_ID>"
  },
  "web": {
    ...
  },
  "sdk": {
    ...
  },
  "workflowExecution": {
    "id": "<WORKFLOW_EXECUTION_ID>",
    "credentials": [
      {
        "id": "<CREDENTIAL_ID_1>",
        "category": "ID",
        "allowedChannels": [
          "WEB",
          "API",
          "SDK"
        ],
        "api": {
          "token": "<JWT_TOKEN>",
          "parts": {
            "front": "<FRONT_PART_URL>",
            "back": "<BACK_PART_URL>"
          },
          "workflowExecution": "<WORKFLOW_EXECUTION_URL>"
        }
      },
      {
        "id": "<CREDENTIAL_ID_2>",
        "category": "FACEMAP",
        "allowedChannels": [
          "WEB",
          "SDK"
        ]
      },
      {
        "id": "<CREDENTIAL_ID_3>",
        "category": "SELFIE",
        "allowedChannels": [
          "WEB",
          "API",
          "SDK"
        ],
        "api": {
          "token": "<JWT_TOKEN>",
          "parts": {
            "face": "<FACE_PART_URL>"
          },
          "workflowExecution": "<WORKFLOW_EXECUTION_URL>"
        }
      }
    ]
  }
}
Credential TypeMinimum ResolutionMaximum ResolutionAdditional Requirements
Document Image (Front & Back)563 × 355 px8000 × 8000 pxThe document in the image must be at least 512 px wide and 323 px high.
Selfie Image480 × 640 px8000 × 8000 pxThe face must be at least 320 px tall and occupy at least 15% of the image.

For the complete API specification see: Credentials and Finalization APIs.

Uploading Prepared Data​

Some workflows accept raw data values that identify the end user. Your integration needs to capture this data and upload it as a credential type called Prepared Data. The account response includes an object in the credentials array with a category of DATA and an api object with:

  • A token value for authorizing the upload.
  • A parts object with a prepared_data value that is the URL to upload the data.

Use a POST request and provide the values as a JSON. See the PREPARED_DATA endpoint here.

Example: Prepared Data Credential Object in Account Response​

"credentials": [
  {
    "id": "e62dc87d-bc8a-4933-8ace-05acc3c8a379",
    "category": "DATA",
    "allowedChannels": [
      "API"
    ],
    "api": {
      "token": "eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XLOQ4CMQxA0bukxpIztmOHDlHRcoM4S8dSIMEIcXfC3ID26_136K_DI-xD1IjEiTQtbGEXSq2nNvuIWYh6g84ygBMqGBICC0fLtXlvG99wwahKlSC5T-LI4KQEKshuTQiXNvFz9H94Pfcx9WU93i73cl1_afuzpGicGhThPn9DMFsQSkZXZS8x1_D5AkAD7yrjAAAA.2qBHxwy43HMorgyrnL2AUOP_igbBNplBg8ZX9U-MeoPPek4mHTf_C4E9Ubbx4qehkyahdskiK1CCkLChrfqNpA",
      "parts": {
        "prepared_data": "https://api.amer-1.jumio.ai/api/v1/accounts/f19533ed-e45f-4607-8030-454189cdbed8/workflow-executions/a01773c3-6bb0-4b04-b373-7504b8d5302d/credentials/e62dc87d-bc8a-4933-8ace-05acc3c8a379/parts/PREPARED_DATA"
      },
      "workflowExecution": "https://api.amer-1.jumio.ai/api/v1/accounts/f19533ed-e45f-4607-8030-454189cdbed8/workflow-executions/a01773c3-6bb0-4b04-b373-7504b8d5302d"
    }
  }
]

See also: Capabilities Reference.

Workflow Finalization​

Once the required credentials are uploaded, you can call the finalization API to trigger the workflow execution.

If you are using the web client or mobile SDKs, the finalization call is made automatically once the required credentials have been received.

Example Finalization Call

curl --location --request PUT 'https://api.amer-1.jumio.ai/api/v1/accounts/3adef3f9-b892-4f9c-9b81-f16e5e87230d/workflow-executions/692701a5-eedc-45ca-adb6-213c2f3c7acc' \
--header 'Authorization: Bearer xxx'

For the complete API specification see: Credentials API Reference.

Table of Contents