> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ComplyAdvantage

> How to set up the ComplyAdvantage connector, plus the actions that are available.

![ComplyAdvantage](https://stackone-logos.com/api/complyadvantage/filled/svg)

Betav0.1.0[See changelog](https://docs.stackone.com/connectors/complyadvantage/changelog.md)

[65 actions](#actions) · 2 auth methods

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Credentials · Connector Profile](https://docs.stackone.com/connectors/complyadvantage/guides/connector-profile/api-credentials.md)
>
> Recommended by ComplyAdvantage. Uses an access key and secret created in Mesh, exchanged for a 24-hour bearer token that...

> [card] [Username and Password · Connector Profile](https://docs.stackone.com/connectors/complyadvantage/guides/connector-profile/username-and-password.md)
>
> Legacy method that ComplyAdvantage still fully supports. Exchanges an API user's username, password and the realm assign...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Credentials · Link Account](https://docs.stackone.com/connectors/complyadvantage/guides/link-account/api-credentials.md)

> [card] [Username and Password · Link Account](https://docs.stackone.com/connectors/complyadvantage/guides/link-account/username-and-password.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Credentials

Username and Password

No auth methods found

65 actions

ActionDescription

Get My Account`complyadvantage_get_my_account`

Retrieve the Mesh account the current credentials belong to, including its metadata

List My Account Users`complyadvantage_list_my_account_users`

List the users in the current Mesh account, including the user identifiers used to assign cases

Create User`complyadvantage_create_user`

Create a user in the current Mesh account with a name, email and active status

List My Accounts`complyadvantage_list_my_accounts`

List the Mesh accounts the signed-in user can access, including each account's identifier and name; cannot be used with...

List Alert Risks`complyadvantage_list_alert_risks`

List the screening risks (potential matches) within an alert

Update Risk Status`complyadvantage_update_risk_status`

Record a review decision on a screening risk within an alert, such as true positive or false positive

Transition Alert`complyadvantage_transition_alert`

Move a screening alert to a new state, such as in review or resolved

List Risk Notes`complyadvantage_list_risk_notes`

List the notes recorded on a screening risk

Create Risk Note`complyadvantage_create_risk_note`

Add a note to a screening risk

List Alert Mutes`complyadvantage_list_alert_mutes`

List alert mutes that suppress repeat alerts for a risk on an account or entity

Create Alert Mute`complyadvantage_create_alert_mute`

Mute future alerts for a specific risk signal on an entity so the same match is not re-raised

Delete Alert Mute`complyadvantage_delete_alert_mute`

Remove an alert mute so alerts for that risk signal are raised again

Get Risk`complyadvantage_get_risk`

Retrieve the full detail of an entity screening risk, including the matched profile's names, locations, documents and re...

List Risk Indicators`complyadvantage_list_risk_indicators`

List the risk indicators of one type (for example sanctions or adverse media) on a screening risk's matched profile

List Risk Entity Properties`complyadvantage_list_risk_entity_properties`

List one property (for example names or addresses) of the entity profile matched by a screening risk

List Cases`complyadvantage_list_cases`

List compliance cases in the account, filtered by state, type, assignee, customer, risk type or creation date

Bulk Assign Cases`complyadvantage_bulk_assign_cases`

Assign every case matching a query to one user in a single bulk action

Bulk Create Case Notes`complyadvantage_bulk_create_case_notes`

Leave a note on multiple cases in bulk (the provider's 'Leave a note on multiple cases in bulk' operation), applying the...

Bulk Transition Cases`complyadvantage_bulk_transition_cases`

Move every case matching a query to a new state or workflow stage in a single bulk action

Get Case`complyadvantage_get_case`

Retrieve one compliance case with its state, stage, assignee, customer and alert summary

List Case Alerts`complyadvantage_list_case_alerts`

List the screening alerts raised within a case, optionally filtered by alert state

List Alert Notes`complyadvantage_list_alert_notes`

List the notes recorded on an alert within a case

Create Alert Note`complyadvantage_create_alert_note`

Leave a note on an alert within a case (the provider's 'Leave a note on an alert' operation)

Assign Case`complyadvantage_assign_case`

Assign a compliance case to a user

List Case Notes`complyadvantage_list_case_notes`

List the notes recorded on a compliance case

Create Case Note`complyadvantage_create_case_note`

Leave a note on a compliance case (the provider's 'Leave a note on a case' operation)

List Case Subjects`complyadvantage_list_case_subjects`

List the subjects (customers or counterparties) a compliance case relates to

Transition Case`complyadvantage_transition_case`

Move a compliance case to a new state or workflow stage, with an optional note

List Case Workflows`complyadvantage_list_case_workflows`

List the case workflows configured in the account, including their stages and the stage identifiers used to transition c...

Get Case Workflow`complyadvantage_get_case_workflow`

Retrieve one case workflow with its stages, transitions and current version

Update Case Workflow`complyadvantage_update_case_workflow`

Replace a case workflow definition, creating a new workflow version

Get Case Workflow Version`complyadvantage_get_case_workflow_version`

Retrieve a specific saved version of a case workflow

List Customer Custom Fields`complyadvantage_list_customer_custom_fields`

List the custom fields defined for customer records in the account

Create Customer Custom Field`complyadvantage_create_customer_custom_field`

Define a new custom field for customer records

Update Customer Custom Field`complyadvantage_update_customer_custom_field`

Update the definition of an existing customer custom field

List Customers`complyadvantage_list_customers`

List customers in the account, filtered by name, type, risk level, status, monitoring, labels or dates

List Acquisition Sources`complyadvantage_list_acquisition_sources`

List the customer acquisition sources used in the account, optionally filtered by search text

Get Customer`complyadvantage_get_customer`

Retrieve a customer's full record, including profile details, risk level, status and screening state

List Customer Cases`complyadvantage_list_customer_cases`

List the compliance cases associated with one customer

Get Customer Monitoring`complyadvantage_get_customer_monitoring`

Get whether ongoing screening monitoring is enabled for a customer

Update Customer Monitoring`complyadvantage_update_customer_monitoring`

Turn ongoing screening monitoring on or off for a customer

List Customer Notes`complyadvantage_list_customer_notes`

List the notes recorded on a customer

Create Customer Note`complyadvantage_create_customer_note`

Record a free-text note on a customer profile for audit and review context

List Customer Products`complyadvantage_list_customer_products`

List the latest product information recorded for a customer

Create Customer Report`complyadvantage_create_customer_report`

Generate a screening certificate for a customer (the provider's 'Generate a screening certificate for a specific custome...

Get Customer Risk Score`complyadvantage_get_customer_risk_score`

Get a customer's current risk score, level and the factors that produced it

Update Customer Risk Score`complyadvantage_update_customer_risk_score`

Override a customer's risk score level with a required override reason (the provider's 'Override customer's risk score l...

Transition Customer Status`complyadvantage_transition_customer_status`

Change a customer's status to ACTIVE or CLOSED, with a required note explaining the change

Screen Customer`complyadvantage_screen_customer`

Screen an existing customer asynchronously against a screening configuration, returning a workflow identifier to poll

Rescreen Customer (Sync)`complyadvantage_rescreen_customer_sync`

Rescreen an existing customer synchronously and return the result

Update And Rescore Customer (Sync)`complyadvantage_update_and_rescore_customer_sync`

Update a customer's details or products and recalculate their risk score synchronously

Update And Rescore Customer`complyadvantage_update_and_rescore_customer`

Update a customer's details or products and recalculate their risk score asynchronously, returning a workflow identifier

List Customer Labels`complyadvantage_list_customer_labels`

List the labels attached to a customer

Update Customer Labels`complyadvantage_update_customer_labels`

Set the labels for a customer, replacing any existing labels (the provider's 'Set labels for a customer' operation)

List Labels`complyadvantage_list_labels`

List the customer labels defined in the account

Create Labels`complyadvantage_create_labels`

Create one or more customer labels in the account

Rename Label`complyadvantage_rename_label`

Rename an existing customer label

Create And Screen Customer`complyadvantage_create_and_screen_customer`

Create a customer and start screening, risk scoring and case creation asynchronously, returning a workflow identifier to...

Create And Screen Customer (Sync)`complyadvantage_create_and_screen_customer_sync`

Create a customer and run screening, risk scoring and case creation synchronously, returning the workflow result

Get Workflow`complyadvantage_get_workflow`

Get the status and outcome of a create-and-screen, screen or update workflow

List Screening Configurations`complyadvantage_list_screening_configurations`

List the customer screening configurations in the account, with the identifiers needed to create and screen customers

Create Screening Configuration`complyadvantage_create_screening_configuration`

Create a customer screening configuration defining which sanctions, PEP, watchlist and adverse media checks run and how\...

Update Screening Configuration`complyadvantage_update_screening_configuration`

Replace a customer screening configuration with new settings, creating a new configuration version

List Screening Configuration Versions`complyadvantage_list_screening_configuration_versions`

List every saved version of a customer screening configuration

Get Screening Configuration Version`complyadvantage_get_screening_configuration_version`

Retrieve the settings of one specific version of a customer screening configuration


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.