Sign in

v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
ISOApplication

Get the scrubbed results and data validations of an uploaded ISO application by its heron_id (prefixed "iso_")

Use this endpoint to retrieve the scrubbed results and data validations of an uploaded ISO application PDF once it has finished processing. If processing is still underway, the processing_status field will be "processing".

get/api/iso_applications/{heron_id}

Path parameters

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