Update an existing transaction screening

PUT

Headers

Auth
AuthorizationstringRequired

Request

This endpoint expects an object.
screening_idstringRequired

Unique identifier for a transaction screening. This is the primary key for a screening and should be unique across all transaction screenings. Updates to a transaction screening should be made using this identifier.

timestampdatetimeRequired

The time of the transaction screening. This should be in ISO 8601 format. When adding a new transaction screening, this field represents the creation time. When updating a transaction screening, this represents the time of the update.

typestringOptional

The type of screening check performed.

outcomestringOptional

The outcome of the screening check.

providerstringOptional

The provider that provided the screening check.

listslist of stringsOptional

The list(s) that the transaction was screened against.

related_tx_idstringOptional

Unique identifier for a transaction as it relates to the transaction screening.

additional_propertieslist of objectsOptional

Additional metadata that relates to a transaction screening.

Response

Transaction screening updated successfully

screening_idstring

Unique identifier for a transaction screening. This is the primary key for a screening and should be unique across all transaction screenings. Updates to a transaction screening should be made using this identifier.

timestampdatetime

The time of the transaction screening. This should be in ISO 8601 format. When adding a new transaction screening, this field represents the creation time. When updating a transaction screening, this represents the time of the update.

typestringOptional

The type of screening check performed.

outcomestringOptional

The outcome of the screening check.

providerstringOptional

The provider that provided the screening check.

listslist of stringsOptional

The list(s) that the transaction was screened against.

related_tx_idstringOptional

Unique identifier for a transaction as it relates to the transaction screening.

additional_propertieslist of objectsOptional

Additional metadata that relates to a transaction screening.