Skip to main content

Add Bank Statement

The Add Bank Statement API allows you to upload a bank statement file for a specific customer registered in transaction monitoring. The uploaded statement is processed and linked to the customer's profile for compliance and transaction analysis.

API Endpoint

POST {base_url}/transactions/monitoring/add-bank-statement/{customerId}

Request Format

This endpoint accepts a POST request with a file uploaded via multipart form data.

Request Headers

Authorization: Bearer {token}
Content-Type: multipart/form-data

Path Parameters

ParameterTypeRequiredDescription
customerIdstring (UUID)YesUnique identifier of the customer to upload the bank statement for

Form Data Parameters

ParameterTypeRequiredDescription
filefileYesThe bank statement file to upload

Example Request URL

POST {base_url}/transactions/monitoring/add-bank-statement/372c33b0-e1e1-4e30-8928-97b9433a98ef

Response Format

{
"version": null,
"statusCode": 200,
"messages": ["Processed successfully"],
"result": {
"message": "Bank statement uploaded successfully"
}
}

Response Fields

FieldTypeDescription
versionstringAPI version (nullable)
statusCodenumberHTTP status code
messagesstring[]Response messages
resultobjectResult object
result.messagestringSuccess confirmation message

Example Usage

cURL Example

curl -X POST \
'{base_url}/transactions/monitoring/add-bank-statement/372c33b0-e1e1-4e30-8928-97b9433a98ef' \
-H 'Authorization: Bearer your_token_here' \
-F 'file=@/path/to/bank-statement.pdf'

Error Handling

Status CodeDescriptionSolution
400Invalid request or unsupported fileEnsure a valid file is provided in the form data
401UnauthorizedVerify your authentication token
403ForbiddenCheck that your account has the required permissions
404Customer not foundVerify the customer ID exists
500Internal server errorContact support with the error details