GET
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
iso_applications

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
end_user_id_or_heron_id
string
required

Response

200 - application/json
​
filename
string
required

The original filename of the ISO application form

​
heron_id
string
required

The ISO application's heron_id

​
processing_status
enum<string>
required

The processing status of the file.

Available options:
new,
processing,
processed,
failed
​
quality_status
enum<string> | null
required

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

Available options:
fully_matched,
review_required
​
created
string
​
end_user_heron_id
string

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

​
end_user_id
string

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

​
field_validations
object[]
​
result
object

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.

​
source_email
object

Original email that contained ISO application, if applicable

Was this page helpful?

Upload an ISO application PDF for for an end userUpload an ISO application PDF for automated scrubbing in under 15 seconds