API ReferenceCustomer SAR

Add customer sar information

Endpoint for adding new customer sar

Headers

AuthorizationstringRequired

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

AuthorizationstringRequired

Request

This endpoint expects a list of objects.
sar_idstringRequired
Unique identifier for a suspicious activity report belonging to a customer suspicious activity report. This is the primary key for a customer suspicious activity report and should be unique across all customer suspicious activity reports. Updates to a customer suspicious activity report should be made using this identifier.
timestampdatetimeRequired
Original timestamp relating to this SAR creation or update.
statusenumRequired

The status of the Suspicious Activity Report (SAR). FILED means that it has been officially filed with the appropriate regulatory agency. PENDING means that it is in the process of being filed. CANCELLED means that it is not going to be filed.

Allowed values:
sar_reasonstringOptional
The reason for filing up a SAR for this person or company
related_company_idstringOptional

Unique identifier of the related company entity (used for business contexts). At least one of related_company_id and related_person_id should be specified.

related_person_idstringOptional

Unique identifier of the related person entity (used for retail contexts or when a person is the subject). At least only one of related_person_id and related_company_id should be specified.

Response

Customer SAR added 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.

Errors