post
https://api.mesh.complyadvantage.com/v2/workflows/sync/create-and-screen
This endpoint initiates the 'create and screen' workflow for your customer in synchronous mode. The workflow consists of five steps:
- Customer Record Creation: The Customer Record is created in Mesh.
- Risk Scoring: An initial Risk Score is calculated for the Customer.
- Customer Screening: The Customer is screened using settings based on the Calculated Risk Score.
- Alerts: Alerts associated with the screened customer are generated based on the risk analysis.
- Case Creation: Create cases based on the result of customer screening and alerts, for an analyst to review. Each customer must have a unique customer external identifier specified as part of the request. This identifier is used to find the customer within Mesh and link back to your own internal systems. The customer can be one of:
PERSON,COMPANY, `` orUNDEFINEDand can optionally have multipleproducts. Following risk scoring, the customer will be screened using ComplyAdvantage's AML database. You can specify the screening profile used for initial screening and subsequent ongoing monitoring within theconfigurationobject. The value forscreening_profile_identifiercan be found in the settings section of the Mesh application. The workflow executes synchronously up to customer screening, returning the workflow status. This end-point is currently idempotent: in case of downstream error you can re-send the exact same request, and the workflow will be retried. To screen an entity:
- Exactly one of
full_nameorlast_namemust be provided (not both, not neither). - When using
last_name:title,first_name,middle_name,last_name,fathers_name,mothers_name, andsuffixare optional. - When using
full_name:title,first_name,middle_name,last_name,fathers_name,mothers_name, andsuffixmust all be omitted. By default, the screen customer request is done synchronously only until the screening workflow step and returns hit/no hits instep_details.customer-screening.step_output.screening_result.last_sync_stepquery parameter can be set toALERTINGto additionally wait for the alerting workflow step. The advantage of this option is that alert identifiers are included in the response instep_details.alerting.step_output.alerts[].identifier. You need "Access to base customer screening functionality" enabled and the "Create and screen customers" permission to use this endpoint.