Checkr Invitations API

openapi: 3.2.0
info:
  version: v1
  title: Checkr.com API Docs Invitations 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: Invitations
  description: 'Represents a background check invitation. The candidate will receive an email to submit their information.


    **Note**: By default, the date of expiration is set to 7 days after creation.

    All invitations expire at 11:59:59pm PDT.

    This enables candidates to have a full last day to complete their invitation.'
paths:
  /invitations:
    post:
      tags:
      - Invitations
      summary: Create a new Invitation
      description: Creates a new Invitation resource.
      operationId: createInvitation
      security:
      - basic_auth: []
      requestBody:
        $ref: '#/components/requestBodies/InvitationCreate'
      responses:
        '201':
          $ref: '#/components/responses/InvitationCreated'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/PackageNotFoundError'
      x-codeSamples:
      - lang: curl
        source: "$ curl -X POST https://api.checkr.com/v1/invitations \\\n    -u 83ebeabdec09f6670863766f792ead24d61fe3f9: \\\n    -H 'Content-Type: application/json' \\\n    -d '{\"candidate_id\":\"e44aa283528e6fde7d542194\",\n        \"package\":\"driver_pro\",\n        \"work_locations\":[{\"country\":\"US\"}]}'"
    get:
      tags:
      - Invitations
      summary: List existing Invitations
      description: 'Returns a list of existing Invitations with the input `status` or `candidate_id`.


        * If no parameters are passed, returns all Invitations.


        * If `candidate_id` or `status` is passed, returns Invitations that match the input parameter.


        * If both `candidate_id` and `status` are passed, return Invitations that match both parameters.


        Returns 400 if the (optional) `status` parameter is not `pending`, `expired`, or `completed`.

        Note: This call will not return invitations with non-US `work_locations`. Use GET /invitations/{id} to retrieve candidates outside the US.'
      operationId: listOfInvitations
      security:
      - basic_auth: []
      parameters:
      - name: candidate_id
        in: query
        description: ID of the candidate to whom the invitation was issued.
        schema:
          type: string
      - name: status
        in: query
        description: Status of the Invitation.
        schema:
          type: string
          enum:
          - pending
          - completed
          - expired
      - name: page
        in: query
        description: Specifies the page number to retrieve.
        required: false
        schema:
          type:
          - number
          - 'null'
      - name: per_page
        in: query
        description: Indicates how many records each page should contain. The default value is 25 records.
        required: false
        schema:
          type:
          - number
          - 'null'
      responses:
        '200':
          $ref: '#/components/responses/InvitationsList'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
      x-codeSamples:
      - lang: curl
        source: "$ curl -X GET https://api.checkr.com/v1/invitations \\\n    -u 83ebeabdec09f6670863766f792ead24d61fe3f9: \\\n    -d status=pending\n"
  /invitations/{id}:
    parameters:
    - name: id
      in: path
      description: The Invitation's ID.
      required: true
      schema:
        type: string
    get:
      tags:
      - Invitations
      summary: Retrieve an existing Invitation
      description: Returns an existing Invitation with the input ID.
      operationId: getInvitation
      parameters:
      - name: include_deleted
        in: query
        description: Retrieve an invitation that has been deleted
        required: false
        schema:
          type: boolean
      security:
      - basic_auth: []
      responses:
        '200':
          $ref: '#/components/responses/Invitation'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
      x-codeSamples:
      - lang: curl
        source: "$ curl -X GET https://api.checkr.com/v1/invitations/3c0a0ca94caaab6ca9634f76 \\\n    -u 83ebeabdec09f6670863766f792ead24d61fe3f9:\n"
    delete:
      tags:
      - Invitations
      summary: Cancel an existing Invitation
      description: Cancels an existing Invitation.
      operationId: cancelInvitation
      security:
      - basic_auth: []
      responses:
        '200':
          $ref: '#/components/responses/InvitationCanceled'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
      x-codeSamples:
      - lang: curl
        source: "$ curl -X DELETE https://api.checkr.com/v1/invitations/4722c07dd9a10c3985ae432a \\\n    -u 83ebeabdec09f6670863766f792ead24d61fe3f9\n"
