Get EndUserFiles

curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/files \
  --header 'x-api-key: <api-key>'

[
  {
    "bank_statement": null,
    "created": "2023-11-07T05:31:56Z",
    "email": null,
    "file_class": "<string>",
    "file_source_metadata": {},
    "filename": "<string>",
    "heron_id": "<string>",
    "iso_application": {
      "heron_id": "iso_6hBjQT9k6KP2rLCXwjUJff",
      "processing_status": "processed"
    },
    "num_pages": 123,
    "page_classes": {},
    "parent_heron_id": "<string>",
    "parsed_results": [],
    "reference_id": "<string>",
    "renamed_filename": "<string>"
  }
]

GET

api

end_users

{end_user_id_or_heron_id}

files

Get EndUserFiles

curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/files \
  --header 'x-api-key: <api-key>'

[
  {
    "bank_statement": null,
    "created": "2023-11-07T05:31:56Z",
    "email": null,
    "file_class": "<string>",
    "file_source_metadata": {},
    "filename": "<string>",
    "heron_id": "<string>",
    "iso_application": {
      "heron_id": "iso_6hBjQT9k6KP2rLCXwjUJff",
      "processing_status": "processed"
    },
    "num_pages": 123,
    "page_classes": {},
    "parent_heron_id": "<string>",
    "parsed_results": [],
    "reference_id": "<string>",
    "renamed_filename": "<string>"
  }
]

Authorizations

x-api-key

string

header

required

Path Parameters

end_user_id_or_heron_id

string

required

Response

200 - application/json

bank_statement

object

Show child attributes

bank_statement.heron_id

string

ID generated by Heron Data

Example:

"pdf_7zAbhV85bRD2EcuAtZ9iK4"

bank_statement.status

enum<string>

Status of PDF

Available options:

new,

parsing,

parsed,

processed,

human_reviewing,

approved,

rejected,

failed,

transactions_loaded,

transactions_unloaded

Example:

"processed"

Example:

null

created

string<date-time>

object

Show child attributes

email.created

string<date-time>

email.date_sent

string<date-time>

email.date_sent_string

string

email.from_address

string

email.from_address_domain

string

email.from_name

string

email.heron_id

string

email.html_body

string

email.html_or_text_body

string

email.is_reply

boolean

email.processing_status

enum<string>

Available options:

new,

processing,

processed,

failed

email.subject

string

email.subject_cleaned

string

email.text_body

string

email.viewer_url

string

a temporary, secure URL for viewing the email contents

Example:

null

file_class

string

file_source_metadata

object

Show child attributes

file_source_metadata.{key}

any

filename

string

heron_id

string

iso_application

object

Show child attributes

iso_application.heron_id

string

required

The ISO application's heron_id

Example:

"iso_6hBjQT9k6KP2rLCXwjUJff"

iso_application.processing_status

enum<string>

required

The processing status of the file.

Available options:

new,

processing,

processed,

failed

Example:

"processed"

num_pages

integer

page_classes

object

Show child attributes

page_classes.{key}

object

Show child attributes

page_classes.{key}.confidence

number

default:1

page_classes.{key}.file_class

string

parent_heron_id

string | null

parsed_results

object[]

Show child attributes

parsed_results.created

string<date-time>

required

parsed_results.heron_id

string

required

Unique identifier of the end user file

parsed_results.parser_id

string

required

parsed_results.parsing_status

enum<string>

required

Available options:

succeeded,

failed,

processing

parsed_results.attribute_values

object[]

Show child attributes

parsed_results.attribute_values.{key}

any

parsed_results.bounding_boxes

object[] | null

Show child attributes

parsed_results.bounding_boxes.bounding_box

number[]

required

Bounding box coordinates in the format 'y1,x1,y2,x2'

parsed_results.bounding_boxes.json_pointer

string

required

JSON pointer to the field in the parsed result

parsed_results.bounding_boxes.page_num

integer

required

Page number where the bounding box is located

parsed_results.bounding_boxes.value

string

required

The actual value of the field within the bounding box

parsed_results.field_validations

object[]

Show child attributes

parsed_results.field_validations.failure_reason

string | null

required

parsed_results.field_validations.field_name

string

required

parsed_results.field_validations.result

enum<string>

required

Available options:

pass,

fail,

not_applicable

Example:

"pass"

parsed_results.field_validations.validation_type

string

required

parsed_results.id

integer

[DEPRECATED] Unique identifier for the parsed file

parsed_results.layout_bounding_boxes

object[] | null

Show child attributes

parsed_results.layout_bounding_boxes.bounding_box

number[]

required

Bounding box coordinates in the format 'y1,x1,y2,x2'

parsed_results.layout_bounding_boxes.json_pointer

string

required

JSON pointer to the field in the parsed result

parsed_results.layout_bounding_boxes.page_num

integer

required

Page number where the bounding box is located

parsed_results.layout_bounding_boxes.value

string

required

The actual value of the field within the bounding box

parsed_results.parser_display_name

string

parsed_results.patches

object[]

Show child attributes

parsed_results.patches.op

string

required

parsed_results.patches.path

string

required

parsed_results.patches.correction_reason

string | null

parsed_results.patches.enabled

boolean | null

parsed_results.patches.original_value

unknown

parsed_results.patches.source

string | null

parsed_results.patches.value

unknown

parsed_results.result

object

Final output result after applying patches

Show child attributes

parsed_results.result.{key}

any

parsed_results.result_schema

object

The output JSON schema the results conform to

Show child attributes

parsed_results.result_schema.{key}

any

parsed_results.validation_summary

string

Summary of validation results

reference_id

string

renamed_filename

string

Update Parsed Results Post EndUserFile

⌘I

API Reference

AppStore

Categories

Credentials

CrmIntegrations

EndUserDataSourceAccounts

EndUserDataSources

EmailTemplates

EndUsers

EndUserEmails

EndUserEnrichers

EndUserEntity

EndUserFiles

FileClass

EndUserCalculations

EndUserAttributes

EnrichmentFeedback

EndUserFinancials

EndUserRules

Integrations

EndUserIntegrations

ISOApplication

EndUserAccounts

Policy

Positions

EnrichedTransactions

Transactions

Funders

Testing

Merchants

Rules

ParsedEndUserSubmission

UserMerchantGroups

Users

Watermarks

Webhooks

Workflows

Authorizations

Path Parameters

Response