Skip to content
For LLMsView as Markdown·

Jumio

KYC identity verification with document scanning and liveness detection.

DetailValue
CategoryiGaming
Base URLhttps://account.amer-1.jumio.ai/api/v1
AuthenticationBearer Token
Endpoints5
Connector keyjumio

Using Jumio in a workflow

  1. Go to Connections and click New Connection.
  2. Pick Jumio from the marketplace.
  3. Enter your credentials (see Authentication above for what's expected).
  4. In a workflow, drop an API Call node and select this connection.
  5. Pick the operation you need from the Operation dropdown — the full list is below.

Available endpoints

EndpointSummary
POST /accountsCreate a verification account
GET /accounts/{accountId}Get account details
GET /accounts/{accountId}/workflow-executions/{workflowExecutionId}Get workflow execution status
PUT /accounts/{accountId}/workflow-executions/{workflowExecutionId}/credentials/{credentialId}Upload a verification document
PUT /accounts/{accountId}/workflow-executions/{workflowExecutionId}/credentials/{credentialId}/finalizeFinalize credential processing

Each endpoint is documented in full below. Use the outline on the right to jump to one.

POST /accounts

Create a verification account

DetailValue
Operation IDkyc.createAccount
MethodPOST
Path/accounts

Parameters

No parameters.

Request Body

FieldType
customerInternalReferencestring
workflowDefinitionobject

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Jumio connection from the Connection dropdown.
  3. In the Operation dropdown, select kyc.createAccount.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Jumio API reference.

GET /accounts/{accountId}

Get account details

DetailValue
Operation IDkyc.getAccount
MethodGET
Path/accounts/{accountId}

Parameters

NameLocationTypeRequired
accountIdpathstringYes

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Jumio connection from the Connection dropdown.
  3. In the Operation dropdown, select kyc.getAccount.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Jumio API reference.

GET /accounts/{accountId}/workflow-executions/{workflowExecutionId}

Get workflow execution status

DetailValue
Operation IDkyc.getWorkflowExecution
MethodGET
Path/accounts/{accountId}/workflow-executions/{workflowExecutionId}

Parameters

NameLocationTypeRequired
accountIdpathstringYes
workflowExecutionIdpathstringYes

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Jumio connection from the Connection dropdown.
  3. In the Operation dropdown, select kyc.getWorkflowExecution.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Jumio API reference.

PUT /accounts/{accountId}/workflow-executions/{workflowExecutionId}/credentials/{credentialId}

Upload a verification document

DetailValue
Operation IDkyc.uploadDocument
MethodPUT
Path/accounts/{accountId}/workflow-executions/{workflowExecutionId}/credentials/{credentialId}

Parameters

NameLocationTypeRequired
accountIdpathstringYes
workflowExecutionIdpathstringYes
credentialIdpathstringYes

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Jumio connection from the Connection dropdown.
  3. In the Operation dropdown, select kyc.uploadDocument.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Jumio API reference.

PUT /accounts/{accountId}/workflow-executions/{workflowExecutionId}/credentials/{credentialId}/finalize

Finalize credential processing

DetailValue
Operation IDkyc.finalizeCredential
MethodPUT
Path/accounts/{accountId}/workflow-executions/{workflowExecutionId}/credentials/{credentialId}/finalize

Parameters

NameLocationTypeRequired
accountIdpathstringYes
workflowExecutionIdpathstringYes
credentialIdpathstringYes

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Jumio connection from the Connection dropdown.
  3. In the Operation dropdown, select kyc.finalizeCredential.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Jumio API reference.