Download a subject's background check as XML

curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/subjects/{subject_key}/raw_report \
  --header 'x-api-key: <api-key>'

import requests

url = "https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/subjects/{subject_key}/raw_report"

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_users/{end_user_heron_id}/background_check/subjects/{subject_key}/raw_report', 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_users/{end_user_heron_id}/background_check/subjects/{subject_key}/raw_report",
  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_users/{end_user_heron_id}/background_check/subjects/{subject_key}/raw_report"

	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_users/{end_user_heron_id}/background_check/subjects/{subject_key}/raw_report")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/subjects/{subject_key}/raw_report")

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

{
  "file_b64": "<string>",
  "filename": "<string>",
  "mime_type": "<string>"
}

EndUsers

Download a subject's background check as XML

Returns the requested subject’s background check as machine-readable XML, base64-encoded in a JSON payload.

The document is rooted at <background_check> carrying end_user_id, end_user_name, status, subject_key and a UTC generated_at. Under it: <outcome> with the deal’s result, severity and check counts; <policy_checks count="n"> of <check>; and <subjects> holding the one requested <subject>. Within the subject, <application> is the identity that was searched, and each exported section is an element named for its key (criminal, liens, ofac, …) carrying count and one <record> per row. A section’s list fields are siblings of those elements rather than nested in them, in the same count/<record> shape — phones, addresses, emails, business_profile_details, business_contacts and work_affiliations — so profile itself has no element, only its lists.

Element and field names are those of BackgroundCheckResponseSchema, which is the data dictionary for their meaning. Values are machine-typed rather than display-formatted: a boolean is true/false, a list is a repeated element, an amount is a bare decimal, and an absent field is omitted rather than empty so a consumer can test for presence. The deal’s outcome and policy checks are repeated in every subject’s file, so each file stands on its own.

A check’s id is <scope>:<signal>, and the scope is what the check covers rather than necessarily this subject: owner_1, owner_2 and business each name one subject, any_owner is the worst outcome across the owners, and submission is computed over the whole deal. So a subject’s file carries checks about the other subjects too, and a failing any_owner or submission check should not be attributed to the subject whose file it arrived in.

GET

api

end_users

{end_user_heron_id}

background_check

subjects

{subject_key}

raw_report

Download a subject's background check as XML

curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/subjects/{subject_key}/raw_report \
  --header 'x-api-key: <api-key>'

import requests

url = "https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/subjects/{subject_key}/raw_report"

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_users/{end_user_heron_id}/background_check/subjects/{subject_key}/raw_report', 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_users/{end_user_heron_id}/background_check/subjects/{subject_key}/raw_report",
  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_users/{end_user_heron_id}/background_check/subjects/{subject_key}/raw_report"

	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_users/{end_user_heron_id}/background_check/subjects/{subject_key}/raw_report")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/subjects/{subject_key}/raw_report")

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

{
  "file_b64": "<string>",
  "filename": "<string>",
  "mime_type": "<string>"
}

Authorizations

x-api-key

string

header

required

Path Parameters

end_user_heron_id

string

required

The Heron ID of the end user

subject_key

enum<string>

required

The background check subject to export

Available options:

owner_1,

owner_2,

business

Response

file_b64

string

required

Base64-encoded document bytes

filename

string

required

Suggested download filename

mime_type

string

required

MIME type of the document