Skip to main content
POST
Post EndUserFile V2

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 | null
Example:

null

created
string<date-time>
email
object | null
Example:

null

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