Skip to main content
POST
Upload PDF

Authorizations

x-api-key
string
header
required

Path Parameters

end_user_id_or_heron_id
string
required

The end_user_id or heron_id of EndUser to upload

Body

application/json
pdf_base64
string
required

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

Pattern: ^data\:\w+\/\w+\;base64\,
account_id
string | null

Unique ID for account associated with PDF

Example:

"checking_account_202348"

currency
enum<string> | null

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

Available options:
USD,
GBP,
null
Example:

"USD"

filename
string | null

The filename of the PDF

Example:

"my-favourite.pdf"

is_split
boolean | null

Whether the file has been manually split

Example:

false

parent_file_heron_id
string | null

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

read_us_dates
boolean | null

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

reference_id
string | null

An optional field for your unique identifier for the PDF

Maximum string length: 140
Example:

"my-favourite-pdf"

Response

201 - application/json

OK

pdf_heron_id
string

Heron id of the uploaded pdf file

request_id
string

Unique UUID per request