Skip to main content
GET
/
api
/
iso_applications
/
{heron_id}
Get the scrubbed results and data validations of an uploaded ISO application by its heron_id (prefixed "iso_")
curl --request GET \
  --url https://app.herondata.io/api/iso_applications/{heron_id} \
  --header 'x-api-key: <api-key>'
{
  "filename": "iso_app.pdf",
  "heron_id": "iso_6hBjQT9k6KP2rLCXwjUJff",
  "processing_status": "processed",
  "quality_status": "fully_matched",
  "created": "2023-11-07T05:31:56Z",
  "end_user_heron_id": "<string>",
  "end_user_id": "<string>",
  "field_validations": [
    {
      "failure_reason": "<string>",
      "field_name": "<string>",
      "result": "passed",
      "validation_type": "<string>"
    }
  ],
  "result": {},
  "source_email": {
    "date_sent": "2023-11-07T05:31:56Z",
    "date_sent_string": "<string>",
    "from_address": "<string>",
    "from_address_domain": "<string>",
    "from_name": "<string>",
    "html_body": "<string>",
    "html_or_text_body": "<string>",
    "subject": "<string>",
    "text_body": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
heron_id
string
required

Response

200 - application/json

Ok

​
filename
string
required

The original filename of the ISO application form

Example:

"iso_app.pdf"

​
heron_id
string
required

The ISO application's heron_id

Example:

"iso_6hBjQT9k6KP2rLCXwjUJff"

​
processing_status
enum<string>
required

The processing status of the file.

Available options:
new,
processing,
processed,
failed
Example:

"processed"

​
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,
Example:

"fully_matched"

​
created
string<date-time>
​
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