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”.
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
Response
The original filename of the ISO application form
The ISO application's heron_id
The processing status of the file.
new
, processing
, processed
, failed
The overall field validation results. 'fully_matched' indicated all field validations have passed. 'review_required' indicates one or more field validations failed.
fully_matched
, review_required
The heron_id of the end_user associated with the iso application, if available
The end_user_id of the end_user associated with the iso application, if available
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.
Original email that contained ISO application, if applicable
Was this page helpful?