API Reference

Rescreen a customer synchronously

post
https://api.mesh.complyadvantage.com/v2/customers//workflows/sync/rescreen

This endpoint initiates the synchronous 'rescreen' workflow for your customer. The workflow consists of two steps:

  1. Customer Rescreening: The customer is screened against the latest data sources to identify any new risk information.
  2. Alerting: If new, relevant, risks are found an alert is generated. The workflow executes synchronously, returning the workflow status and result immediately. The rescreening operation applies the rules and settings defined in the customer's monitoring configuration. If no monitoring configuration is currently assigned to the customer, the system will default to using the initial screening configuration applied when the customer was first screened. Rescreen events count towards your total onboarding search volumes You need "Account has access to monitor on demand functionality" enabled to use this endpoint.
Path Params
uuid
required

Identifier of the customer to rescreen

Query Params
string
enum
Defaults to DELTA

Specifies the screening logic to apply. Set to DELTA to perform a differential screen, which compares the new result against the customer's previous screening baseline and only alerts on new or changed risk factors.

Allowed:
Headers
string
length between 0 and 255

A unique, client-generated string that identifies a single operational attempt. You must generate a new key for every distinct operation, and use the exact same key when retrying a failed request to prevent duplication. The usage of this key is recommended to ensure safe retries without duplicate processing or billing. While any unique string is accepted, we strongly recommend using a standard UUID to guarantee global uniqueness.

Responses

Updated 30 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 30 days ago