Skip to main content
Follow the steps in Get started with connectors before proceeding. ComplyAdvantage access: An active contract with ComplyAdvantage, with accounts and credentials for test and production services. Sync Hub: A Sync Hub consumer subscription if you need monitoring alerts delivered to a downstream consumer. For more information, see Sync Hub overview.

​
Prepare the connector

Backbase deploys this connector. To provide the environment details, follow these steps:
  1. Send environment details to Backbase. Send comply-advantage-username, comply-advantage-password, comply-advantage-realm, and the ComplyAdvantage base URL to your Backbase support team.
  2. Deliver monitoring events through Sync Hub. The connector publishes monitoring alerts to Sync Hub after it hydrates Mesh webhook events. To deliver ongoing monitoring alerts to your consumer:
    1. Work with ComplyAdvantage to register the Banking OS inbound webhook URL on your Mesh tenant so Mesh can deliver CASE_CREATED and CASE_ALERT_LIST_UPDATED events to the connector. Ask your Backbase support team for that URL.
    2. Contact your Backbase support team to enable Sync Hub publishing for ComplyAdvantage monitoring events in your environment.
    3. Configure your consumer to subscribe to the Sync Hub topic for AML monitoring events. Confirm it parses data.eventType values CASE_CREATED and CASE_ALERT_LIST_UPDATED. The data payload aligns with the customer-screening-response schema where fields overlap. CASE_CREATED events may not include hydrated screeningAlerts.
Sync screening with last_sync_step=SCREENING doesn’t return monitoring case identifiers. Monitoring remediation and alert delivery rely on Mesh inbound webhooks to the connector and Sync Hub publication to consumers.
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 don’t have a key, contact your Backbase support team to have one provisioned. Test the API using the Postman collection.

​
Remediation flow

After a MATCH screening response, test the sequential remediation path:
  1. POST /screening-assessment/match-profiles/dispositions with disposition = FALSE_POSITIVE
  2. POST /screening-assessment/match-profiles/suppression to suppress the profile on the false-positive path

​
Troubleshooting

If your connector isn’t responding as expected, check these common scenarios.
Cause: The Banking OS gateway cannot establish a handshake with the ComplyAdvantage endpoint. This typically indicates an upstream service outage at ComplyAdvantage or a network routing failure.Solution: Verify the operational status of the ComplyAdvantage environment with ComplyAdvantage.
Cause: The request to ComplyAdvantage exceeded the configured timeout threshold. This can occur during periods of high load or network latency.Solution: Verify the operational status of the ComplyAdvantage environment with ComplyAdvantage.
Cause: The credentials provided during setup are incorrect.Solution: Verify your credentials with ComplyAdvantage 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 app’s request patterns to identify unexpected spikes. If you require higher throughput, contact your Backbase support team to request an adjustment to your APIM rate limit policy.
Cause: You have not registered the Mesh webhook, inbound signature validation failed, alert hydration failed after the inbound event, or your consumer does not subscribe to the correct Sync Hub topic.Solution: Confirm Mesh delivers to the GC inbound URL and check connector logs for GET-risks hydration errors. Verify Sync Hub publishing is enabled and your consumer subscription is active.