HEherondata
EndUserFiles

Trigger splitting a combined end user file into its child files based on its page_classes

post/api/end_user_files/{heron_id}/trigger_split

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/end_user_files/{heron_id}/trigger_split
  • Auth
    API key in header x-api-key

Path parameters

heron_idstring required

The file's heron_id

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_hX7v63EYDYa7gLijntntaE",
      "status": "processed"
    },
    "iso_application": {
      "heron_id": "iso_6hBjQT9k6KP2rLCXwjUJff",
      "processing_status": "processed"
    },
    "parsed_results": [
      {
        "field_validations": [
          {
            "result": "pass"
          }
        ]
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 2 revisions of this API.