Getting started

This guide offers step-by-step instructions for integrating with the ComplyAdvantage Mesh API and addresses common use cases, including creating and screening customers, checking for hits, and viewing cases, alerts, and risks.

Setting up your environment

API authentication

To begin using the ComplyAdvantage Mesh API, you’ll need credentials provided during onboarding. Your nominated API user should have received a welcome email containing instructions for setting up their password and specifying their organization name. These credentials are used to generate an access token:

• username: The email address of the API user.
• password: The password created by the API user.
• realm: The organization name as stated in the welcome email.

{
  "username": "[email protected]",
  "password": "password",
  "realm": "organization name"
}

ℹ️

API user best practices

It is recommended to have a dedicated email address for your API user (e.g. [email protected]) and have one API user per account. This will enable you to create tokens for each account without having to switch accounts.

Setting your base URL

The API base URL for your organization depends on the region in which it was created.

You can determine your organization's region by logging in to the ComplyAdvantage Mesh web application and checking the browser's URL bar. The region displayed in the URL corresponds to the API's base URL region.

For example, if the region in your URL shows "EU", your API base URL will be:
https://api.eu.mesh.complyadvantage.com.

These are the available API base URLs in ComplyAdvantage Mesh:

ℹ️

Setting the base URL in documentation

You can configure the base URL directly in the API documentation interface when testing out API calls.

Creating a customer screening configuration

❗️

Setting up screening configurations

Screening configurations should be set up in collaboration with a compliance or risk team to ensure the appropriate screening lists are selected. These configurations can be updated at any time.

Customers are screened against pre-configured settings. Before creating and screening your first customer, you must set up a customer screening configuration. This can be done via ComplyAdvantage Mesh web ppplication or the API. You can create multiple configurations and select the appropriate one for each customer during the screening process.

Create a customer screening configuration via the web application

• Follow the steps outlined in this article.

Create a customer screening configuration via API

• Use the create screening configuration API.

ℹ️

Customer screening configuration identifier

After creating a customer screening configuration, make sure to note the configuration_identifier. This identifier is required when creating and screening customers.