Checkr Documents API

openapi: 3.2.0
info:
  version: v1
  title: Checkr.com API Docs Documents API
  license:
    name: Proprietary
    url: https://www.checkr.com
  contact:
    name: Checkr
    email: clients@checkr.com
    url: https://checkr.com
  description: '# Introduction


    Checkr is a modern, RESTful API-driven background screening service. The Checkr API uses resource-oriented URLs, supports HTTPS authentication and HTTPS verbs, and leverages JSON in all responses passed back to customers. Checkr is used by over 10,000 customers in a wide variety of industries, and supports a range of screening products and candidate workflows. For a full list of our screenings, please see the Checkr Screenings section below or read the Checkr Help Center articles on Screening Types. This Programming Guide is designed to help customers get up-and-running with Checkr''s background screening services, both by providing the necessary context to understand the background screening industry and its regulations, and by giving technical guidance on how to work with the Checkr API. **Note:** The cURL command is used for all examples in the Checkr API documentation. ### Other resources


    For information about using the Checkr Dashboard, and compliance and regulatory aspects of background checks, visit the Checkr Help Center. For a more targeted set of Checkr Dashboard learning paths for talent sourcing roles like Recruiters, Adjudicators, or Program Administrators, please see the Checkr Learning Center. ## Understand the screening process


    Checkr follows a standardized screening process:


    1. Customer requests a background check. 2. Candidate is presented with and signs the necessary disclosures and authorizations, and submits the requested Personally Identifiable Information (PII). - With the Checkr-Hosted Apply Flow, the candidate signs disclosures and authorizations and enters their own PII. - With a custom self-hosted flow, the Checkr customer collects the required authorizations, and passes Checkr candidate PII using the Checkr API. 3. Checkr conducts an SSN Trace, and collects associated addresses. 4. Checkr runs searches or verifications based on the screening Packages requested. 5. Checkr applies appropriate compliance filters based on the customer’s settings and candidate’s provided residence to determine which records to show, and returns a finalized report to the customer. 6. If there is a record on the report, the customer Engages or Adverse Actions the Candidate, based on an individualized assessment of the candidate''s report. ### 1. Request a background check


    To initiate a background check, a customer provides Checkr their candidate''s email address (for a Checkr-Hosted Apply Flow) or the candidate''s PII (for a self-hosted flow). For more information on ways to achieve this, please see Designing your workflow. ### 2. Candidate signs disclosures and authorizations


    Under the U.S. Fair Credit Reporting Act (FCRA), customers are obligated to collect consent from their candidates when running background checks through Checkr or any other Consumer Reporting Agency (CRA). The Checkr-Hosted Apply Flow presents candidates with fields in which the requested PII may be entered, and collects candidate information on behalf of the customer. Checkr will also present disclosures and authorizations to the candidate, and enable eSignature to capture consent, on behalf of customers using this flow with the Checkr Dashboard or email invitation flow. Custom self-hosted flows collect candidate PII, and pass the information to Checkr using the Checkr API. Customers creating a self-hosted flow will receive guidance from the Checkr team on setting up a similar process as required. ### 3. Checkr runs an SSN Trace


    Checkr runs an SSN Trace to match the candidate’s provided PII with existing credit header data mapped to the SSN. This process yields a list of names and addresses associated with the entered SSN, which can be used to supplement the background check process. At this point Checkr also conducts some initial data comparisons to check that critical pieces of information, like a candidate''s submitted Date of Birth (DOB) and SSN, align with information held on file by the credit bureaus.'
servers:
- url: https://api.checkr.com/v1
  description: Main server
tags:
- name: Documents
  description: 'Represents a Document, either related to a Report (such as a PDF Report) or related to a Candidate

    (such as a Driver License image, or a consent form). 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.


    Use `GET /v1/reports/{id}?include=documents` to return a Report resource that includes an array of `document` objects.


    Report Documents are of the following types: `cdlis_report`, `drug_screen_donor_pass`,

    `drug_alcohol_clearinghouse_query_details_document`, `health_screening_occupational_health_document`,

    `health_screening_result_certificate`, `pdf_credit_report`",

    `pdf_health_report`, `pdf_individualized_assessment`, `pdf_report`,

    `pdf_report_encrypted`, `pdf_self_disclosure`, `pdf_wisconsin_doj`, and

    `screening_pass`.'
