Skip to main content
POST
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
files
/
v2
Post EndUserFile V2
curl --request POST \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/files/v2 \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form file='@example-file' \
  --form 'file_class=<string>' \
  --form 'reference_id=<string>'
{
  "bank_statement": null,
  "created": "2023-11-07T05:31:56Z",
  "email": null,
  "file_class": "<string>",
  "file_source_metadata": {},
  "filename": "<string>",
  "heron_id": "<string>",
  "iso_application": {
    "heron_id": "iso_6hBjQT9k6KP2rLCXwjUJff",
    "processing_status": "processed"
  },
  "num_pages": 123,
  "page_classes": {},
  "parent_heron_id": "<string>",
  "parsed_results": [],
  "processing_error": "<string>",
  "reference_id": "<string>",
  "renamed_filename": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.herondata.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
end_user_id_or_heron_id
string
required

Body

multipart/form-data
​
file
file
required

The file to upload

​
file_class
string

(Optional) - The type of file. Common values: bank_statement, iso_application_form, debt_summary, void_check, invoice, pnl_statement, balance_sheet, tax_return, money_market_statement. Contact Heron support for the full list of file classes available for your account.

​
reference_id
string

Your reference id for the file

Response

201 - application/json

OK

​
bank_statement
object
Example:

null

​
created
string<date-time>
​
email
object
Example:

null

​
file_class
string
​
file_source_metadata
object
read-only
​
filename
string
​
heron_id
string
​
iso_application
object
​
num_pages
integer
​
page_classes
object
​
parent_heron_id
string | null
​
parsed_results
object[]
read-only
​
processing_error
string | null
read-only
​
reference_id
string
​
renamed_filename
string