Checkr Geos API

openapi: 3.2.0
info:
  version: v1
  title: Checkr.com API Docs Geos 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: Geos
  description: Represents a candidate geography.
paths:
  /geos:
    post:
      tags:
      - Geos
      summary: Create a new Geo
      description: 'Creates a new Geo resource.


        **Note**: Attempting to create a new Geo with the same name/state combination will result in an

        409 error'
      operationId: createGeo
      security:
      - basic_auth: []
      requestBody:
        $ref: '#/components/requestBodies/GeoCreate'
      responses:
        '201':
          $ref: '#/components/responses/GeoCreated'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '409':
          $ref: '#/components/responses/DuplicateGeoError'
      x-codeSamples:
      - lang: curl
        source: "$ curl -X POST https://api.checkr.com/v1/geos \\\n    -u 83ebeabdec09f6670863766f792ead24d61fe3f9: \\\n    -d name=San+Francisco \\\n    -d city=San+Francisco \\\n    -d state=CA\n"
    get:
      tags:
      - Geos
      summary: List existing Geos
      description: Returns a list of existing Geos with the input `name` or `state`.
      operationId: geosList
      security:
      - basic_auth: []
      parameters:
      - name: name
        in: query
        description: Returns all Geos with the input `name`.
        schema:
          type: string
      - name: state
        in: query
        description: Returns all Geos with the input state.
        schema:
          type: string
      - 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/GeosList'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
      x-codeSamples:
      - lang: curl
        source: "$ curl -X GET https://api.checkr.com/v1/geos \\\n    -u 83ebeabdec09f6670863766f792ead24d61fe3f9:\n"
  /geos/{id}:
    parameters:
    - name: id
      in: path
      description: ID of the Geo.
      required: true
      schema:
        type: string
    get:
      tags:
      - Geos
      summary: Retrieve an existing Geo
      description: Returns an existing Geo with the input ID.
      operationId: getGeo
      security:
      - basic_auth: []
      responses:
        '200':
          $ref: '#/components/responses/Geo'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
      x-codeSamples:
      - lang: curl
        source: "$ curl -X GET https://api.checkr.com/v1/geos/e44aa283528e6fde7d542194 \\\n    -u 83ebeabdec09f6670863766f792ead24d61fe3f9:\n"
    delete:
      tags:
      - Geos
      summary: Delete an existing Geo
      description: Deletes an existing Geo.
      operationId: deleteGeo
      security:
      - basic_auth: []
      responses:
        '204':
          $ref: '#/components/responses/GeoDeleted'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '409':
          $ref: '#/components/responses/UsedGeoError'
      x-codeSamples:
      - lang: curl
        source: "$ curl -X DELETE https://api.checkr.com/v1/geos/b719804dc15c655f8529a2f2 \\\n    -u 83ebeabdec09f6670863766f792ead24d61fe3f9:\n"
    post:
      tags:
      - Geos
      summary: Update an existing Geo
      description: 'Updates an existing Geo resource with the input `city`.

        `city` can only be added once.'
      operationId: updateGeo
      security:
      - basic_auth: []
      requestBody:
        $ref: '#/components/requestBodies/GeoUpdate'
      responses:
        '200':
          $ref: '#/components/responses/GeoUpdated'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '409':
          $ref: '#/components/responses/GeoCityUpdatedError'
      x-codeSamples:
      - lang: curl
        source: "$ curl -X POST https://api.checkr.com/v1/geos/b719804dc15c655f8529a2f2 \\\n    -u 83ebeabdec09f6670863766f792ead24d61fe3f9: \\\n    -d city=San+Francisco\n"
components:
  responses:
    Geo:
      description: Geo details
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Geo'
    GeoCreated:
      description: Geo was successfully created
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Geo'
    GeosList:
      description: List of Geos
      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/Geo'
    GeoDeleted:
      description: Geo was successfully deleted
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Geo'
    BadRequestError:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
    DuplicateGeoError:
      description: Duplicate geo
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DuplicateGeoError'
    UsedGeoError:
      description: Geo used
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UsedGeoError'
    ForbiddenError:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ForbiddenError'
    GeoUpdated:
      description: Geo was successfully updated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Geo'
    GeoCityUpdatedError:
      description: Geo city updated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GeoCityUpdatedError'
    UnauthorizedError:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthorizedError'
  schemas:
    ForbiddenError:
      type: object
      properties:
        error:
          type: string
          example: You do not have permission to access the requested resource
    Geo:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ResourceId'
        object:
          type: string
          enum:
          - geo
          readOnly: true
        uri:
          allOf:
          - $ref: '#/components/schemas/ResourceURI'
          example: /v1/geos/e44aa283528e6fde7d542194
        created_at:
          type: string
          description: Time at which the Geo was created.
          format: date-time
          example: '2015-01-18T12:34:00Z'
        name:
          type: string
          description: Human-readable name of the Geo.
          example: SF CA
        city:
          type: string
          description: City for the Geo.
          example: San Francisco
        state:
          type: string
          description: State for the Geo.
          example: CA
        deleted_at:
          type:
          - string
          - 'null'
          description: Time at which the Geo was deleted.
          format: date-time
          example: null
    DuplicateGeoError:
      type: object
      properties:
        error:
          type: string
          example: 'Duplicate geo, name: Napa, state: CA already exists'
    ResourceURI:
      type: string
      description: URI of the resource.
      readOnly: true
    BadRequestError:
      type: object
      properties:
        error:
          type: string
          example: Dl number 'F211165' does not match the license number format in CA
    ResourceId:
      type: string
      example: e44aa283528e6fde7d542194
      readOnly: true
      description: ID of the resource.
    UnauthorizedError:
      type: object
      properties:
        error:
          type: string
          example: Bad authentication error
    GeoCityUpdatedError:
      type: object
      properties:
        error:
          type: string
          example: Geo city can not be updated if city already exists
    UsedGeoError:
      type: object
      properties:
        error:
          type: string
          example: Geo can not be deleted as it is used by Candidates
  requestBodies:
    GeoCreate:
      content:
        application/json:
          schema:
            type: object
            required:
            - name
            - state
            properties:
              name:
                type: string
                description: Human-readable name of the Geo.
                example: San Francisco
              state:
                type: string
                description: US state for the Geo.
                example: CA
              city:
                type: string
                description: A major city within the input state.
                example: San Francisco
      required: true
    GeoUpdate:
      content:
        application/json:
          schema:
            type: object
            properties:
              city:
                type:
                - string
                - 'null'
                description: Updates the Geo with the input city.
                example: San Francisco
      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)