components:
  schemas:
    ResourceURI:
      type: string
      description: URI of the resource.
      readOnly: true
    PackageNotFoundError:
      type: object
      properties:
        error:
          type: string
          example: Package not found
    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
    ResourceId:
      type: string
      example: e44aa283528e6fde7d542194
      readOnly: true
      description: ID of the resource.
    Invitation:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ResourceId'
        object:
          type: string
          enum:
          - invitation
          readOnly: true
        uri:
          allOf:
          - $ref: '#/components/schemas/ResourceURI'
          example: /v1/invitations/e44aa283528e6fde7d542194
        invitation_url:
          type: string
          description: URL for the Invitation.
          example: https://apply.checkr.com/invite/try-checkr/290f9d6d6e46/test
        status:
          type: string
          description: Status of the Invitation.
          enum:
          - pending
          - completed
          - expired
          example: pending
        created_at:
          type: string
          description: Time at which the Invitation was created.
          format: date-time
          example: '2015-05-14T17:45:34Z'
        expires_at:
          type: string
          description: Time at which the Invitation will expire.
          format: date-time
          example: '2015-05-21T17:45:34Z'
        completed_at:
          type:
          - string
          - 'null'
          description: Time at which the Invitation was completed by the candidate.
          format: date-time
          example: null
        deleted_at:
          type:
          - string
          - 'null'
          description: Time at which the Invitation was deleted.
          example: null
        package:
          type: string
          description: Package associated with the Invitation.
          example: driver_pro
        candidate_id:
          type: string
          description: ID of the Candidate to whom the Invitation was sent.
          example: 551564b7865af96a28b13f36
        report_id:
          type:
          - string
          - 'null'
          description: ID of the Report created by the completion of this Invitation. Will be null if the Invitation has not yet been completed.
          example: null
        archived:
          type: boolean
          description: Returns `true` if the invitation is archived.
          example: false
        archived_info:
          type: object
          description: Information relating to an archived report or invitation
          properties:
            time:
              type: string
              description: Time the report or invitation was archived
              format: date-time
              example: '2023-08-29T23:15:34Z'
            user:
              type: object
              description: User information about the archiver
              properties:
                email:
                  type:
                  - string
                  - 'null'
                  description: 'User''s email address

                    '
                  format: email
                  example: john.smith@gmail.com
                id:
                  type:
                  - string
                  - 'null'
                  description: 'User''s ID

                    '
                  example: 1234abcd5678
    UnauthorizedError:
      type: object
      properties:
        error:
          type: string
          example: Bad authentication error
    WorkLocation:
      type: object
      required:
      - state
      properties:
        country:
          type: string
          description: The country in ISO-3166 alpha-2 format.
          example: US
          minLength: 2
          maxLength: 2
        state:
          type: string
          description: The two letter state code.
          example: CA
        city:
          type: string
          description: Name of the city
          example: San Francisco
          maxLength: 255
  responses:
    InvitationsList:
      description: List of Invitations
      content:
        application/json:
          schema:
            type: object
            properties:
              object:
                type: string
                description: A list
                enum:
                - list
              next_href:
                type: string
                format: uri
              previous_href:
                type: string
                format: uri
              count:
                type: integer
                example: 2
              data:
                type: array
                items:
                  $ref: '#/components/schemas/Invitation'
    BadRequestError:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
    ForbiddenError:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ForbiddenError'
    InvitationCreated:
      description: Invitation was successfully created
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Invitation'
    PackageNotFoundError:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PackageNotFoundError'
    InvitationCanceled:
      description: Invitation was successfully canceled
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Invitation'
    UnauthorizedError:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthorizedError'
    Invitation:
      description: Invitation details
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Invitation'
  requestBodies:
    InvitationCreate:
      content:
        application/json:
          schema:
            type: object
            required:
            - package
            - candidate_id
            properties:
              package:
                type: string
                description: '`slug` of the associated package.

                  '
                example: driver_pro
              candidate_id:
                type: string
                description: ID of the Candidate for whom the Invitation is created.
                example: 551564b7865af96a28b13f36
              node:
                type: string
                description: '<font color="red">Required</font> for hierarchy-enabled accounts.


                  `custom_id` of the associated node.

                  '
              work_locations:
                type: array
                description: '<font color="red">Required</font> for hierarchy-enabled accounts.


                  Array of locations described using country, state, and city. When country is not specified defaults to US. State is required for US candidates. Country is required for non-US candidates.

                  '
                items:
                  $ref: '#/components/schemas/WorkLocation'
              tags:
                type: array
                description: Array of tags for the Report.
                items:
                  type: string
      required: true
  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)