Checkr Professional License Verification API

openapi: 3.2.0
info:
  version: v1
  title: Checkr.com API Docs Professional License Verification 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: Professional License Verification
  description: Use a Professional License Verification to verify a candidate's professional credentials.
paths:
  /professional_license_verifications/{id}:
    parameters:
    - name: id
      in: path
      description: ID of the Professional License Verification to retrieve.
      required: true
      schema:
        type: string
    get:
      tags:
      - Professional License Verification
      summary: Retrieve an existing Professional License Verification
      description: Returns an existing Professional License Verification with the input ID.
      operationId: getProfessionalLicenseVerification
      security:
      - basic_auth: []
      responses:
        '200':
          $ref: '#/components/responses/ProfessionalLicenseVerification'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
components:
  schemas:
    ResourceURI:
      type: string
      description: URI of the resource.
      readOnly: true
    ProfessionalLicenseVerification:
      allOf:
      - $ref: '#/components/schemas/ScreeningsGenericPayload'
      - type: object
        properties:
          object:
            enum:
            - professional_license_verification
          uri:
            example: /v1/professional_license_verifications/5ee1b0c080c74df951ce6a59
          status:
            type: string
            description: if `clear` a valid active license was found matching the candidate's PII.
            enum:
            - pending
            - clear
            - consider
            example: consider
          result:
            type:
            - string
            - 'null'
            description: if `clear`, a valid active license was found matching the candidate's PII.
            enum:
            - clear
            - consider
            example: consider
          turnaround_time:
            example: 603216
          documents:
            type: array
            description: An array of documents captured for the Professional License Verification.
            items:
              $ref: '#/components/schemas/Document'
          certifications:
            type: array
            description: An array of candidate input objects and license verification results objects.
            items:
              allOf:
              - type: object
                properties:
                  result:
                    type: object
                    description: Certification result.
                    properties:
                      certification_issued_to:
                        type: string
                        description: Certification Holder.
                        example: Jersey John Smith
                      certification_issuer:
                        type: string
                        description: 'Certifying organization that issued the license. For example: "California: General".'
                        example: 'California: Care Providers'
                      certification_issuer_region:
                        type: string
                        description: Certifying organization's region or state.
                        example: CA
                      certification_expiration:
                        type: string
                        description: Certification's expiration date in MM/DD/YYYY format. Present only if certification is found.
                        example: 01/10/2019
                      verified_by:
                        type: string
                        description: 'Entity that verified the license.


                          `partner`: Verified by one of Checkr''s Professional License partners (most common).<br>

                          `none`: Candidate''s license was manually entered, and has not been verified.<br>

                          '
                        enum:
                        - partner
                        - none
                      sub_results:
                        type: array
                        description: An array of objects describing the results of verification data.
                        items:
                          allOf:
                          - type: object
                            properties:
                              name:
                                type: string
                                description: Certifying organization's name for the data returned.
                              value:
                                type: string
                                description: Certifying organization specific data value.
                        example:
                        - name: license_number
                          value: B1234567
                      sub_checks:
                        type: array
                        description: An array of objects describing the results of specific verification criteria.
                        items:
                          allOf:
                          - type: object
                            properties:
                              name:
                                type: string
                                description: '`not_expired`: Certification active.<br>

                                  `data_consistency`: Certification matches candidate PII.<br>

                                  `in_good_standing`: Certification not revoked.<br>

                                  `found`: Certification found given license identifier.<br>

                                  '
                                enum:
                                - not_expired
                                - data_consistency
                                - in_good_standing
                                - found
                              status:
                                type: string
                                enum:
                                - clear
                                - consider
                        example:
                        - name: not_expired
                          status: consider
                        - name: data_consistency
                          status: clear
                        - name: in_good_standing
                          status: clear
                        - name: found
                          status: clear
                  input:
                    type: object
                    description: Candidate input for license verification.
                    properties:
                      certification_issued_to:
                        type: string
                        description: Candidate name used in application for professional license verification.
                        example: Jersey John Smith
                      certification_issuer:
                        type: string
                        description: 'Certifying organization that issued the license. For example: "California: General".'
                        example: 'California: Care Providers'
                      license_number:
                        type: string
                        description: Professional License Number.
                        example: B1234567
                      license_type:
                        type: string
                        description: Professional License type, as provided by the certification's issuer.
                        example: Nurse
                      certification_issuer_website:
                        type: string
                        description: Certifying organization's website.
                        example: https://www.bpelsg.ca.gov/
                      additional_text:
                        type: string
                        description: Additional information provided by the candidate for their manually entered license.
                        example: License expires on 01-01-2050
                  candidate_documents:
                    type: array
                    description: An array of documents uploaded by the candidate
                    items:
                      $ref: '#/components/schemas/Document'
    ForbiddenError:
      type: object
      properties:
        error:
          type: string
          example: You do not have permission to access the requested resource
    AssessmentAttribute:
      type:
      - string
      - 'null'
      description: 'The assessment for this screening. This field will be non-null only for Assess-enabled accounts. For accounts with Assess enabled, it will be null for reports completed before Assess was enabled, and null for a short time after report completion while the account''s Assess rules are applied.

        '
      enum:
      - eligible
      - review
      - escalated
      example: eligible
    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
    ScreeningsGenericPayload:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ResourceId'
        object:
          type: string
        uri:
          allOf:
          - $ref: '#/components/schemas/ResourceURI'
        status:
          type: string
          description: 'Status of the screening.

            '
          enum:
          - pending
          - complete
          - canceled
          - suspended
          example: complete
        result:
          type:
          - string
          - 'null'
          description: Result of the screening.
          enum:
          - clear
          - consider
          example: clear
        assessment:
          allOf:
          - $ref: '#/components/schemas/AssessmentAttribute'
        created_at:
          type: string
          description: Time at which the screening was created.
          format: date-time
          example: '2014-01-18T12:34:00Z'
        completed_at:
          type: string
          description: Time at which the screening was completed.
          format: date-time
          example: '2014-01-18T12:35:30Z'
        turnaround_time:
          type: integer
          description: Number of seconds the screening took to complete, calculated from `created_at` to `completed_at`.
        cancellation_reason:
          type: string
          description: See [cancellation reasons](#section/Reference/Cancellation-Reasons) section for possible values.
          example: complete_now_customer_requested
        cancellation_reason_description:
          type: string
          description: See [cancellation reasons](#section/Reference/Cancellation-Reasons) section for possible values.
          example: Customer requested Complete Now prior to screening completion
    ResourceId:
      type: string
      example: e44aa283528e6fde7d542194
      readOnly: true
      description: ID of the resource.
    UnauthorizedError:
      type: object
      properties:
        error:
          type: string
          example: Bad authentication error
  responses:
    ProfessionalLicenseVerification:
      description: Professional License Verification details
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProfessionalLicenseVerification'
    ForbiddenError:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ForbiddenError'
    UnauthorizedError:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthorizedError'
  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)