v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB

EndUsers

Pin CLEAR candidate overrides for a background check

Pins a CLEAR entity_id per subject (owner_1, owner_2, business) so the enricher fetches that candidate's report directly and skips its search. A null value clears that subject's pin; unpinned subjects still run the full search waterfall. Returns the current pins.

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

Path parameters

end_user_heron_idstring required

The Heron ID of the end user

Request body

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.