Skip to main content
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,
        "confidence_score": 123,
        "method": "<string>"
      },
      "searches": [
        {
          "candidate_count": 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": [
            {
              "case_number": "<string>",
              "categories": [],
              "category": "<string>",
              "court_name": "<string>",
              "disposition": "<string>",
              "filed_date": "2023-12-25",
              "is_dismissed": true,
              "is_felony": true,
              "offense": "<string>",
              "severity": "<unknown>",
              "severity_text": "<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>"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.herondata.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

Path Parameters

end_user_heron_id
string
required

The Heron ID of the end user

Response

OK

end_user_id
string
required

Heron ID of the end user

status
enum<string>
required
Available options:
never_run,
processing,
succeeded,
failed,
missing_input_data
subjects
object[]
required
overall
object
policy
object
processing_stage
enum<string> | null
Available options:
searching,
pulling_reports,
analysing,
null