EndUsers

Get EndUser background check dashboard payload

Changed on Nov 3, 2026

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

Request

Base URL
https://app.herondata.io
URL
https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check
Auth
API key in header x-api-key

Path parameters

end_user_heron_idstring required

The Heron ID of the end user

Query parameters

include_section_detailboolean

If true, each record additionally carries its full vendor detail under detail

exclude_manualboolean

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

end_user_idstring required

Heron ID of the end user

processing_stage'searching' | 'pulling_reports' | 'analysing' | 'null' nullable

While processing: searching, pulling_reports, or analysing. Null otherwise.

status'never_run' | 'processing' | 'succeeded' | 'failed' | 'missing_input_data' required

Run lifecycle: never_run, processing, succeeded, failed, or missing_input_data.

Changes

Nov 3, 2026bd8008e49534 Revision changes
- breaking
  added to the ///// response property oneOf list for the response status
- warning
  added the new aggravated_assault enum value to the /////////// response property for the response status
- warning
  added the new aggravated_assault enum value to the ///////////// response property for the response status
- warning
  added the new animal_fighting enum value to the /////////// response property for the response status
- warning
  added the new animal_fighting enum value to the ///////////// response property for the response status
- warning
  added the new arson enum value to the /////////// response property for the response status
- warning
  added the new arson enum value to the ///////////// response property for the response status
- warning
  added the new bribery_corruption enum value to the /////////// response property for the response status
- warning
  added the new bribery_corruption enum value to the ///////////// response property for the response status
- warning
  added the new child_abuse enum value to the /////////// response property for the response status
- warning
  added the new child_abuse enum value to the ///////////// response property for the response status
- warning
  added the new drug_trafficking enum value to the /////////// response property for the response status
- warning
  added the new drug_trafficking enum value to the ///////////// response property for the response status
- warning
  added the new execution_error enum value to the ///// response property for the response status
- warning
  added the new execution_error enum value to the ///// response property for the response status
- warning
  added the new explosives enum value to the /////////// response property for the response status
- warning
  added the new explosives enum value to the ///////////// response property for the response status
- warning
  added the new extortion enum value to the /////////// response property for the response status
- warning
  added the new extortion enum value to the ///////////// response property for the response status
- warning
  added the new firearms_trafficking enum value to the /////////// response property for the response status
- warning
  added the new firearms_trafficking enum value to the ///////////// response property for the response status
- warning
  added the new full_name_in_first_name enum value to the ////////////////// response property for the response status
- warning
  added the new hijacking enum value to the /////////// response property for the response status
- warning
  added the new hijacking enum value to the ///////////// response property for the response status
- warning
  added the new human_trafficking enum value to the /////////// response property for the response status
- warning
  added the new human_trafficking enum value to the ///////////// response property for the response status
- warning
  added the new incest enum value to the /////////// response property for the response status
- warning
  added the new incest enum value to the ///////////// response property for the response status
- warning
  added the new inchoate enum value to the /////////// response property for the response status
- warning
  added the new inchoate enum value to the ///////////// response property for the response status
- warning
  added the new involuntary_manslaughter enum value to the /////////// response property for the response status
- warning
  added the new involuntary_manslaughter enum value to the ///////////// response property for the response status
- warning
  added the new kidnapping enum value to the /////////// response property for the response status
- warning
  added the new kidnapping enum value to the ///////////// response property for the response status
- warning
  added the new mayhem enum value to the /////////// response property for the response status
- warning
  added the new mayhem enum value to the ///////////// response property for the response status
- warning
  added the new merged_filing_basis enum value to the ////////////////// response property for the response status
- warning
  added the new murder enum value to the /////////// response property for the response status
- warning
  added the new murder enum value to the ///////////// response property for the response status
- warning
  added the new property enum value to the //// response property for the response status
- warning
  added the new racketeering enum value to the /////////// response property for the response status
- warning
  added the new racketeering enum value to the ///////////// response property for the response status
- warning
  added the new rape enum value to the /////////// response property for the response status
- warning
  added the new rape enum value to the ///////////// response property for the response status
- warning
  added the new robbery enum value to the /////////// response property for the response status
- warning
  added the new robbery enum value to the ///////////// response property for the response status
- warning
  added the new skipped enum value to the ///// response property for the response status
- warning
  added the new skipped enum value to the ///// response property for the response status
- warning
  added the new tax enum value to the /////////// response property for the response status
- warning
  added the new tax enum value to the ///////////// response property for the response status
- warning
  added the new terrorism enum value to the /////////// response property for the response status
- warning
  added the new terrorism enum value to the ///////////// response property for the response status
- warning
  added the new theft enum value to the /////////// response property for the response status
- warning
  added the new theft enum value to the ///////////// response property for the response status
- warning
  added the new voluntary_manslaughter enum value to the /////////// response property for the response status
- warning
  added the new voluntary_manslaughter enum value to the ///////////// response property for the response status
- info
  added the new optional query request parameter exclude_manual
- info
  added the optional property to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property ///////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property //////////// to the response with the status
- info
  added the optional property //////////// to the response with the status
- info
  added the optional property //////////// to the response with the status
- info
  added the optional property //////////// to the response with the status
- info
  added the optional property //////////// to the response with the status
- info
  added the optional property //////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property ///////////////// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property to the response with the status
- info
  removed from the ///// response property oneOf list for the response status
- info
  added the required property ///////// to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status
- info
  added the required property /////// to the response with the status

Operation history