v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
EndUsers

Download a background check raw report

Returns the requested subject's raw background check report as a base64-encoded JSON payload.

get/api/end_users/{end_user_heron_id}/background_check/subjects/{subject_key}/raw_report

Path parameters

end_user_heron_idstring required

The Heron ID of the end user

subject_key'owner_1' | 'owner_2' | 'business' required

The background check subject whose raw report should be downloaded

Response

OK

file_b64string required

Base64-encoded raw report bytes

filenamestring required

Suggested download filename

mime_typestring required

MIME type of the raw report