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>'{
"end_user_id": "<string>",
"subjects": [
{
"resolution": {
"entity_not_found": true,
"report_unavailable": true,
"confidence_score": 123,
"method": "<string>"
},
"searches": [
{
"candidate_count": 123,
"candidates": [
{
"is_match": true,
"address": "<string>",
"name": "<string>",
"reason": "<string>",
"relevance": 123
}
],
"inputs": {
"fuzzy": true,
"address": "<string>",
"business_name": "<string>",
"date_of_birth": "2023-12-25",
"email": "<string>",
"name": "<string>",
"phone": "<string>",
"ssn": "<string>",
"state": "<string>"
},
"is_resolving_match": true,
"search_method": "<string>",
"matched_group_id": "<string>",
"top_relevance": 123
}
],
"sections": [
{
"count": 123,
"label": "<string>",
"records": [
{
"arresting_agency": "<string>",
"case_number": "<string>",
"categories": [],
"category": "<string>",
"court_name": "<string>",
"disposition": "<string>",
"filed_date": "2023-12-25",
"is_dismissed": true,
"is_felony": true,
"offense": "<string>",
"sentence": "<string>",
"severity": "<unknown>",
"severity_text": "<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>"
],
"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>",
"name": "<string>",
"role": "<string>"
}
],
"overall": {
"check_counts": {
"fail": 123,
"pass": 123,
"review": 123
}
},
"policy": {
"checks": [
{
"area": "<string>",
"check_text": "<string>",
"evidence": {
"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>'{
"end_user_id": "<string>",
"subjects": [
{
"resolution": {
"entity_not_found": true,
"report_unavailable": true,
"confidence_score": 123,
"method": "<string>"
},
"searches": [
{
"candidate_count": 123,
"candidates": [
{
"is_match": true,
"address": "<string>",
"name": "<string>",
"reason": "<string>",
"relevance": 123
}
],
"inputs": {
"fuzzy": true,
"address": "<string>",
"business_name": "<string>",
"date_of_birth": "2023-12-25",
"email": "<string>",
"name": "<string>",
"phone": "<string>",
"ssn": "<string>",
"state": "<string>"
},
"is_resolving_match": true,
"search_method": "<string>",
"matched_group_id": "<string>",
"top_relevance": 123
}
],
"sections": [
{
"count": 123,
"label": "<string>",
"records": [
{
"arresting_agency": "<string>",
"case_number": "<string>",
"categories": [],
"category": "<string>",
"court_name": "<string>",
"disposition": "<string>",
"filed_date": "2023-12-25",
"is_dismissed": true,
"is_felony": true,
"offense": "<string>",
"sentence": "<string>",
"severity": "<unknown>",
"severity_text": "<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>"
],
"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>",
"name": "<string>",
"role": "<string>"
}
],
"overall": {
"check_counts": {
"fail": 123,
"pass": 123,
"review": 123
}
},
"policy": {
"checks": [
{
"area": "<string>",
"check_text": "<string>",
"evidence": {
"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
Response
OK
Heron ID of the end user
Available options:
never_run, processing, succeeded, failed, missing_input_data Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
searching, pulling_reports, analysing, null Was this page helpful?
⌘I