v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
EndUserFiles

Post EndUserFile V2

Upload file to an end user & asynchronously classify its type. After uploading, call the /start_workflow endpoint to trigger downstream processing (parsing, bank statement extraction, etc.).

post/api/end_users/{end_user_id_or_heron_id}/files/v2

Path parameters

end_user_id_or_heron_idstring required

Response

OK

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"
        }
      ]
    }
  ]
}