AML screening
Running AML checks
Where the checks are switched on and when they run.
Switch the checks on
AML screening is a database check inside a verification scenario. In the dashboard, open the KYC section, then the scenario editor, and in the document step find Database checks. They are shown if they are available to your account. Tick the checks you need, or select all of them. A questionnaire scenario can carry its own database checks; see two-stage questionnaire then KYC.
Scenarios are created and edited in the dashboard. The REST API works with the identifier of a scenario that already exists. See create session.
Decide from the outcome
The verdicts of database checks are not part of the body of a session. Your system reads each check separately and decides from its outcome and passed. See retrieving the result.
When the checks run
The checks run asynchronously and finish after the session itself. Your system learns that they are complete in one of two ways:
- The
DATABASE_CHECKS_COMPLETEwebhook. It is one notification with the full result set, sent once all checks of the session are terminal. It can arrive again, so handle it idempotently bysessionId. - Polling database check results every 5 to 10 seconds until
checksStatusiscomplete, and no longer than the session lifetime that you set in the scenario. See retrieving the result.
When data is missing
A check that does not get the input data it needs does not fail. It is reported with outcome of skipped, and missingInputs names what was missing. A skipped check is not billed. Supply the data and run it again.
Run again
On the Databases tab of a session card, the re-run button runs the check again. A re-run is billed as a separate request.
Billing
AML screening is billed separately from the verification. See the pricing page.
Next
Read the result: retrieving the result.