Skip to main content
GET
List an end user's background check affiliations

Authorizations

x-api-key
string
header
required

Path Parameters

end_user_heron_id
string
required

The Heron ID of the end user

Response

OK

businesses
object[]
required

Businesses the owners are affiliated with, from their background check reports.

persons
object[]
required

People associated with the owners, from their background check reports.

status
enum<string>
required

Run lifecycle of the underlying background check. Lists reflect the most recent succeeded run; while a newer run is processing or failed they keep the last completed data and pending report requests show as pending.

Available options:
never_run,
processing,
succeeded,
failed,
missing_input_data