paths:
  /candidates/{candidate_id}/documents:
    get:
      tags:
      - Documents
      summary: List a Candidate's Documents
      description: Returns an array of candidate-provided Documents for the input `candidate_id`.
      operationId: getCandidateDocuments
      security:
      - basic_auth: []
      parameters:
      - name: candidate_id
        in: path
        required: true
        description: ID of the Candidate for whom documents will be retrieved.
        schema:
          type: string
      - name: types[]
        in: query
        description: The type of candidate-provided document to return. If `types[]` is not included in the call, all available Candidate Documents will be returned.
        schema:
          type: array
          items:
            type: string
            enum:
            - alien_id
            - citizenship_certificate
            - consent
            - credit_report_consent_form
            - degree
            - diploma
            - driver_license
            - driver_license_back
            - driver_license_history
            - education_certificate
            - education_proof
            - electronic_consent_form
            - employment_proof
            - government_id
            - international_consent_form
            - military_id
            - national_id
            - national_id_back
            - passport
            - passport_signature_page
            - paystub
            - previous_driver_license
            - professional_license_certification_image
            - selfie
            - ssn_card
            - state_id_card
            - state_id_card_back
            - student_id
            - tax_form1099
            - tax_form_schedule_c
            - tax_form_w2
            - taxpayer_id
            - transcript
      responses:
        '200':
          $ref: '#/components/responses/DocumentsList'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
      x-codeSamples:
      - lang: curl
        source: "curl -X GET https://api.checkr.com/v1/candidates/e44aa283528e6fde7d542194/documents/ \\\n     -u 83ebeabdec09f6670863766f792ead24d61fe3f9:\n     -d \"types[]=driver_license\" \\\n     -d \"types[]=consent\"\n"
    post:
      tags:
      - Documents
      summary: Upload a new Candidate Document
      description: Uploads a new Candidate Document.
      operationId: uploadDocument
      security:
      - basic_auth: []
      parameters:
      - name: candidate_id
        in: path
        required: true
        description: Upload a document for the input `candidate_id`.
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/DocumentUpload'
      responses:
        '200':
          $ref: '#/components/responses/DocumentUploaded'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
      x-codeSamples:
      - lang: curl
        source: "$ curl -X POST https://api.checkr.com/v1/candidates/e44aa283528e6fde7d542194/documents \\\n    -u 83ebeabdec09f6670863766f792ead24d61fe3f9: \\\n    --form type=driver_license \\\n    --form file=@candidate_driver_license.jpg\n"
  /documents/{id}:
    parameters:
    - name: id
      in: path
      description: ID of the Document to retrieve.
      required: true
      schema:
        type: string
    get:
      tags:
      - Documents
      summary: Retrieve a Document
      description: '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.'
      operationId: getDocument
      security:
      - basic_auth: []
      responses:
        '200':
          $ref: '#/components/responses/Document'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
      x-codeSamples:
      - lang: curl
        source: "$ curl -X GET https://api.checkr.com/v1/documents/b73f89e14b393979857806f9 \\\n    -u 83ebeabdec09f6670863766f792ead24d61fe3f9:\n"
