Sign in

v1

latestOpenAPI 3.0.32026-08-04404186.8 KB
CustomerSAR

Add customer sar information

Endpoint for adding new customer sar

post/v2/customer_sar

Request body

related_company_idstring

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_idstring

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.

sar_idstring required

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.

sar_reasonstring

The reason for filing up a SAR for this person or company

status'PENDING' | 'FILED' | 'CANCELLED' required

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.

timestampstring date-time required

When this SAR was filed or updated in your system, in ISO 8601 format.

Example request

[
  {
    "related_company_id": "company-id-12345",
    "related_person_id": "person-id-56789"
  }
]

Response

Customer SAR added successfully

messagestring required

Provides additional information about the operation result.

organization_idstring required

The organization ID for which the operation was performed.

successboolean required

Indicates if the write operation was successful.

write_countinteger required

The number of records written to the database.