Transaction Data APIScreening

Update an existing transaction screening

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Transaction screening data to update, referenced by ‘screening_id’. The ‘timestamp’ field represents the update time. Only the fields to be updated need to be included.

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.
timestampstringRequiredformat: "date-time"
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.
additional_propertieslist of objectsOptional
Additional metadata that relates to a transaction screening.
listslist of stringsOptional

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

outcomestringOptional
The outcome of the screening check.
providerstringOptional
The provider that provided the screening check.
related_tx_idstringOptional
Unique identifier for a transaction as it relates to the transaction screening.
typestringOptional
The type of screening check performed.

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.
timestampstringformat: "date-time"
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.
typestring or null
The type of screening check performed.
outcomestring or null
The outcome of the screening check.
providerstring or null
The provider that provided the screening check.
listslist of strings or null

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

related_tx_idstring or null
Unique identifier for a transaction as it relates to the transaction screening.
additional_propertieslist of objects or null
Additional metadata that relates to a transaction screening.

Errors