v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB

EndUserFiles

Post EndUserFile

Deprecated — use Post EndUserFile V2 instead.

post/api/end_users/{end_user_id_or_heron_id}/files

Path parameters

end_user_id_or_heron_idstring required

Request body

file_base64string required

Base64 encoded file bytes

file_classstring nullable

The type of file, e.g., bank_statement

filenamestring required

Name of file

parent_file_heron_idstring nullable

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

reference_idstring nullable

Your reference id for file

trigger_downstream_processingboolean

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

Response

createdstring date-time

file_classstring

file_source_metadataobject nullable

filenamestring

heron_idstring

num_pagesinteger

page_classesobject nullable

parent_heron_idstring nullable

processing_errorstring nullable

reference_idstring

renamed_filenamestring

Example response

{
  "bank_statement": {
    "heron_id": "pdf_kfwFjLM8PT5LyGvnJdXL8H",
    "status": "processed"
  },
  "iso_application": {
    "heron_id": "iso_6hBjQT9k6KP2rLCXwjUJff",
    "processing_status": "processed"
  },
  "parsed_results": [
    {
      "field_validations": [
        {
          "result": "pass"
        }
      ]
    }
  ]
}