For AI agents: visit https://docs.mesh.complyadvantage.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Getting started with your ComplyAdvantage Mesh API integration
Getting Started
Getting started with your ComplyAdvantage Mesh API integration
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 a set of API credentials. These can be generated in the ComplyAdvantage Mesh web application under Settings > Access Management > API Credentials, where you can also configure their permissions and optional expiry date.
API access to Mesh uses the OAuth2 client credentials flow. Your API credentials consist of an access key and secret, which are used to generate an access token:
access_key: The access key identifying your API credential.
secret: The randomly generated secret associated with your API credential.
It is recommended to create a dedicated set of API credentials per integration, rather than sharing credentials across multiple integrations. This makes it easier to manage permissions and revoke access independently if needed.
The legacy username/password/realm authentication flow (/v2/token) remains supported for existing integrations, but new integrations should use API credentials with the /v3/token endpoint.
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 application 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
After creating a customer screening configuration, make sure to note the configuration_identifier. This identifier is required when creating and screening customers.
