v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB

EndUserFiles

Get a single end user file by Heron ID

Retrieve a single end user file by its Heron ID. Returns file metadata including filename, file class, parsed results (if any), and related info. Use this endpoint when you have an end user file Heron ID and need its details without listing or filtering all files.

get/api/end_user_files/{heron_id}

Path parameters

heron_idstring required

The Heron ID of the end user file (e.g. euf_...)

Response

The end user file

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