Appearance
Jumio
KYC identity verification with document scanning and liveness detection.
| Detail | Value |
|---|---|
| Category | iGaming |
| Base URL | https://account.amer-1.jumio.ai/api/v1 |
| Authentication | Bearer Token |
| Endpoints | 5 |
| Connector key | jumio |
Using Jumio in a workflow
- Go to Connections and click New Connection.
- Pick Jumio from the marketplace.
- Enter your credentials (see Authentication above for what's expected).
- In a workflow, drop an API Call node and select this connection.
- Pick the operation you need from the Operation dropdown — the full list is below.
Available endpoints
| Endpoint | Summary |
|---|---|
POST /accounts | Create 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}/finalize | Finalize 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
| Detail | Value |
|---|---|
| Operation ID | kyc.createAccount |
| Method | POST |
| Path | /accounts |
Parameters
No parameters.
Request Body
| Field | Type |
|---|---|
customerInternalReference | string |
workflowDefinition | object |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Jumio connection from the Connection dropdown.
- In the Operation dropdown, select
kyc.createAccount. - 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
| Detail | Value |
|---|---|
| Operation ID | kyc.getAccount |
| Method | GET |
| Path | /accounts/{accountId} |
Parameters
| Name | Location | Type | Required |
|---|---|---|---|
accountId | path | string | Yes |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Jumio connection from the Connection dropdown.
- In the Operation dropdown, select
kyc.getAccount. - 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
| Detail | Value |
|---|---|
| Operation ID | kyc.getWorkflowExecution |
| Method | GET |
| Path | /accounts/{accountId}/workflow-executions/{workflowExecutionId} |
Parameters
| Name | Location | Type | Required |
|---|---|---|---|
accountId | path | string | Yes |
workflowExecutionId | path | string | Yes |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Jumio connection from the Connection dropdown.
- In the Operation dropdown, select
kyc.getWorkflowExecution. - 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
| Detail | Value |
|---|---|
| Operation ID | kyc.uploadDocument |
| Method | PUT |
| Path | /accounts/{accountId}/workflow-executions/{workflowExecutionId}/credentials/{credentialId} |
Parameters
| Name | Location | Type | Required |
|---|---|---|---|
accountId | path | string | Yes |
workflowExecutionId | path | string | Yes |
credentialId | path | string | Yes |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Jumio connection from the Connection dropdown.
- In the Operation dropdown, select
kyc.uploadDocument. - 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
| Detail | Value |
|---|---|
| Operation ID | kyc.finalizeCredential |
| Method | PUT |
| Path | /accounts/{accountId}/workflow-executions/{workflowExecutionId}/credentials/{credentialId}/finalize |
Parameters
| Name | Location | Type | Required |
|---|---|---|---|
accountId | path | string | Yes |
workflowExecutionId | path | string | Yes |
credentialId | path | string | Yes |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Jumio connection from the Connection dropdown.
- In the Operation dropdown, select
kyc.finalizeCredential. - 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.