v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB

EndUsers

Get the pinned CLEAR candidate overrides for a background check

Returns the per-subject CLEAR entity_id pins the background-check enricher fetches reports for directly, skipping its search. An empty value means that subject still runs the full search waterfall.

get/api/end_users/{end_user_heron_id}/background_check/override

Path parameters

end_user_heron_idstring required

The Heron ID of the end user

Response

businessstring nullable

Selected candidate ID for the business; null when not overridden.

owner_1string nullable

Selected candidate ID for owner_1; null when not overridden.

owner_2string nullable

Selected candidate ID for owner_2; null when not overridden.