For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
An array of screening update payloads. Each payload must include the ‘screening_id’ to identify the screening and can include any other fields that need to be updated. The ‘timestamp’ field represents the time of update.
screening_idstringRequired
Unique identifier for the screening. This is the primary key for a screening and should be unique across screenings.
outcomeenumRequired
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.
timestampdatetimeRequired
When the screening was performed in your system, in ISO 8601 format.
typeenumOptional
The type of screening check performed (e.g., SANCTION, PEP, ADVERSE_MEDIA, etc.).
Allowed values:
outcome_detailsstringOptional
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.
providerstringOptional
The provider that performed the screening check.
listslist of stringsOptional
The list(s) that the transaction was screened against. E.g. OFAC, ComplyAdvantage, Watchlists…
related_tx_idstringOptional
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.
related_person_idstringOptional
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_company_idstringOptional
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.
Response
Screening updated successfully
successboolean
Indicates if the write operation was successful.
write_countinteger
The number of records written to the database.
messagestring
Provides additional information about the operation result.
organization_idstring
The organization ID for which the operation was performed.
