Bank Statement Analyzers API Documentation

Version 1.0

Your API key will be available here after you sign in.

Authentication

All API requests require an API Key. Include the key in the request header:

POST /api/Api/process-bankstatement
Headers:
  X-API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
    

Upload Bank Statement

Endpoint: /api/Api/process-bankstatement

Method: POST

Content-Type: multipart/form-data

Request:

Response:

{
  "accountHolder": "John A. Doe",
  "accountNo": "123-456-789",
  "branch": "People's Trust Bank",
  "statementStartDate": "2023-07-01T00:00:00",
  "statementEndDate": "2023-07-31T00:00:00",
  "bottomMessage": String,
  "bankTransaction": [
    {
      "date": "2023-07-05",
      "description": "Salary Credit",
      "amount": 25000,
      "balance": 38000,
      "isCredit": true,
      "category": "Income"
    },
    ...
  ]
}
    

Pricing

Note: API pricing/Page Limit is the same as our subscription pricing/Page Limit.

Rate Limits

Errors

400 - Bad Request
401 - Unauthorized (Invalid API Key)
429 - Too Many Requests
500 - Internal Server Error