Skip to main content
The Onfido integration verifies customer identities through document and biometric checks, creating users, starting verification workflows, and returning the identity verification (IDV) outcome. For the environment details you send to Backbase, see Get started.

​
Supported operations

The Onfido connector supports the following operations.

​
User creation and workflow initiation

  • Create a user ID
  • Initiate relevant workflow

​
Workflow results (Pull)

  • Get IDV process outcome
  • Get all data points details associated to the decision
  • Unified API: POST /workflow-result
  • The response uses the Unified API workflowResults schema. Sync Hub publishes a separate identity verification event data object.

​
Document download

  • Download all documents generated during the IDV process (for example, IDV process reports, face scan movie, and document scan images)

​
Events

Synchronous operations (create applicant workflow, get workflow result, download document) return their result in the API response. Onfido raises identity verification results asynchronously. When Onfido sends an inbound webhook event (workflow_run.completed), the inbound connector validates the signature and payload and transforms the result. The connector publishes an identity verification event to Sync Hub for downstream consumers when the notification.mode configuration property is EVENT or BOTH. The following table maps the Onfido webhook event to the Sync Hub topic, CloudEvent type, and connector action: The Sync Hub data object follows the identity verification event schema. It includes workflow status, applicant identifiers under partyInformation, decision metadata, and the raw Onfido webhook as data.rawVendorResponse. The IPA callback includes vendor-specific Onfido fields under vendorSpecificFields.onfido. The notification.mode configuration property defaults to SYNC. The following table shows the destination and webhook acknowledgment for each value: When the notification.mode configuration property is EVENT or BOTH, 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.

​
Error mapping

For the full list of Banking OS error codes and their descriptions, see Error codes. The following table maps each Onfido error code to its Banking OS counterpart: