Skip to main content
POST
Request location-specific disclosures

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

language
enum<string>
required

The desired language for the legal document. Must be an ISO 639-1 code. Currently, the only supported value is en (English). If an unsupported language is requested, the call still succeeds but returns an English version of the document.

Available options:
en
caseId
string
required

The ID of a case.

disclosureType
enum<string>
required

The type of disclosure.

Available options:
disclosures,
customdynamicdisclosure

Body

application/json

Required disclosures vary from locale to locale, so location information in the request is used to return the relevant documents.

Once all disclosures have been acknowledged [blocked], calling this endpoint again will indicate that with alreadyAck and provide the caseDataId of the acknowledgment, which can be used to retrieve details. These can be used to determine whether the candidate can skip this step if they leave and then continue their onboarding later or another device, for example. Additionally, the location data in the request will be ignored.

However, if this endpoint is called again while some or all disclosures from the previous response remain unacknowledged, the endpoint will use the location information in the current request to return new documents and previously saved data will be discarded.

opportunityState
string
required

The state associated with the opportunity, such as the location of a job for which a candidate is undergoing a background check.

addressState
string
required

The candidate's state of residence.

opportunityCity
string

The city associated with the opportunity, such as the location of a job for which a candidate is undergoing a background check.

addressCity
string

The candidate's city of residence.

Response

OK

alreadyAck
boolean
required

True if the candidate already acknowledged the disclosures; false otherwise.

caseDataId

Returned only if alreadyAck is true.

list
object[]

Returned only if alreadyAck is false.