This endpoint initiates the 'screen customer' workflow for an existing customer in asynchronous mode. The workflow consists of four steps:
- Customer Update: The Customer Record in Mesh is updated with the screening configuration and, when provided, the monitoring settings from the request.
- Customer Screening: The Customer is screened using the screening configuration from the request.
- Alerts: Alerts associated with the screened customer are generated based on the screening results.
- Case Creation: Cases are created from the screening results and alerts for an analyst to review.
The customer must already exist in Mesh; the request is rejected with a 404 otherwise.
This endpoint performs a customer's first screening. The request is rejected with a 409 when the customer has already been screened, or when a screening of the customer is still in progress. To screen an already-screened customer again, use POST /v2/customers/{customer_identifier}/workflows/sync/rescreen.
The configuration object must specify the screening_configuration_identifier used to screen the customer. The value can be found in the settings section of the Mesh application.
The optional monitoring.entity_screening object updates the customer's monitoring: enabled: true monitors the customer, enabled: false unmonitors them, and configuration_identifier sets the monitoring configuration. Any field left unset keeps the customer's current value. When a monitored customer has no monitoring configuration, ongoing monitoring uses the customer's screening configuration.
To update the customer's monitoring, you also need "Access to base customer monitoring functionality" enabled and the "Monitor and unmonitor customers" permission.
The workflow will execute asynchronously. The initial POST returns a workflow_instance_identifier. To find out when the workflow completes, poll GET /v2/workflows/{workflow_instance_identifier}.
You need "Access to base customer screening functionality" enabled and the "Create and screen customers" permission to use this endpoint.