Sign in

v1

latestOpenAPI 3.0.32026-08-04404186.8 KB
Screening

Update screenings in batch

put/v2/screening

Request body

listsstring[]

The list(s) that the transaction was screened against. E.g. OFAC, ComplyAdvantage, Watchlists...

outcome'POSITIVE' | 'NEGATIVE' | 'FALSE_NEGATIVE' | 'FALSE_POSITIVE' | 'TRUE_NEGATIVE' | 'TRUE_POSITIVE' | 'SCREENED' required

The outcome of the screening check (e.g., POSITIVE, NEGATIVE, TRUE_POSITIVE, etc.). The value "SCREENED" should only be used when the outcome is not available but there is the confirmation that the screening has been done.

outcome_detailsstring

Further details on the reason of the screening outcome. For a transaction screening, it could be due to many reasons, so it could be relevant to include further details.

providerstring

The provider that performed the screening check.

related_company_idstring

Unique identifier for the related company in case of a company screening. Only one of related_tx_id, related_person_id or related_company_id should be provided.

related_person_idstring

Unique identifier for the related person in case of a person and/or transaction screening. Only one of related_tx_id, related_person_id or related_company_id should be provided.

related_tx_idstring

Unique identifier for the related transaction in case of a transaction screening. Only one of related_tx_id, related_person_id or related_company_id should be provided.

screening_idstring required

Unique identifier for the screening. This is the primary key for a screening and should be unique across screenings.

timestampstring date-time required

When the screening was performed in your system, in ISO 8601 format.

type'ADVERSE_MEDIA' | 'AML' | 'PEP' | 'SANCTION'

The type of screening check performed (e.g., SANCTION, PEP, ADVERSE_MEDIA, etc.).

Response

Screening updated successfully

messagestring required

Provides additional information about the operation result.

organization_idstring required

The organization ID for which the operation was performed.

successboolean required

Indicates if the write operation was successful.

write_countinteger required

The number of records written to the database.