components:
  responses:
    DocumentUploaded:
      description: Document was successfully uploaded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Document'
    BadRequestError:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
    ForbiddenError:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ForbiddenError'
    Document:
      description: Document details
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Document'
    UnauthorizedError:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthorizedError'
    DocumentsList:
      description: List of Documents
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                items:
                  $ref: '#/components/schemas/Document'
              object:
                type: string
                description: A list
                enum:
                - list
              count:
                type: integer
                example: 1
  schemas:
    BadRequestError:
      type: object
      properties:
        error:
          type: string
          example: Dl number 'F211165' does not match the license number format in CA
    ForbiddenError:
      type: object
      properties:
        error:
          type: string
          example: You do not have permission to access the requested resource
    Document:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ResourceId'
        object:
          type: string
          enum:
          - document
          readOnly: true
        type:
          type: string
          description: The type of Document.
          enum:
          - cdlis_report
          - consent
          - credit_report_consent_form
          - degree
          - diploma
          - driver_license
          - driver_license_back
          - driver_license_history
          - drug_alcohol_clearinghouse_query_details_document
          - drug_screen_donor_pass
          - education_certificate
          - education_proof
          - employment_proof
          - health_screening_occupational_health_document
          - health_screening_result_certificate
          - international_consent_form
          - order_summary_pdf
          - passport
          - paystub
          - pdf_credit_report
          - pdf_health_report
          - pdf_individualized_assessment
          - pdf_professional_license_verification_report
          - pdf_report
          - pdf_self_disclosure
          - pdf_wisconsin_doj
          - previous_driver_license
          - professional_license_certification_image
          - screening_pass
          - selfie
          - ssn_card
          - state_id_card
          - state_id_card_back
          - tax_form1099
          - tax_form_schedule_c
          - tax_form_w2
          - transcript
          example: driver_license
        created_at:
          type: string
          description: Time at which the Document was created.
          format: date-time
          example: '2015-02-11T20:01:50Z'
        download_uri:
          type: string
          description: JSON encoded URL of the document. This URL is valid for 15 minutes.
          example: https://checkr-documents.checkr.com/download_path
        filesize:
          type: integer
          description: File’s size in bytes.
          example: 8576
        filename:
          type: string
          description: File’s name.
          example: 1423684910_candidate_driver_license.jpg
        content_type:
          type: string
          description: File’s content type.
          example: image/jpeg
    ResourceId:
      type: string
      example: e44aa283528e6fde7d542194
      readOnly: true
      description: ID of the resource.
    UnauthorizedError:
      type: object
      properties:
        error:
          type: string
          example: Bad authentication error
  requestBodies:
    DocumentUpload:
      required: true
      content:
        multipart/form-data:
          schema:
            type: object
            required:
            - file
            - type
            properties:
              type:
                type: string
                enum:
                - alien_id
                - citizenship_certificate
                - consent
                - credit_report_consent_form
                - degree
                - diploma
                - driver_license
                - driver_license_back
                - driver_license_history
                - education_certificate
                - education_proof
                - electronic_consent_form
                - employment_proof
                - government_id
                - international_consent_form
                - military_id
                - national_id
                - national_id_back
                - passport
                - passport_signature_page
                - paystub
                - previous_driver_license
                - professional_license_certification_image
                - selfie
                - ssn_card
                - state_id_card
                - state_id_card_back
                - student_id
                - tax_form1099
                - tax_form_schedule_c
                - tax_form_w2
                - taxpayer_id
                - transcript
              file:
                type: string
                format: binary
                description: '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`.

                  '
          encoding:
            file:
              contentType: image/gif, image/jpg, image/jpeg, image/png, image/bmp, image/tiff, application/pdf, image/heic
  securitySchemes:
    basic_auth:
      type: http
      scheme: basic
x-tagGroups:
- name: Resources
  tags:
  - Account
  - Users
  - Hierarchy (Enabled by request)
  - Nodes
  - Candidates
  - Reports
  - Packages
  - Invitations
  - Geos
  - Programs
  - Assessments
  - Subscriptions
  - Continuous Checks
  - Adverse Actions
  - Adverse Items
  - Verifications
  - Documents
  - Driver Licenses
  - Professional Licenses
  - Schools
  - Employers
  - Counties
  - Report Tags
  - Report Addresses
  - Report ETA
  - Candidate Stories
  - SSN
  - Webhooks
  - Candidate Postal Address
- name: Screenings
  tags:
  - SSN Trace
  - Sex Offender Registry Search
  - Global Watchlist Search
  - National Criminal Search
  - Federal Criminal Search
  - Federal District Criminal Search
  - Federal Civil Search
  - Federal District Civil Search
  - County Criminal Search
  - State Criminal Search
  - Motor Vehicle Report
  - Drug & Alcohol Clearinghouse Search
  - Education Verification
  - Employment Verification
  - Personal Reference Verification
  - Professional Reference Verification
  - Professional License Verification
  - International Adverse Media Search
  - International Criminal Search
  - International Education Verification
  - International Employment Verification
  - International Global Watchlist Search
  - International Identity Document Validation
  - International Motor Vehicle Report
  - FACIS Search
- name: Form I-9
  tags:
  - Getting Started
  - Forms I-9
  - Worksites
x-provenance:
  method: harvested
  publisher: Checkr
  source: https://api.redocly.com/registry/bundle/checkr/Checkr%20Public%20API/v1/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)