List a Candidate's Documents

Request

Returns an array of candidate-provided Documents for the input candidate_id.

Security

basic_auth

Path

candidate_idstringrequired

ID of the Candidate for whom documents will be retrieved.

Query

types[]Array of strings

The type of candidate-provided document to return. If types[] is not included in the call, all available Candidate Documents will be returned.

Items Enum:"alien_id""citizenship_certificate""consent""credit_report_consent_form""degree""diploma""driver_abstract""driver_license""driver_license_back""driver_license_history"

curl -i -X GET \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/candidates/{candidate_id}/documents?types%5B%5D=alien_id'

Responses

List of Documents

Bodyapplication/json

dataArray of objects(Document)

objectstring

A list

Value:"list"

countinteger

Example:1

Response

{
  "data": [
    { … }
  ],
  "object": "list",
  "count": 1
}