Get the pinned CLEAR candidate overrides for a background check

curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/override \
  --header 'x-api-key: <api-key>'

{
  "business": "<string>",
  "owner_1": "<string>",
  "owner_2": "<string>"
}

GET

api

end_users

{end_user_heron_id}

background_check

override

Get the pinned CLEAR candidate overrides for a background check

curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/override \
  --header 'x-api-key: <api-key>'

{
  "business": "<string>",
  "owner_1": "<string>",
  "owner_2": "<string>"
}

x-api-key

string

header

required

end_user_heron_id

string

required

The Heron ID of the end user

business

string | null

owner_1

string | null

owner_2

string | null

⌘I