Checkr Schools API

openapi: 3.2.0
info:
  version: v1
  title: Checkr.com API Docs Schools 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: Schools
  description: 'The School resource includes all relevant educational information for the specified Candidate.

    School resources are tied to the specified candidate, and do not transfer to other alumna within the system.'
paths:
  /candidates/{candidate_id}/schools:
    post:
      tags:
      - Schools
      summary: Create a new School
      description: 'Creates a new School resource.


        Validation for `start_date` and `end_date` is performed to ensure logical dates are provided. `end_date` must be after `start_date`, and both dates must be after 1900-01-01.


        If the country is not US, the following parameters are required in addition to those marked as required below:


        - year_awarded

        - phone

        - minor

        - start_date

        - end_date

        - current

        - address

        - street

        - city

        - zipcode

        - state

        - country'
      operationId: createSchoolForCandidate
      security:
      - basic_auth: []
      parameters:
      - name: candidate_id
        in: path
        required: true
        description: Creates a School for the input `candidate_id`.
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/SchoolCreate'
      responses:
        '200':
          $ref: '#/components/responses/SchoolCreated'
        '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/schools \\\n    -u 83ebeabdec09f6670863766f792ead24d61fe3f9: \\\n    -d name=College\\ University \\\n    -d address\\[street\\]=1+Circle+Avenue \\\n    -d address\\[city\\]=San+Francisco \\\n    -d address\\[zipcode\\]=94105 \\\n    -d address\\[state\\]=CA \\\n    -d address\\[country\\]=US \\\n    -d degree=BS \\\n    -d year_awarded=2017 \\\n    -d major=Computer+Science \\\n    -d phone=111-111-1111 \\\n    -d minor=Background+Checks \\\n    -d start_date=2012-09-25 \\\n    -d end_date=2017-05-29 \\\n    -d current=false \\\n    -d school_url=www.school.com\n"
    get:
      tags:
      - Schools
      summary: List existing Schools
      description: Returns a list of existing Schools for the input `candidate_id`.
      operationId: schoolsListByCandidate
      security:
      - basic_auth: []
      parameters:
      - name: candidate_id
        in: path
        required: true
        description: Returns the list of schools for the input `candidate_id`.
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/SchoolsList'
        '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/schools/fe8b5a63af2799aba7fdf64d \\\n    -u 83ebeabdec09f6670863766f792ead24d61fe3f9:\n"
  /candidates/{candidate_id}/schools/{id}:
    parameters:
    - name: id
      in: path
      description: The School's ID.
      required: true
      schema:
        type: string
    - name: candidate_id
      in: path
      description: The Candidate's ID.
      required: true
      schema:
        type: string
    delete:
      tags:
      - Schools
      summary: Delete an existing School
      description: Deletes an existing School with the input `school_id`.
      operationId: schoolDelete
      security:
      - basic_auth: []
      responses:
        '200':
          $ref: '#/components/responses/SchoolDeleted'
        '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/candidates/e44aa283528e6fde7d542194/schools/95a95172bb81143ed44e403c \\\n    -u 83ebeabdec09f6670863766f792ead24d61fe3f9:\n"
    get:
      tags:
      - Schools
      summary: Retrieve an existing School
      description: Returns an existing School with the input `school_id`.
      operationId: getSchool
      security:
      - basic_auth: []
      responses:
        '200':
          $ref: '#/components/responses/School'
        '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/schools/fe8b5a63af2799aba7fdf64d \\\n    -u 83ebeabdec09f6670863766f792ead24d61fe3f9:\n"
