---
title: "Get a single end user file by Heron ID"
method: GET
path: "/api/end_user_files/{heron_id}"
tags: ["EndUserFiles"]
---

# Get a single end user file by Heron ID

`GET /api/end_user_files/{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.

## Path parameters

- `heron_id` string, required

## Response `200`

The end user file

- EndUserFileSchema
  - `bank_statement` PdfGet
    - `data_source` DataSourceNested
      - `heron_id` string — Heron ID of the data source
      - `is_enabled` boolean — Whether this data source is enabled
    - `heron_id` string — ID generated by Heron Data
    - `status` 'new' | 'parsing' | 'parsed' | 'processed' | 'human_reviewing' | 'approved' | 'rejected' | 'failed' | 'transactions_loaded' | 'transactions_unloaded' — Status of PDF
  - `created` string, date-time
  - `email` EndUserEmailSchema
    - `cc_addresses` string[]
    - `created` string, date-time
    - `date_sent` string, date-time
    - `date_sent_string` string
    - `from_address` string
    - `from_address_domain` string
    - `from_name` string
    - `heron_id` string
    - `html_body` string
    - `html_or_text_body` string
    - `is_reply` boolean
    - `processing_status` 'new' | 'processing' | 'processed' | 'failed'
    - `reply_to` string, nullable
    - `subject` string
    - `subject_cleaned` string
    - `text_body` string
    - `to_addresses` string[]
    - `viewer_url` string — a temporary, secure URL for viewing the email contents
  - `file_class` string
  - `file_source_metadata` object, nullable
  - `filename` string
  - `heron_id` string
  - `iso_application` GetIsoApplication
    - `heron_id` string, required — The ISO application's heron_id
    - `processing_status` 'new' | 'processing' | 'processed' | 'failed', required — The processing status of the file.
  - `num_pages` integer
  - `page_classes` object, nullable
  - `parent_heron_id` string, nullable
  - `parsed_results` ParsedEndUserFile[]
    - `attribute_values` object[]
    - `bounding_boxes` ParsedEndUserFileBoundingBox[], nullable
      - `bounding_box` number[], required — Bounding box coordinates in the format 'y1,x1,y2,x2'
      - `json_pointer` string, required — JSON pointer to the field in the parsed result
      - `page_num` integer, required — Page number where the bounding box is located
      - `value` string, required — The actual value of the field within the bounding box
    - `created` string, date-time, required
    - `field_validations` FieldValidation[]
      - `failure_reason` string, nullable, required
      - `field_name` string, required
      - `result` 'pass' | 'fail' | 'not_applicable', required
      - `validation_type` string, required
    - `heron_id` string, required — Unique identifier of the end user file
    - `id` integer — [DEPRECATED] Unique identifier for the parsed file
    - `layout_bounding_boxes` ParsedEndUserFileBoundingBox[], nullable
      - `bounding_box` number[], required — Bounding box coordinates in the format 'y1,x1,y2,x2'
      - `json_pointer` string, required — JSON pointer to the field in the parsed result
      - `page_num` integer, required — Page number where the bounding box is located
      - `value` string, required — The actual value of the field within the bounding box
    - `parser_display_name` string
    - `parser_id` string, required
    - `parsing_status` 'succeeded' | 'failed' | 'processing', required
    - `patches` ParsedEndUserFilePatch[]
      - `correction_reason` string, nullable
      - `enabled` boolean, nullable
      - `op` string, required
      - `original_value` unknown
      - `path` string, required
      - `source` string, nullable
      - `value` unknown
    - `result` object, nullable — Final output result after applying patches
    - `result_schema` object — The output JSON schema the results conform to
    - `validation_summary` string — Summary of validation results
  - `processing_error` string, nullable
  - `reference_id` string
  - `renamed_filename` string

## Other responses

- `404` — End user file not found

---

[API](https://skmtc.net/herondata/apis/heron-data-api.md) · [All operations](https://skmtc.net/herondata/apis/heron-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/herondata/heron-data-api/versions/f2e441edece2/schema)
