Sign in

v1

latestOpenAPI 3.0.02026-07-2494288373.8 KB
AML check

Review AML hits

Confirm or ignore the AML hits of a check. The Reviewer type will be set to api.

See also

Learn more about Aml checks

patch/v1/checks/aml/{id}/hits/review

Path parameters

idstring uuid required

Id of the AML check

Request body

action'confirm' | 'ignore' required
commentstring

Optional comment for the review.

hit_idsstring[] required

Array of the ids of the AML hits to review. Maximum of 100 hits per batch.

Response

ℹ️ Click to see full payload

idstring uuid required
company_idstring uuid nullable required
individual_idstring uuid nullable required
is_internalboolean required
status'in_progress' | 'need_review' | 'processing' | 'approved' | 'rejected' | 'expired' required

ℹ️ Check status expired is deprecated and will be removed Q1'25. It will be replaced with an expired flag.

type'aml' required
subtypestring nullable required

Currently always null for aml Check

last_activity_atstring date-time required

Latest activity date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)