Retrieve a Document

Request

Returns an existing Document with the input ID.

Report Document IDs can be retrieved from the Retrieve an existing Report endpoint. Candidate Document IDs can be retrieved using the List a Candidate's Documents endpoint.

Security

basic_auth

Path

idstringrequired

ID of the Document to retrieve.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/documents/{id}'

Responses

Document details

Bodyapplication/json

idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"

objectstringread-only

Value:"document"

typestring

The type of Document.

Enum:"cdlis_report""consent""credit_report_consent_form""degree""diploma""driver_abstract""driver_license""driver_license_back""driver_license_history""drug_alcohol_clearinghouse_query_details_document"

Example:"driver_license"

created_atstring, (date-time)

Time at which the Document was created.

Example:"2015-02-11T20:01:50Z"

download_uristring

JSON encoded URL of the document. This URL is valid for 15 minutes.

Example:"https://checkr-documents.checkr.com/download_path"

filesizeinteger

File’s size in bytes.

Example:8576

filenamestring

File’s name.

Example:"1423684910_candidate_driver_license.jpg"

content_typestring

File’s content type.

Example:"image/jpeg"

localestring

Locale of the Document.

Example:"en"

Response

{
  "id": "e44aa283528e6fde7d542194",
  "object": "document",
  "type": "driver_license",
  "created_at": "2015-02-11T20:01:50Z",
  "download_uri": "https://checkr-documents.checkr.com/download_path",
  "filesize": 8576,
  "filename": "1423684910_candidate_driver_license.jpg",
  "content_type": "image/jpeg",
  "locale": "en"
}