Sign in

v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
ISOApplication

Get EndUser ISO Applications

Get all ISO applications for an end user

get/api/end_users/{end_user_id_or_heron_id}/iso_applications

Path parameters

end_user_id_or_heron_idstring required

Response

OK

createdstring date-time
end_user_heron_idstring

The heron_id of the end_user associated with the iso application, if available

end_user_idstring

The end_user_id of the end_user associated with the iso application, if available

filenamestring required

The original filename of the ISO application form

heron_idstring required

The ISO application's heron_id

processing_status'new' | 'processing' | 'processed' | 'failed' required

The processing status of the file.

quality_status'fully_matched' | 'review_required' | 'null' nullable required

The overall field validation results. 'fully_matched' indicated all field validations have passed. 'review_required' indicates one or more field validations failed.

resultobject

The extracted keys/values from the form, normalised to Heron's field schema. Keys will only be present in results if they are found in the original file. For a full list of fields, see the documentation.

Example response

[
  {
    "field_validations": [
      {
        "result": "passed"
      }
    ],
    "filename": "iso_app.pdf",
    "heron_id": "iso_6hBjQT9k6KP2rLCXwjUJff",
    "processing_status": "processed",
    "quality_status": "fully_matched"
  }
]