Bank Statement Converter

API Documentation

Postman Collection

Upload a statement


Method: POST
URL: https://api2.bankstatementconverter.com/api/v1/BankStatement
Headers: { Authorization: LOGIN_TO_SEE_API_KEY
Body: Multipart Form Data
        

Response

[
  {
    "uui": "bb2f3c62-331e-42ee-a931-d25a5ee0946f",
    "filename": "bankstatement.pdf",
    "pdfType": "TEXT_BASED",
    "state": "READY"
  }
]

Convert a statement


Method: POST
URL: https://api2.bankstatementconverter.com/api/v1/BankStatement/convert?format=JSON
Headers: { Authorization: LOGIN_TO_SEE_API_KEY
Body: A list of UUID strings in JSON. The UUID comes from the response of the Upload PDF API.
        

Body

A list of UUID strings in JSON. The UUID comes from the response of the Upload PDF API.

Response

[{
  "raw": [
    {
      "date": "03/08/20",
      "description": "Monthly Service Fee",
      "credit": null,
      "debit": "5.00",
      "balance": "777.07",
      "amount": null,
      "charge": null
    }
  ],
  "normalised": [
    {
      "date": "03/08/20",
      "description": "Monthly Service Fee",
      "amount": "-5.00"
    }
  ]
}]

Provide a password for uploaded PDFs

This API is only needed if the PDFs you uploaded have passwords.


Method: POST
URL: https://api2.bankstatementconverter.com/api/v1/BankStatement/setPassword
Headers: { Authorization: LOGIN_TO_SEE_API_KEY
Body: A list of uuids and passwords 
        

Body

{
  "passwords": [
    { "uuid": "b0df4b60-1ab7-4edf-bf87-4664f91a67b7", "password": "elephant" }
  ]
}

Response

[
    {
        "uuid": "b0df4b60-1ab7-4edf-bf87-4664f91a67b7",
        "filename": "locked.pdf",
        "pdfType": "TEXT_BASED",
        "state": "READY",
        "numberOfPages": 3
    }
]