Sign in

v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
EndUserIntegrations

Upload PDF

Upload encoded PDF of transactions for a specified end user to translate into Heron Data format

post/api/end_users/{end_user_id_or_heron_id}/pdfs/v1

Path parameters

end_user_id_or_heron_idstring required

The end_user_id or heron_id of EndUser to upload

Request body

account_idstring nullable

Unique ID for account associated with PDF

currency'USD' | 'GBP' | 'null' nullable

ISO 4217 currency code for transactions in account. We currently only support GBP and USD PDFs

filenamestring nullable

The filename of the PDF

is_splitboolean nullable

Whether the file has been manually split

parent_file_heron_idstring nullable

The Heron ID of the parent file, if this PDF is a split from another file

pdf_base64string required

The base64 encoded string of the PDF file. If using Javascript, this is directly the output of the FileReader.readAsDataURL() output.

read_us_datesboolean nullable

True if date formats in the statement are US: month/date/year

reference_idstring nullable

An optional field for your unique identifier for the PDF

Example request

{
  "account_id": "checking_account_202348",
  "currency": "USD",
  "filename": "my-favourite.pdf",
  "reference_id": "my-favourite-pdf"
}

Response

OK

pdf_heron_idstring

Heron id of the uploaded pdf file

request_idstring

Unique UUID per request