Get EndUser background check dashboard payload
curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check \
--header 'x-api-key: <api-key>'import requests
url = "https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check"
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', 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",
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"
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")
.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")
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{
"end_user_id": "<string>",
"subjects": [
{
"application": {
"address": "<string>",
"business_name": "<string>",
"date_of_birth": "2023-12-25",
"ein": "<string>",
"email": "<string>",
"name": "<string>",
"owner": "<string>",
"phone": "<string>",
"ssn": "<string>",
"state": "<string>"
},
"candidates": [
{
"id": "<string>",
"address": "<string>",
"aka_names": [
"<string>"
],
"basis": "<string>",
"duns_numbers": [
"<string>"
],
"entity_id": "<string>",
"group_id": "<string>",
"is_limited": true,
"matched_address": "<string>",
"matched_aka_name": "<string>",
"name": "<string>",
"rank": 123,
"relevance": 123,
"score": {
"contributions": [
{
"allocation": 123,
"field": "<string>",
"points": 123,
"application_value": "<string>",
"candidate_value": "<string>",
"strength": 123,
"trace": {
"base": 123,
"components": [
{
"value": "<unknown>"
}
],
"modifiers": [
{
"effect": 123,
"detail": "<string>"
}
]
}
}
],
"total": 123,
"version": "<string>",
"anchor_trace": {
"permitted": true,
"guard_strength": 123
},
"anchored_by": "<string>",
"cap_trace": {
"cap": 123,
"conflict": "zero_floor",
"uncapped_total": 123
},
"capped_by": "<string>"
}
}
],
"resolution": {
"entity_not_found": true,
"report_retry_attempted": true,
"report_unavailable": true,
"aka_names": [
"<string>"
],
"match_threshold": 123,
"method": "<string>",
"score_version": "<string>",
"winner_ref": "<string>"
},
"searches": [
{
"candidate_count": 123,
"candidate_refs": [
{
"id": "<string>",
"matched_address": "<string>",
"matched_aka_name": "<string>",
"rank": 123,
"relevance": 123,
"score_total": 123
}
],
"inputs": {
"fuzzy": true,
"address": "<string>",
"business_name": "<string>",
"corporation_id": "<string>",
"date_of_birth": "2023-12-25",
"email": "<string>",
"filing_state": "<string>",
"name": "<string>",
"phone": "<string>",
"ssn": "<string>",
"state": "<string>"
},
"is_resolving_match": true,
"resolved": true,
"search_method": "<string>",
"matched_group_id": "<string>",
"outcome_reason": {
"details": [
{
"label": "<string>",
"value": "<unknown>"
}
],
"label": "<string>"
},
"top_relevance": 123
}
],
"sections": [
{
"count": 123,
"label": "<string>",
"records": [
{
"actual_release_date": "2023-12-25",
"arrest_date": "2023-12-25",
"arresting_agency": "<string>",
"case_number": "<string>",
"case_status": "<string>",
"case_status_date": "2023-12-25",
"categories": [],
"category": "<string>",
"court_county": "<string>",
"court_name": "<string>",
"crime_date": "2023-12-25",
"detail": {
"additional_fields": [
{
"label": "<string>",
"value": "<string>"
}
],
"arrests": [
{}
],
"attorneys": [
{
"address": "<string>",
"bar_number": "<string>",
"email": "<string>",
"firm": "<string>",
"name": "<string>",
"phone": "<string>",
"role": "<string>",
"status": "<string>"
}
],
"bail": [
{
"bond_number": "<string>",
"bondsman": "<string>",
"date": "<string>",
"posted": "<string>",
"status": "<string>"
}
],
"case": {
"case_details": "<string>",
"case_number": "<string>",
"case_title": "<string>",
"category": "<string>",
"chapter": "<string>",
"company_interest": "<string>",
"county": "<string>",
"court": "<string>",
"discharge_date": "<string>",
"disposition": "<string>",
"disposition_date": "<string>",
"division": "<string>",
"docket_number": "<string>",
"document_id": "<string>",
"filed_date": "<string>",
"filing_office": "<string>",
"filing_state": "<string>",
"final_decree_date": "<string>",
"judge": "<string>",
"jury_demand": "<string>",
"jury_demand_amount": "<string>",
"nature_of_suit": "<string>",
"nature_of_suit_code": "<string>",
"state": "<string>",
"status": "<string>",
"sub_category": "<string>"
},
"charges": [
{
"additional_fields": [
{
"label": "<string>",
"value": "<string>"
}
],
"amended_offense": "<string>",
"amended_statute": "<string>",
"case_comments": "<string>",
"case_information": "<string>",
"case_number": "<string>",
"case_status": "<string>",
"category": "<string>",
"citation_number": "<string>",
"class_of_offense": "<string>",
"counts": "<string>",
"court_charge": "<string>",
"court_county": "<string>",
"court_name": "<string>",
"crime_date": "<string>",
"disposition": "<string>",
"disposition_date": "<string>",
"duplicate_report": true,
"fee_amount": "<string>",
"filed_date": "<string>",
"fined_amount": "<string>",
"max_sentence_months": "<string>",
"offense": "<string>",
"offense_code": "<string>",
"offense_date": "<string>",
"offense_notes": "<string>",
"plea": "<string>",
"probation_months": "<string>",
"sentence": "<string>",
"sequence": "<string>",
"severity": "<string>",
"source_entry_id": "<string>",
"statute": "<string>",
"warrant_date": "<string>"
}
],
"collateral": [
"<string>"
],
"creditors": [
"<string>"
],
"debtors": [
{
"address": "<string>",
"name": "<string>",
"owed_amount": "<string>",
"role": "<string>"
}
],
"defendant": {
"additional_fields": [
{
"label": "<string>",
"value": "<string>"
}
],
"address": "<string>",
"dob": "<string>",
"name": "<string>",
"sex": "<string>"
},
"docket_entries": [
{
"attorney": "<string>",
"date": "<string>",
"description": "<string>",
"disposition": "<string>",
"docketed_date": "<string>",
"document": "<string>",
"entry_number": "<string>",
"fee": "<string>",
"file_type": "<string>",
"judge": "<string>",
"location": "<string>",
"misc": "<string>",
"party": "<string>",
"party_type": "<string>",
"room": "<string>",
"time": "<string>"
}
],
"entries": "<array>",
"filing": {
"certificate_number": "<string>",
"court": "<string>",
"court_county": "<string>",
"expire_date": "<string>",
"file_date": "<string>",
"file_number_full": "<string>",
"file_pages": "<string>",
"filing_date": "<string>",
"filing_number": "<string>",
"filing_office": "<string>",
"filing_office_address": "<string>",
"filing_state": "<string>",
"filing_type": "<string>",
"hidden_filing_number": "<string>",
"original_filing_number": "<string>",
"perfected_date": "<string>",
"reference_file_number": "<string>",
"related_file_date": "<string>",
"release_date": "<string>",
"type_of_action": "<string>",
"type_of_filing": "<string>",
"type_of_tax": "<string>"
},
"filing_relationship": "<string>",
"meeting_341": {
"date": "<string>",
"location": "<string>",
"time": "<string>"
},
"parties": [
{
"address": "<string>",
"akas": [
"<string>"
],
"attorneys": [
{
"address": "<string>",
"bar_number": "<string>",
"email": "<string>",
"firm": "<string>",
"name": "<string>",
"phone": "<string>",
"role": "<string>",
"status": "<string>"
}
],
"name": "<string>",
"phone": "<string>",
"reported_date": "<string>",
"role": "<string>",
"sex": "<string>",
"status": "<string>"
}
],
"record_shape": "<string>",
"related": [
{
"label": "<string>",
"value": "<string>"
}
],
"secured_parties": [
{
"address": "<string>",
"name": "<string>",
"owed_amount": "<string>",
"role": "<string>"
}
],
"source": {
"publication_date": "<string>",
"source_document_guid": "<string>",
"source_name": "<string>",
"source_state": "<string>"
},
"source_entry_id": "<string>"
},
"disposition": "<string>",
"disposition_date": "2023-12-25",
"entry_count": 123,
"filed_date": "2023-12-25",
"fine_amount": 123,
"is_dismissed": true,
"is_felony": true,
"is_unclassified": true,
"number_of_counts": 123,
"offense": "<string>",
"offense_location": "<string>",
"parole_status": "<string>",
"plea": "<string>",
"plea_date": "2023-12-25",
"probation_end_date": "2023-12-25",
"probation_violation": "<string>",
"projected_release_date": "2023-12-25",
"sentence": "<string>",
"severity": "<unknown>",
"severity_text": "<string>",
"shared_case_key": "<string>",
"source_entries": [
{
"actual_release_date": "2023-12-25",
"arrest_date": "2023-12-25",
"arresting_agency": "<string>",
"case_number": "<string>",
"case_status": "<string>",
"case_status_date": "2023-12-25",
"categories": [],
"category": "<string>",
"court_county": "<string>",
"court_name": "<string>",
"crime_date": "2023-12-25",
"disposition": "<string>",
"disposition_date": "2023-12-25",
"filed_date": "2023-12-25",
"fine_amount": 123,
"is_dismissed": true,
"is_felony": true,
"number_of_counts": 123,
"offense": "<string>",
"offense_location": "<string>",
"parole_status": "<string>",
"plea": "<string>",
"plea_date": "2023-12-25",
"probation_end_date": "2023-12-25",
"probation_violation": "<string>",
"projected_release_date": "2023-12-25",
"sentence": "<string>",
"severity": "<unknown>",
"severity_text": "<string>",
"source_entry_id": "<string>",
"statute_code": "<string>"
}
],
"source_entry_id": "<string>",
"source_entry_ids": [
"<string>"
],
"statute_code": "<string>"
}
],
"addresses": [
{
"address": "<string>",
"city_state": "<string>",
"first_reported_date": "2023-12-25",
"last_reported_date": "2023-12-25",
"source": "<string>"
}
],
"akas": [
"<string>"
],
"emails": [
{
"email": "<string>",
"source": "<string>"
}
],
"entry_count": 123,
"phones": [
{
"carrier": "<string>",
"number": "<string>",
"source": "<string>",
"type": "<string>"
}
],
"ssn_issuance": {
"expiration_date": "<string>",
"issuance_text": "<string>",
"issue_date": "<string>",
"issue_state": "<string>"
},
"work_affiliations": [
{
"address": "<string>",
"business_name": "<string>",
"role": "<string>",
"since_date": "2023-12-25",
"status": "<string>"
}
]
}
],
"unreported_officers": [
"<string>"
],
"case_ref": "<string>",
"decision": {
"anchored_by": "<string>",
"near_tie": {
"gap": 123,
"probed": true,
"flag_counts": {}
},
"pooled_count": 123
},
"duns_numbers": [
"<string>"
],
"name": "<string>",
"related_party_officers": [
"<string>"
],
"role": "<string>"
}
],
"overall": {
"check_counts": {
"fail": 123,
"pass": 123,
"review": 123
}
},
"policy": {
"checks": [
{
"area": "<string>",
"check_text": "<string>",
"evidence_subjects": [
{
"filtered": true,
"record_indices": [
123
],
"section": "<string>"
}
],
"id": "<string>",
"signal": "<string>",
"area_sub": "<string>",
"auto_reason": "<string>",
"override": {
"at": "2023-11-07T05:31:56Z",
"by": "<string>"
},
"rule": "<string>"
}
]
}
}EndUsers
Get EndUser background check dashboard payload
Get the background check results for an end user, including the screening run status, each subject’s identity matches and records, and the outcome of each policy check.
GET
/
api
/
end_users
/
{end_user_heron_id}
/
background_check
Get EndUser background check dashboard payload
curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check \
--header 'x-api-key: <api-key>'import requests
url = "https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check"
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', 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",
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"
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")
.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")
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{
"end_user_id": "<string>",
"subjects": [
{
"application": {
"address": "<string>",
"business_name": "<string>",
"date_of_birth": "2023-12-25",
"ein": "<string>",
"email": "<string>",
"name": "<string>",
"owner": "<string>",
"phone": "<string>",
"ssn": "<string>",
"state": "<string>"
},
"candidates": [
{
"id": "<string>",
"address": "<string>",
"aka_names": [
"<string>"
],
"basis": "<string>",
"duns_numbers": [
"<string>"
],
"entity_id": "<string>",
"group_id": "<string>",
"is_limited": true,
"matched_address": "<string>",
"matched_aka_name": "<string>",
"name": "<string>",
"rank": 123,
"relevance": 123,
"score": {
"contributions": [
{
"allocation": 123,
"field": "<string>",
"points": 123,
"application_value": "<string>",
"candidate_value": "<string>",
"strength": 123,
"trace": {
"base": 123,
"components": [
{
"value": "<unknown>"
}
],
"modifiers": [
{
"effect": 123,
"detail": "<string>"
}
]
}
}
],
"total": 123,
"version": "<string>",
"anchor_trace": {
"permitted": true,
"guard_strength": 123
},
"anchored_by": "<string>",
"cap_trace": {
"cap": 123,
"conflict": "zero_floor",
"uncapped_total": 123
},
"capped_by": "<string>"
}
}
],
"resolution": {
"entity_not_found": true,
"report_retry_attempted": true,
"report_unavailable": true,
"aka_names": [
"<string>"
],
"match_threshold": 123,
"method": "<string>",
"score_version": "<string>",
"winner_ref": "<string>"
},
"searches": [
{
"candidate_count": 123,
"candidate_refs": [
{
"id": "<string>",
"matched_address": "<string>",
"matched_aka_name": "<string>",
"rank": 123,
"relevance": 123,
"score_total": 123
}
],
"inputs": {
"fuzzy": true,
"address": "<string>",
"business_name": "<string>",
"corporation_id": "<string>",
"date_of_birth": "2023-12-25",
"email": "<string>",
"filing_state": "<string>",
"name": "<string>",
"phone": "<string>",
"ssn": "<string>",
"state": "<string>"
},
"is_resolving_match": true,
"resolved": true,
"search_method": "<string>",
"matched_group_id": "<string>",
"outcome_reason": {
"details": [
{
"label": "<string>",
"value": "<unknown>"
}
],
"label": "<string>"
},
"top_relevance": 123
}
],
"sections": [
{
"count": 123,
"label": "<string>",
"records": [
{
"actual_release_date": "2023-12-25",
"arrest_date": "2023-12-25",
"arresting_agency": "<string>",
"case_number": "<string>",
"case_status": "<string>",
"case_status_date": "2023-12-25",
"categories": [],
"category": "<string>",
"court_county": "<string>",
"court_name": "<string>",
"crime_date": "2023-12-25",
"detail": {
"additional_fields": [
{
"label": "<string>",
"value": "<string>"
}
],
"arrests": [
{}
],
"attorneys": [
{
"address": "<string>",
"bar_number": "<string>",
"email": "<string>",
"firm": "<string>",
"name": "<string>",
"phone": "<string>",
"role": "<string>",
"status": "<string>"
}
],
"bail": [
{
"bond_number": "<string>",
"bondsman": "<string>",
"date": "<string>",
"posted": "<string>",
"status": "<string>"
}
],
"case": {
"case_details": "<string>",
"case_number": "<string>",
"case_title": "<string>",
"category": "<string>",
"chapter": "<string>",
"company_interest": "<string>",
"county": "<string>",
"court": "<string>",
"discharge_date": "<string>",
"disposition": "<string>",
"disposition_date": "<string>",
"division": "<string>",
"docket_number": "<string>",
"document_id": "<string>",
"filed_date": "<string>",
"filing_office": "<string>",
"filing_state": "<string>",
"final_decree_date": "<string>",
"judge": "<string>",
"jury_demand": "<string>",
"jury_demand_amount": "<string>",
"nature_of_suit": "<string>",
"nature_of_suit_code": "<string>",
"state": "<string>",
"status": "<string>",
"sub_category": "<string>"
},
"charges": [
{
"additional_fields": [
{
"label": "<string>",
"value": "<string>"
}
],
"amended_offense": "<string>",
"amended_statute": "<string>",
"case_comments": "<string>",
"case_information": "<string>",
"case_number": "<string>",
"case_status": "<string>",
"category": "<string>",
"citation_number": "<string>",
"class_of_offense": "<string>",
"counts": "<string>",
"court_charge": "<string>",
"court_county": "<string>",
"court_name": "<string>",
"crime_date": "<string>",
"disposition": "<string>",
"disposition_date": "<string>",
"duplicate_report": true,
"fee_amount": "<string>",
"filed_date": "<string>",
"fined_amount": "<string>",
"max_sentence_months": "<string>",
"offense": "<string>",
"offense_code": "<string>",
"offense_date": "<string>",
"offense_notes": "<string>",
"plea": "<string>",
"probation_months": "<string>",
"sentence": "<string>",
"sequence": "<string>",
"severity": "<string>",
"source_entry_id": "<string>",
"statute": "<string>",
"warrant_date": "<string>"
}
],
"collateral": [
"<string>"
],
"creditors": [
"<string>"
],
"debtors": [
{
"address": "<string>",
"name": "<string>",
"owed_amount": "<string>",
"role": "<string>"
}
],
"defendant": {
"additional_fields": [
{
"label": "<string>",
"value": "<string>"
}
],
"address": "<string>",
"dob": "<string>",
"name": "<string>",
"sex": "<string>"
},
"docket_entries": [
{
"attorney": "<string>",
"date": "<string>",
"description": "<string>",
"disposition": "<string>",
"docketed_date": "<string>",
"document": "<string>",
"entry_number": "<string>",
"fee": "<string>",
"file_type": "<string>",
"judge": "<string>",
"location": "<string>",
"misc": "<string>",
"party": "<string>",
"party_type": "<string>",
"room": "<string>",
"time": "<string>"
}
],
"entries": "<array>",
"filing": {
"certificate_number": "<string>",
"court": "<string>",
"court_county": "<string>",
"expire_date": "<string>",
"file_date": "<string>",
"file_number_full": "<string>",
"file_pages": "<string>",
"filing_date": "<string>",
"filing_number": "<string>",
"filing_office": "<string>",
"filing_office_address": "<string>",
"filing_state": "<string>",
"filing_type": "<string>",
"hidden_filing_number": "<string>",
"original_filing_number": "<string>",
"perfected_date": "<string>",
"reference_file_number": "<string>",
"related_file_date": "<string>",
"release_date": "<string>",
"type_of_action": "<string>",
"type_of_filing": "<string>",
"type_of_tax": "<string>"
},
"filing_relationship": "<string>",
"meeting_341": {
"date": "<string>",
"location": "<string>",
"time": "<string>"
},
"parties": [
{
"address": "<string>",
"akas": [
"<string>"
],
"attorneys": [
{
"address": "<string>",
"bar_number": "<string>",
"email": "<string>",
"firm": "<string>",
"name": "<string>",
"phone": "<string>",
"role": "<string>",
"status": "<string>"
}
],
"name": "<string>",
"phone": "<string>",
"reported_date": "<string>",
"role": "<string>",
"sex": "<string>",
"status": "<string>"
}
],
"record_shape": "<string>",
"related": [
{
"label": "<string>",
"value": "<string>"
}
],
"secured_parties": [
{
"address": "<string>",
"name": "<string>",
"owed_amount": "<string>",
"role": "<string>"
}
],
"source": {
"publication_date": "<string>",
"source_document_guid": "<string>",
"source_name": "<string>",
"source_state": "<string>"
},
"source_entry_id": "<string>"
},
"disposition": "<string>",
"disposition_date": "2023-12-25",
"entry_count": 123,
"filed_date": "2023-12-25",
"fine_amount": 123,
"is_dismissed": true,
"is_felony": true,
"is_unclassified": true,
"number_of_counts": 123,
"offense": "<string>",
"offense_location": "<string>",
"parole_status": "<string>",
"plea": "<string>",
"plea_date": "2023-12-25",
"probation_end_date": "2023-12-25",
"probation_violation": "<string>",
"projected_release_date": "2023-12-25",
"sentence": "<string>",
"severity": "<unknown>",
"severity_text": "<string>",
"shared_case_key": "<string>",
"source_entries": [
{
"actual_release_date": "2023-12-25",
"arrest_date": "2023-12-25",
"arresting_agency": "<string>",
"case_number": "<string>",
"case_status": "<string>",
"case_status_date": "2023-12-25",
"categories": [],
"category": "<string>",
"court_county": "<string>",
"court_name": "<string>",
"crime_date": "2023-12-25",
"disposition": "<string>",
"disposition_date": "2023-12-25",
"filed_date": "2023-12-25",
"fine_amount": 123,
"is_dismissed": true,
"is_felony": true,
"number_of_counts": 123,
"offense": "<string>",
"offense_location": "<string>",
"parole_status": "<string>",
"plea": "<string>",
"plea_date": "2023-12-25",
"probation_end_date": "2023-12-25",
"probation_violation": "<string>",
"projected_release_date": "2023-12-25",
"sentence": "<string>",
"severity": "<unknown>",
"severity_text": "<string>",
"source_entry_id": "<string>",
"statute_code": "<string>"
}
],
"source_entry_id": "<string>",
"source_entry_ids": [
"<string>"
],
"statute_code": "<string>"
}
],
"addresses": [
{
"address": "<string>",
"city_state": "<string>",
"first_reported_date": "2023-12-25",
"last_reported_date": "2023-12-25",
"source": "<string>"
}
],
"akas": [
"<string>"
],
"emails": [
{
"email": "<string>",
"source": "<string>"
}
],
"entry_count": 123,
"phones": [
{
"carrier": "<string>",
"number": "<string>",
"source": "<string>",
"type": "<string>"
}
],
"ssn_issuance": {
"expiration_date": "<string>",
"issuance_text": "<string>",
"issue_date": "<string>",
"issue_state": "<string>"
},
"work_affiliations": [
{
"address": "<string>",
"business_name": "<string>",
"role": "<string>",
"since_date": "2023-12-25",
"status": "<string>"
}
]
}
],
"unreported_officers": [
"<string>"
],
"case_ref": "<string>",
"decision": {
"anchored_by": "<string>",
"near_tie": {
"gap": 123,
"probed": true,
"flag_counts": {}
},
"pooled_count": 123
},
"duns_numbers": [
"<string>"
],
"name": "<string>",
"related_party_officers": [
"<string>"
],
"role": "<string>"
}
],
"overall": {
"check_counts": {
"fail": 123,
"pass": 123,
"review": 123
}
},
"policy": {
"checks": [
{
"area": "<string>",
"check_text": "<string>",
"evidence_subjects": [
{
"filtered": true,
"record_indices": [
123
],
"section": "<string>"
}
],
"id": "<string>",
"signal": "<string>",
"area_sub": "<string>",
"auto_reason": "<string>",
"override": {
"at": "2023-11-07T05:31:56Z",
"by": "<string>"
},
"rule": "<string>"
}
]
}
}Authorizations
Path Parameters
The Heron ID of the end user
Query Parameters
If true, each record additionally carries its full vendor detail under detail
If true, each subject's search trail is taken from that subject's most recent run that used an automatic identity search, ignoring runs where the subject was manually pinned. Records and policy outcomes are unaffected.
Response
OK
Dates use YYYY-MM-DD. Amounts are decimal strings. Nullable source fields return null. SSNs remain masked; full SSNs never appear.
Heron ID of the end user
Run lifecycle: never_run, processing, succeeded, failed, or missing_input_data.
Available options:
never_run, processing, succeeded, failed, missing_input_data One entry per searched subject: owner_1, owner_2 when present, and business.
Show child attributes
Show child attributes
Headline outcome across all background checks; null until an outcome is available.
Show child attributes
Show child attributes
Outcome of each configured background-check policy check; null until available.
Show child attributes
Show child attributes
While processing: searching, pulling_reports, or analysing. Null otherwise.
Available options:
searching, pulling_reports, analysing, null Was this page helpful?
List EndUsers with Summary InformationGet the pinned CLEAR candidate overrides for a background check
⌘I