v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB

EndUserFiles

Update the end user file's class

Use this endpoint to change the end user file's class. The file will be reprocessed as the new type.

patch/api/end_user_files/{heron_id}

Path parameters

heron_idstring required

Request body

file_classstring

page_classesobject nullable

parent_heron_idstring nullable

reference_idstring

Response

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