Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Jumio Callback / Webhook

Server-to-server callback delivering verification results. Jumio POSTs the final decision and metadata to a customer-configured URL once a transaction reaches a terminal state. Customers verify the source via mutual TLS or signed payload.

Jumio Callback / Webhook is one of 14 APIs that Jumio publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include Webhooks, Callbacks, and Events. The published artifact set on APIs.io includes API documentation and an AsyncAPI specification.

This event API exposes 1 operation across 1 channel, and defines 8 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.0.

The API connects through 3 servers: {callbackUrl} (https), {callbackUrl} (https), {callbackUrl} (https).

1 operations 1 channels 8 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0.0
Base URL
customer-configured
Resource Areas
1

Channels & Operations 1

Across 1 channel, the API surfaces 1 operation. Each is listed below with its action, channel, parameters, and response codes.

Channels 1
SUB
workflow-execution-callback
Receive a Jumio workflow-execution callback.
receiveWorkflowExecutionCallback body

Messages & Schemas 8

The contract defines 8 schemas that model the data carried by its messages. The most detailed are WorkflowExecution (4 properties), WorkflowCallback (4 properties), Account (2 properties). Each schema is shown below with its type and property counts.

WorkflowExecutionProcessed
message
Workflow execution has been fully processed by Jumio. The final decision and per-capability results can be retrieved from workflowExecution.href via the Retrie…
WorkflowExecutionAcquisitionStarted
message
End-user has begun the document / selfie acquisition flow inside the Jumio-hosted UI or SDK.
WorkflowExecutionAcquired
message
All required artifacts have been acquired from the end user. Jumio is now processing them; a PROCESSED callback will follow.
WorkflowExecutionSessionExpired
message
The end-user session expired before the workflow could be finalized. The workflow will not be executed further.
WorkflowExecutionTokenExpired
message
The bearer token issued at account creation / update expired before the workflow could be finalized.
WorkflowCallback
object
Documented root payload of a Jumio KYX workflow callback. POSTed as application/json to the customer-configured callback URL.
4 properties 3 required
WorkflowExecution
object
Workflow-execution metadata included in every callback.
4 properties 4 required
Account
object
Jumio account reference for the workflow execution.
2 properties 2 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

jumio-callback-asyncapi.yml Raw ↑

Other APIs Jumio publishes across the network.

Jumio ID Verification API
Jumio Document Verification API
Jumio Authentication API
Jumio selfie.DONE API
Jumio Screening API (AML / Watchlist)
Jumio Risk Signals API
Jumio Retrieval API
Jumio Web SDK
Jumio Mobile SDK (iOS)
Jumio Mobile SDK (Android)
Jumio React Native Plugin
Jumio Flutter Plugin