Checking for screening hits

You can determine whether a customer has any hits after screening using different approaches, depending on whether the screening was conducted asynchronously or synchronously.

Checking for hits after asynchronous screening

Webhooks (recommended)

• Set up a webhook of type WORKFLOW_COMPLETED using the Create a Webhook API.
• Once the screening workflow completes, an update will be sent to the configured webhook URL.
• Refer to the customer-screening.step_output.screening_result field in the webhook payload to determine if any hits were found (HAS_PROFILES).

Polling

• After using the Create and Screen (Asynchronous) API, you’ll receive a workflow_instance_identifier in the response.
• Use this identifier to poll the Get Status and Result of Onboarding API.
• When the customer-screening step is complete, the customer-screening.step_output.screening_result field in the response will indicate whether any hits were found (HAS_PROFILES).

Checking for hits and AML types after synchronous screening

• For Create and Screen (Synchronous) requests, the screening result is included directly in the API response.
• Refer to the customer-screening.step_output.screening_result field to see if any hits were found (HAS_PROFILES).
• Refer to the customer-screening.step_output.aml_types to see the AML types of the hits. AML types includes:
  • SANCTION
  • ADVERSE_MEDIA
  • ADVERSE_MEDIA_V2_CYBERCRIME
  • PEP_CLASS_1
  • PEP_CLASS_2
  • WARNING