components:
  requestBodies:
    SchoolCreate:
      content:
        application/json:
          schema:
            type: object
            required:
            - name
            - degree
            - major
            - address
            properties:
              id:
                $ref: '#/components/schemas/ResourceId'
              object:
                type: string
                enum:
                - school
                readOnly: true
              candidate_id:
                type: string
                pattern: '[a-zA-Z0-9 -''.,]*'
                description: Candidate linked to this School resource.
                example: 83ebeagdec0948690863766f792ead24d61fe3f9
                minLength: 1
              name:
                type: string
                pattern: '[a-zA-Z0-9 -''.,]*'
                description: Name of the School.
                example: College University
                minLength: 1
              degree:
                type: string
                description: Degree awarded to the Candidate.
                example: BA
              year_awarded:
                type: integer
                description: Year in which the degree was awarded.
                example: 2017
                minLength: 1
              major:
                type: string
                pattern: '[a-zA-Z0-9 -''.,]*'
                description: Candidate’s major.
                example: Russian Literature
              phone:
                type:
                - string
                - 'null'
                description: School's phone number.
                example: 415-111-1111
              minor:
                type: string
                description: Candidate’s minor.
                example: Background Checks
              start_date:
                type: string
                description: Candidate’s start date with the School.
                format: date
                example: '2012-09-22'
              end_date:
                type: string
                description: Candidate’s end date with the School.
                format: date
                example: '2017-05-10'
              current:
                type: boolean
                description: Defines whether the Candidate is currently enrolled.
                default: false
              school_url:
                type: string
                description: School’s website.
                example: www.collegeuniversity.com
              address:
                $ref: '#/components/schemas/Address'
      required: true
  schemas:
    ResourceURI:
      type: string
      description: URI of the resource.
      readOnly: true
    School:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ResourceId'
        object:
          type: string
          enum:
          - school
          readOnly: true
        uri:
          allOf:
          - $ref: '#/components/schemas/ResourceURI'
          example: /v1/schools/e44aa283528e6fde7d542194
        candidate_id:
          type: string
          pattern: '[a-zA-Z0-9 -''.,]*'
          description: Candidate linked to this School resource.
          example: 83ebeagdec0948690863766f792ead24d61fe3f9
          minLength: 1
        name:
          type: string
          pattern: '[a-zA-Z0-9 -''.,]*'
          description: Name of the School.
          example: College University
          minLength: 1
        degree:
          type: string
          description: Degree awarded to the Candidate.
          example: BA
        year_awarded:
          type: integer
          description: Year in which the degree was awarded.
          example: 2017
          minLength: 1
        major:
          type: string
          pattern: '[a-zA-Z0-9 -''.,]*'
          description: Candidate’s major.
          example: Russian Literature
        phone:
          type:
          - string
          - 'null'
          description: School's phone number.
          example: 415-111-1111
        minor:
          type: string
          description: Candidate’s minor.
          example: Background Checks
        start_date:
          type: string
          description: Candidate’s start date with the School.
          format: date
          example: '2012-09-22'
        end_date:
          type: string
          description: Candidate’s end date with the School.
          format: date
          example: '2017-05-10'
        current:
          type: boolean
          description: Defines whether the Candidate is currently enrolled.
          default: false
        school_url:
          type: string
          description: School’s website.
          example: www.collegeuniversity.com
        address:
          $ref: '#/components/schemas/Address'
    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.
    Address:
      type: object
      properties:
        street:
          type: string
          pattern: '[a-zA-Z0-9 -''.,]*'
          description: Street address.
          example: 123 Main St.
        unit:
          type: string
          pattern: '[a-zA-Z0-9 -''.,]*'
          description: House, building or apartment number.
          example: 2000
        city:
          type: string
          pattern: '[a-zA-Z0-9 -''.,]*'
          description: City.
          example: San Francisco
        state:
          type: string
          description: State.
          example: CA
        zipcode:
          type: string
          description: 5-digit zip code.
          example: '90401'
        country:
          type: string
          description: 'Country.


            Format: `ISO 3166-1 alpha-2`

            '
          example: US
    UnauthorizedError:
      type: object
      properties:
        error:
          type: string
          example: Bad authentication error
  responses:
    School:
      description: School details
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/School'
    BadRequestError:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
    SchoolCreated:
      description: School was successfully created
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/School'
    ForbiddenError:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ForbiddenError'
    UnauthorizedError:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthorizedError'
    SchoolDeleted:
      description: School was successfully deleted
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/School'
    SchoolsList:
      description: List of Schools
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                items:
                  $ref: '#/components/schemas/School'
              object:
                type: string
                description: A list
                enum:
                - list
              next_href:
                type: string
                format: uri
  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)