ComplyAdvantage is a watchlist screening provider used by Sumsub to provide real-time sanctions and watchlist screening using global lists and other governmental, law enforcement, and regulatory databases.

Get started with ComplyAdvantage Mesh

If you have a personal ComplyAdvantage account, you can use it to directly make requests to the ComplyAdvantage Mesh API:

📘

Note

You can only use a service account with API-only access to your Mesh.

1. In the Sumsub Dashboard, go to the Marketplace page and navigate to the ComplyAdvantage Mesh settings.
2. Enter the following credentials:
   • Username
   • Password
   • Realm
3. Click Save.
4. Once the settings are saved, you will see the webhook URL to copy and use in the ComplyAdvantage Mesh dashboard for the case creation event to receive ongoing updates.

Obtain data for integration

Below you will find the steps and clarifications on where to find the data needed to set up your ComplyAdvantage Mesh API integration with Sumsub.

Get Mesh Realm and credentials

Your Mesh Realm is essentially your organization's unique environment within the ComplyAdvantage platform:

• Username is the email address of your nominated API user.
• Password is the password specifically created by that API user.
• Realm is your organization's name. You can find it in the welcome email sent during your onboarding.

Create service account

To create a service account:

1. Log in to your ComplyAdvantage Mesh dashboard.
2. Navigate to Settings -> Users.
3. Invite a new user using a generic/shared email address, such as [email protected].
4. Assign this user a dedicated role with API permissions, typically located in the Roles and Permissions section.

📘

Note

ComplyAdvantage recommends using a dedicated service account rather than an individual person account for API integrations to avoid service interruptions if an employee leaves.

Set up webhook for case creation

To receive ongoing updates, such as hits from continuous monitoring, you must instruct Mesh where to send the data:

1. In the Mesh dashboard, go to the Settings menu.
2. On the left-hand sidebar, select Webhooks.
3. Click New.
4. Configure the webhook by adding the following information:
   • Name. Give it a clear name, for example, Sumsub Integration.
   • Event. Select CASE_CREATED from the drop-down menu.
   • Target URL. Paste the webhook URL you copied from the Sumsub Marketplace dashboard.
5. Click Create or Save.