Skip to main content
POST
Request background check reports for affiliations

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
affiliates
object[]
required

The affiliations to request CLEAR reports for, at most 25 per request.

Required array length: 1 - 25 elements

Response

Report requests accepted

requests
object[]
required

One entry per selection: the report request accepted for processing, or the in-flight request it was deduplicated against.