Skip to main content
POST
Post EndUserFile

Authorizations

x-api-key
string
header
required

Path Parameters

end_user_id_or_heron_id
string
required

Body

application/json
file_base64
string
required

Base64 encoded file bytes

filename
string
required

Name of file

file_class
string | null

The type of file, e.g., bank_statement

parent_file_heron_id
string | null

The Heron ID of the parent file, if this file is a part of another file

reference_id
string | null

Your reference id for file

trigger_downstream_processing
boolean
default:true

Whether to trigger downstream processing (file classification, parsing, etc.) upon upload

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