Upload a new Candidate Document

Request

Uploads a new Candidate Document.

For a consent PDF, upload with type consent, save the id from the response, and pass it in consent_document_ids on Create a new Report. Uploading the file does not attach it to the report.

Security

basic_auth

Path

candidate_idstringrequired

Upload a document for the input candidate_id.

Bodymultipart/form-datarequired

typestringrequired

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

filestring, (binary)required

Path to the document on your local file system.

Valid MIME types: image/gif, image/jpg, image/jpeg, image/png, image/bmp, image/tiff, application/pdf, image/heic.

curl -i -X POST \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/candidates/{candidate_id}/documents' \
  -H 'Content-Type: multipart/form-data' \
  -F type=alien_id \
  -F file=string

Responses

Document was successfully uploaded

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"
}