Skip to main content
The Jumio integration verifies customer identities through document and biometric checks. It creates or updates Jumio accounts, starts verification workflows, and returns the identity verification (IDV) outcome. For the environment details you send to Backbase, see Get started with Jumio.

Configuration properties

Backbase sets these properties when it deploys the Jumio Connector.

Values to obtain from the vendor

Obtain the following values from Jumio and send them to your Backbase support team. The following table lists the region-specific Jumio API base URLs.

Connector settings

The following table lists the other Jumio Connector properties.

Supported operations

The Jumio Connector supports the following operations. For the full contract, see the API playground.

User creation and workflow initiation

  • Create or update a Jumio account and start the relevant workflow
  • Unified API: POST /applicant-workflows
  • Include personName, userData.identification, userData.templateId, and userData.customerRelationship. The connector maps userData.identification to the Jumio customerInternalReference.
  • Use userData.customerRelationship to route the journey:
    • false for an NTB journey: create a Jumio account and start full identity verification. Don’t send userData.applicantId.
    • true for an existing-to-bank (ETB) journey: update a Jumio account for biometric reauthentication. Include userData.applicantId.
  • Map a Banking OS templateId to the Jumio workflow key with the optional jumio.template.key.<templateId> configuration property. When you don’t set that property, the connector sends templateId as the workflow key.
  • The response includes clientLaunchUrl for the Jumio browser experience, plus sessionId, applicantId, and sdkToken.

Required request fields

The following table lists the fields that the connector requires on POST /applicant-workflows requests. If a value is missing or inconsistent, the connector returns error GC025 with HTTP status 400.

Workflow results (pull)

  • Get the IDV process outcome and the decision metadata for the workflow
  • Unified API: POST /workflow-result
  • For Jumio, provide sessionId (Jumio workflow execution ID) and applicantId (Jumio account ID). Jumio doesn’t use sdkToken on this call.
  • The response uses the Unified API workflowResults schema and includes Jumio-native capability detail under vendorSpecificFields.jumio. Sync Hub also publishes a separate identity verification event. The data object of that event reuses the same mapped result shape.

Status and decision mapping

Jumio workflow.status and decision.type values map to Banking OS status and decision.value as follows: The response includes Jumio capability payloads under vendorSpecificFields.jumio, for example extraction, classification, similarity, liveness, usability, authentication, and ekycCheck. The raw Jumio retrieval response is available as rawVendorResponse.

Events

Synchronous operations (create applicant workflow, get workflow result) return their result in the API response. Jumio raises identity verification results asynchronously. When Jumio sends an inbound callback, the inbound connector validates the payload. When the callback status is PROCESSED, the connector retrieves the workflow result from Jumio, maps it with the same rules as POST /workflow-result, and publishes an identity verification event to Sync Hub for downstream consumers. The following table maps the Jumio callback trigger to the Sync Hub topic, CloudEvent type, and connector action: The connector acknowledges non-terminal callback statuses without retrieval or Sync Hub publication. The Sync Hub data object follows the identity verification event schema. It includes workflow status, applicant identifiers, decision metadata, and Jumio-specific fields under vendorSpecificFields.jumio where applicable. Consumers receive identity verification events by subscribing to the Sync Hub topic configured for your environment. For setup, see Sync Hub overview and Get started with Jumio.

Error mapping

For the full list of Banking OS error codes and their descriptions, see Error codes. Jumio request validation uses the error code GC025 with HTTP status 400. The connector returns GC025 when userData.customerRelationship, userData.identification, or userData.templateId is missing. It also returns GC025 when userData.applicantId is present for an NTB journey (customerRelationship is false). It returns GC025 when userData.applicantId is missing for an ETB journey (customerRelationship is true). The following table maps Jumio HTTP error responses to Banking OS error codes. The connector maps any other Jumio HTTP error to GC025. For these mapped Jumio errors, the HTTP status that the connector returns comes from the Banking OS error code catalog.

Dependencies

The Jumio Connector depends on the following systems:
  • The Jumio Accounts API, to create and update accounts
  • The Jumio Retrieval API, to retrieve workflow results
  • Sync Hub, to publish identity verification events on the identity-verification topic
For more information, see Sync Hub overview.