Skip to main content
GET
/
api
/
end_users
/
{end_user_heron_id}
/
background_check
/
subjects
/
{subject_key}
/
raw_report
Download a background check raw report
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>'
{
  "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 whose raw report should be downloaded

Available options:
owner_1,
owner_2,
business

Response

OK

​
file_b64
string
required

Base64-encoded raw report bytes

​
filename
string
required

Suggested download filename

​
mime_type
string
required

MIME type of the raw report