v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB

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

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

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.