Skip to main content
Before you configure the connector, ensure you have the following credentials and connectivity in place:
  • You have completed the steps in the Get started.
  • You have an active contract with ComplyAdvantage and your own accounts and credentials for their test and production services.
  • You have a Sync Hub consumer subscription if you need monitoring alerts delivered to a downstream consumer. See Sync Hub overview.

​
Configuration guide

Follow these steps to initialize and authorize your ComplyAdvantage Connector.

​
Step 1: Establish connectivity

  1. Set your APIM subscription key in the header as follows:
    • Key: api-key
    • Value: <your subscription key>
  2. Contact the Grand Central team to set up a connection with ComplyAdvantage. Provide the following details for OAuth token generation:
    • comply-advantage-username
    • comply-advantage-password
    • comply-advantage-realm

​
Step 2: Configure environment variables

  1. Configure the base URL in the gc-applications-live repository in the connector’s values.yaml file:
Sample application.properties file:
The following example shows the location of the connector’s values.yaml file:

​
Step 3: Configure monitoring event delivery 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 Grand Central inbound webhook URL on your Mesh tenant so Mesh can deliver CASE_CREATED and CASE_ALERT_LIST_UPDATED events to the connector.
  2. Contact the Grand Central 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 does not return monitoring case identifiers. Monitoring remediation and alert delivery rely on Mesh inbound webhooks to the connector and Sync Hub publication to consumers.

​
Test your integration

To use the Party Lifecycle Unified API, include your Grand Central subscription key in the request header. If you don’t have a key, contact the Grand Central 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 Grand Central 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. If the service is operational, contact the GC Support team.
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. If the service is operational, contact the GC Support team to review timeout configurations.
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 Grand Central and partner infrastructure.Solution: Review your app’s request patterns to identify unexpected spikes. If you require higher throughput, contact the Grand Central 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. Contact GC Support if events don’t appear on Sync Hub after successful connector processing.

​
Need more help?

Contact support

Reach out to the Grand Central team for assistance with environment setup or rate limit increases.