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
| Parameter | Type | Required | Description |
|---|---|---|---|
customerId | string (UUID) | Yes | Unique identifier of the customer to upload the bank statement for |
Form Data Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
file | file | Yes | The 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
| Field | Type | Description |
|---|---|---|
version | string | API version (nullable) |
statusCode | number | HTTP status code |
messages | string[] | Response messages |
result | object | Result object |
result.message | string | Success 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 Code | Description | Solution |
|---|---|---|
| 400 | Invalid request or unsupported file | Ensure a valid file is provided in the form data |
| 401 | Unauthorized | Verify your authentication token |
| 403 | Forbidden | Check that your account has the required permissions |
| 404 | Customer not found | Verify the customer ID exists |
| 500 | Internal server error | Contact support with the error details |
Related Resources
- Customer Details — Retrieve the full profile of a specific customer
- Add User — Register an individual for transaction monitoring
- Add Company — Register a company for transaction monitoring
- Onboarding Pending — View pending onboarding customers