Add new transaction screening(s)
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Transaction screening data to add.
screening_id
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.
timestamp
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_properties
Additional metadata that relates to a transaction screening.
lists
The list(s) that the transaction was screened against.
outcome
The outcome of the screening check.
provider
The provider that provided the screening check.
type
The type of screening check performed.
Response
Transaction screening added successfully
screening_id
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.
timestamp
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.
type
The type of screening check performed.
outcome
The outcome of the screening check.
provider
The provider that provided the screening check.
lists
The list(s) that the transaction was screened against.
additional_properties
Additional metadata that relates to a transaction screening.
Errors
400
Bad Request Error
401
Unauthorized Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
