Skip to main content
GET
/
api
/
end_user_files
/
{heron_id}
Get a single end user file by Heron ID
curl --request GET \
  --url https://app.herondata.io/api/end_user_files/{heron_id} \
  --header 'x-api-key: <api-key>'
import requests

url = "https://app.herondata.io/api/end_user_files/{heron_id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app.herondata.io/api/end_user_files/{heron_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://app.herondata.io/api/end_user_files/{heron_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://app.herondata.io/api/end_user_files/{heron_id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://app.herondata.io/api/end_user_files/{heron_id}")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.herondata.io/api/end_user_files/{heron_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "bank_statement": null,
  "created": "2023-11-07T05:31:56Z",
  "email": null,
  "file_class": "<string>",
  "file_source_metadata": {},
  "filename": "<string>",
  "heron_id": "<string>",
  "iso_application": {
    "heron_id": "iso_6hBjQT9k6KP2rLCXwjUJff",
    "processing_status": "processed"
  },
  "num_pages": 123,
  "page_classes": {},
  "parent_heron_id": "<string>",
  "parsed_results": [],
  "processing_error": "<string>",
  "reference_id": "<string>",
  "renamed_filename": "<string>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

heron_id
string
required

The Heron ID of the end user file (e.g. euf_...)

Response

The end user file

bank_statement
object | null
Example:

null

created
string<date-time>
email
object | null
Example:

null

file_class
string
file_source_metadata
object | null
read-only
filename
string
heron_id
string
iso_application
object | null
num_pages
integer
page_classes
object | null
parent_heron_id
string | null
parsed_results
object[]
read-only
processing_error
string | null
read-only
reference_id
string
renamed_filename
string