Skip to main content
Follow the steps in Get started with connectors before proceeding. Onfido access: An active test and production account, and administrator access to Onfido Studio. Workflow: Create, configure, and publish one or more workflows in Onfido Studio before you start an identity verification. Network connectivity: Confirm routing between the Onfido environments and Banking OS Connectivity. For supported options, see Network connectivity. Sync Hub: A Sync Hub consumer subscription if a downstream consumer receives identity verification results. For more information, see Sync Hub overview. Environment details: You need the following environment details from Onfido:

​
Prepare the connector

Backbase deploys this connector. To share connectivity details and provide the environment details, follow these steps:
  1. Share connectivity details. Share connectivity details between Banking OS and Onfido as described in Network connectivity.
  2. Send environment details to Backbase. Send onfido.baseUrl and onfidoapitoken to your Backbase support team.
  3. Register the webhook in Onfido Studio. Ask your Backbase support team for the callback URL, then register that URL in Onfido Studio.
  4. Choose how results are delivered. Tell your Backbase support team which notification.mode to use. The default is SYNC. Use EVENT when a Sync Hub consumer receives the result. Use SYNC when an Engagement Banking Platform journey still expects a synchronous callback. Use BOTH during migration so both receive the workflow result. When the mode is EVENT or BOTH, configure your consumer to subscribe to the Sync Hub topic identity-verification and to parse the CloudEvent type com.backbase.party.lifecycle.event.spec.v1.IdentityVerificationEvent. For the data payload fields, see Reference.
For property names and defaults, see Reference.

​
Test your integration

To use the Party Lifecycle Unified API, include your Banking OS subscription key in the request header. If you do not have a key, contact your Backbase support team to request one. Test the API using the Postman collection.

​
Troubleshooting

If your connector does not respond as expected, check these common scenarios.
Cause: The Banking OS gateway cannot establish a handshake with the Onfido endpoint. This typically indicates an upstream service outage at Onfido or a network routing failure.Solution: Verify the operational status of the Onfido environment with Onfido.
Cause: The request to Onfido exceeded the configured timeout threshold. This can occur during high load or network latency issues.Solution: Verify the operational status of the Onfido environment with Onfido.
Cause: You entered incorrect credentials during setup.Solution: Verify your credentials with Onfido and contact the GC team to update the connection.
Cause: The number of incoming requests exceeded the defined threshold for your subscription tier. This response protects the stability of the Banking OS and partner infrastructure.Solution: Review your application request patterns to identify unexpected spikes. If you require higher throughput, contact your Backbase support team to request an adjustment to your Azure API Management (APIM) rate limit policy.
Cause: You haven’t registered the Onfido webhook, or inbound signature validation failed. Another possible cause is that notification.mode isn’t EVENT or BOTH, Sync Hub publishing isn’t enabled, or your consumer doesn’t subscribe to the identity-verification topic.Solution: Confirm Onfido delivers workflow_run.completed to the Banking OS inbound URL. Confirm APIM injects the webhook token used for hash-based message authentication code (HMAC) verification. Verify Sync Hub publishing is enabled, notification.mode is set correctly, and your consumer subscription is active.