Skip to content
For LLMsView as Markdown·

ComplyAdvantage ​

AML screening and ongoing monitoring with PEP, sanctions, and adverse media checks.

DetailValue
CategoryiGaming
Base URLhttps://api.complyadvantage.com
AuthenticationAPI Key
Endpoints10
Connector keycomplyadvantage

Using ComplyAdvantage in a workflow ​

  1. Go to Connections and click New Connection.
  2. Pick ComplyAdvantage from the marketplace.
  3. Enter your credentials (see Authentication above for what's expected).
  4. In a workflow, drop an API Call node and select this connection.
  5. Pick the operation you need from the Operation dropdown. The full list is below.

Available endpoints ​

EndpointSummary
POST /searchesCreate AML screening search
GET /searchesList search history
GET /searches/{id}Get search overview
GET /searches/{id}/detailsFull search results
PATCH /searches/{id}Update search
PATCH /searches/{id}/entitiesUpdate entity status
GET /searches/{id}/monitorsGet monitoring config
PATCH /searches/{id}/monitorsEnable/disable monitoring
GET /searches/{id}/monitor/differencesMonitoring alerts
GET /searches/{id}/certificateCompliance certificate

Each endpoint is documented in full below. Use the outline on the right to jump to one.

POST /searches ​

Create AML screening search

DetailValue
Operation IDaml.createSearch
MethodPOST
Path/searches

Parameters ​

No parameters.

Request Body ​

FieldType
search_termstring
fuzzinessnumber
filtersobject

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your ComplyAdvantage connection from the Connection dropdown.
  3. In the Operation dropdown, select aml.createSearch.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream ComplyAdvantage API reference.

GET /searches ​

List search history

DetailValue
Operation IDaml.listSearches
MethodGET
Path/searches

Parameters ​

No parameters.

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your ComplyAdvantage connection from the Connection dropdown.
  3. In the Operation dropdown, select aml.listSearches.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream ComplyAdvantage API reference.

GET /searches/{id} ​

Get search overview

DetailValue
Operation IDaml.getSearch
MethodGET
Path/searches/{id}

Parameters ​

NameLocationTypeRequired
idpathstringYes

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your ComplyAdvantage connection from the Connection dropdown.
  3. In the Operation dropdown, select aml.getSearch.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream ComplyAdvantage API reference.

GET /searches/{id}/details ​

Full search results

DetailValue
Operation IDaml.getSearchDetails
MethodGET
Path/searches/{id}/details

Parameters ​

NameLocationTypeRequired
idpathstringYes

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your ComplyAdvantage connection from the Connection dropdown.
  3. In the Operation dropdown, select aml.getSearchDetails.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream ComplyAdvantage API reference.

PATCH /searches/{id} ​

Update search

DetailValue
Operation IDaml.updateSearch
MethodPATCH
Path/searches/{id}

Parameters ​

NameLocationTypeRequired
idpathstringYes

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your ComplyAdvantage connection from the Connection dropdown.
  3. In the Operation dropdown, select aml.updateSearch.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream ComplyAdvantage API reference.

PATCH /searches/{id}/entities ​

Update entity status

DetailValue
Operation IDaml.updateEntityStatus
MethodPATCH
Path/searches/{id}/entities

Parameters ​

NameLocationTypeRequired
idpathstringYes

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your ComplyAdvantage connection from the Connection dropdown.
  3. In the Operation dropdown, select aml.updateEntityStatus.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream ComplyAdvantage API reference.

GET /searches/{id}/monitors ​

Get monitoring config

DetailValue
Operation IDaml.getMonitoringConfig
MethodGET
Path/searches/{id}/monitors

Parameters ​

NameLocationTypeRequired
idpathstringYes

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your ComplyAdvantage connection from the Connection dropdown.
  3. In the Operation dropdown, select aml.getMonitoringConfig.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream ComplyAdvantage API reference.

PATCH /searches/{id}/monitors ​

Enable/disable monitoring

DetailValue
Operation IDaml.updateMonitoring
MethodPATCH
Path/searches/{id}/monitors

Parameters ​

NameLocationTypeRequired
idpathstringYes

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your ComplyAdvantage connection from the Connection dropdown.
  3. In the Operation dropdown, select aml.updateMonitoring.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream ComplyAdvantage API reference.

GET /searches/{id}/monitor/differences ​

Monitoring alerts

DetailValue
Operation IDaml.getMonitoringAlerts
MethodGET
Path/searches/{id}/monitor/differences

Parameters ​

NameLocationTypeRequired
idpathstringYes

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your ComplyAdvantage connection from the Connection dropdown.
  3. In the Operation dropdown, select aml.getMonitoringAlerts.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream ComplyAdvantage API reference.

GET /searches/{id}/certificate ​

Compliance certificate

DetailValue
Operation IDaml.getComplianceCertificate
MethodGET
Path/searches/{id}/certificate

Parameters ​

NameLocationTypeRequired
idpathstringYes

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your ComplyAdvantage connection from the Connection dropdown.
  3. In the Operation dropdown, select aml.getComplianceCertificate.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream ComplyAdvantage API reference.