canonical: https://jentic.com/apis/jumio.ai/jumio

# Jumio API

Jentic publishes the only available OpenAPI specification for Jumio API, keeping it validated and agent-ready. The Jumio API powers KYC, AML, and identity verification flows by orchestrating workflow executions against verification accounts. It supports document capture, biometric checks, and credential lifecycle management, exposing endpoints to create accounts, run workflow executions, and retrieve transaction results and images. Integrations span web and mobile SDKs, with the REST surface used to create credentials, query verification status, and pull final transaction data for downstream review.

## For AI agents

Run identity verification workflows on Jumio: create accounts, kick off verification executions, and retrieve the verified document data, biometric results, and transaction images.

## Scope

Does not handle payments, fraud scoring on transactions, or credit checks - use for identity verification and KYC workflows only.

## Capabilities

- Create and manage Jumio verification accounts via /accounts and update account profile data
- Initiate identity proofing workflow executions and poll their status until verification completes
- Issue and rotate API credentials scoped to a specific account through `/accounts/{accountId}/credentials`
- Retrieve full transaction results including extracted document fields and verification decision via `/retrieval/{transactionReference}`
- Pull captured document and selfie images by image ID for downstream review or audit storage
- Read account-level verification status to determine whether an end user has cleared KYC checks

## Use cases

### Onboarding KYC for Fintech Signups

When a new user signs up to a regulated fintech, the application creates a Jumio account, initiates a workflow execution, and waits for the user to capture their ID and selfie. Once the workflow finishes, the backend retrieves the transaction reference data to gate account funding on a passing decision. Most onboarding flows complete in under five minutes including capture and review.

Example prompt: Create a Jumio account for user 'jane@example.com', start a workflow execution, poll status until finished, then call `/retrieval/{transactionReference}` and return the verification decision.

### Document Image Audit Trail

Compliance teams need to retrieve and archive the original document and selfie images captured during verification. The Jumio API exposes `/retrieval/{transactionReference}/images/{imageId}` so a server-side job can pull each image for a given transaction and store it in the firm's regulated record system. This replaces manual screenshot collection and keeps audit data tied to the verification reference.

Example prompt: For transaction reference 'tx-789', list available image IDs and download each via `/retrieval/tx-789/images/{imageId}` into S3 bucket 'kyc-archive'.

### Workflow Status Reconciliation

Long-lived verification workflows can stall when users abandon capture or fail liveness. A reconciliation job lists workflow executions for an account using GET `/accounts/{accountId}/workflow-executions` and inspects per-execution detail, then nudges or expires stuck verifications. This prevents incomplete verifications from blocking account activation.

Example prompt: List all workflow executions for accountId 'acct-42' from the last 24 hours, identify any with status 'PENDING' older than 12 hours, and surface them for manual review.

### Agent-Driven Customer Verification

An AI support agent handling a high-risk transaction escalation can trigger a fresh Jumio re-verification through Jentic. The agent searches for 'start an identity verification', loads the workflow execution schema, creates an account if needed, and returns the user-facing capture URL. This puts an enterprise-grade KYC step directly inside an agent flow without exposing raw API keys.

Example prompt: Through Jentic, search 'start an identity verification', load the Jumio workflow-executions operation, execute it for accountId 'acct-99', and return the redirect URL to the customer.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/accounts` | Create a new verification account |
| POST | `/accounts/{accountId}/workflow-executions` | Initiate a verification workflow execution |
| GET | `/accounts/{accountId}/workflow-executions/{workflowExecutionId}` | Get workflow execution details and decision |
| GET | `/accounts/{accountId}/status` | Get account verification status |
| GET | `/retrieval/{transactionReference}` | Retrieve transaction data for a completed verification |
| GET | `/retrieval/{transactionReference}/images/{imageId}` | Retrieve a captured document or selfie image |

## Key resources

- **Accounts** — Create, retrieve, and update Jumio verification accounts and their credentials
- **Workflow Executions** — Initiate and track end-to-end identity proofing workflows tied to an account
- **Retrieval** — Pull final transaction data and captured document/selfie images by transaction reference

## Why Jentic

- **Setup:** Wiring the Jumio API by hand means learning its bearer auth, targeting the correct regional host such as amer-1, and threading account and workflow-execution ids through each KYC step yourself. Through Jentic you install once, import the Jumio API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Jumio puts the account id in the URL path (`/accounts/{accountId}/...`), so a rule can pin your agent to one account: it can start workflow executions and read their status for that account and nothing else. You choose the operations it may call, so ones like creating new accounts are not included unless you add them.
- **Credential handling:** Your Jumio bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'start an identity verification' or 'check a KYC status', and Jentic returns the matching Jumio operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Onfido API** — Identity verification and document checks similar to Jumio with global coverage.
- **Sumsub API** — End-to-end KYC, KYB, and AML platform competing directly with Jumio.
- **Stripe API** — Pair Jumio identity decisions with Stripe payments to gate funding on a passing KYC.

## FAQ

### Why is there no official OpenAPI spec for Jumio API?

Jumio does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Jumio API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Jumio API use?

The Jumio API uses bearer token authentication via the Authorization header. Tokens are issued per account using POST `/accounts/{accountId}/credentials.` Through Jentic the bearer token is held in the encrypted vault and never enters the agent context.

### Can I retrieve the captured document images for a verification?

Yes. After a workflow execution completes, GET `/retrieval/{transactionReference}` returns the verification result and image references, and GET `/retrieval/{transactionReference}/images/{imageId}` returns the binary image for archiving.

### What are the rate limits for the Jumio API?

Jumio enforces per-account rate limits that scale with your contract tier; the spec does not pin a fixed value. Production integrations typically batch retrievals and use exponential backoff on 429 responses.

### How do I start a KYC verification with the Jumio API through Jentic?

Search Jentic for 'start an identity verification', load the POST `/accounts/{accountId}/workflow-executions` operation schema, then execute with the user's accountId. Jentic returns the workflow ID you can poll until complete.

### How do I check whether a user has passed verification?

Call GET `/accounts/{accountId}/status` for the current account-level decision, or GET `/accounts/{accountId}/workflow-executions/{workflowExecutionId}` for per-execution detail including the final decision and reason codes.

### Can I limit what my agent is allowed to do with the Jumio API?

Yes. Jentic One runs self-hosted, so your own rules decide which Jumio operations and credentials the agent can use. Because Jumio carries the account id in the URL path, such as `/accounts/{accountId}/workflow-executions`, you can pin the agent to a single account and allow only starting workflow executions and reading their status with GET `/accounts/{accountId}/status.` Operations you leave out, like POST /accounts to create new verification accounts, stay unavailable to the agent until you explicitly add them.