Skip to main content
POST
Confirm a candidate for an affiliate report

Authorizations

x-api-key
string
header
required

Path Parameters

end_user_heron_id
string
required

The Heron ID of the end user

Body

application/json
entity_id
string
required

The chosen candidate's entity identifier from the report's search trail.

ref
string
required

The affiliate report request reference, as returned when it was requested.

Response

Report pull accepted

kind
enum<string>
required

Whether the report is for an affiliated business or person.

Available options:
person,
business
ref
string
required

Stable reference for this affiliate report request; echo it when confirming a candidate or removing the request.

status
enum<string>
required

Report lifecycle: pending until the next screening run pulls it, succeeded when the report is ready, not_found when no confident match was found (a candidate can be confirmed), or failed.

Available options:
pending,
succeeded,
not_found,
failed