Background check API

Introduction

Getting started

The Verified Credentials API is the latest set of tools to access our products and services in an integrated manner. This portal includes the information necessary to setup & configure your integration and includes specific API references, sample code, and a fully functional sandbox.

We make it easy to get started with the Verified Credentials API:

Current Customer

Notify your Account Manager directly and we will take all the necessary steps to activate your account and provide you with a team of integration specialists, if necessary.

New Customer / Other

Please send an email to clientservices@verifiedcredentials.com with all relevant information about your company, and the integration you wish to pursue, and we will contact you directly.

If you have any questions or issues relating to this documentation, please reach out to your dedicated Account Manager or contact our Client Services team at clientservices@verifiedcredentials.com.

Available screening workflows

Verified Credentials API offers (2) supported integration types based on the Applicant Tracking System (ATS) or Human Resources Information System (HRIS) unique needs:

One-Step Integration

The ATS/HRIS system collects ALL the information required to submit the background check order. Verified Credentials will assist in developing the required data elements based on your specific ordering requirements.

• Package – Product(s) – Account Information

  • Package Ordered

  • Product(s) Ordered

  • Customer Account Information & Authentication

  • Client Order Reference Number (Optional)

• Fields Collected Include (Based on package & products ordered):

  • Name(s)

  • Address(es)

  • Social Security Number / National ID Number

  • Date of Birth

  • Driver’s License Number & State

• Additional Product-Specific Fields - Required if any Employment; Academic, Reference, Professional License, or any other product requiring such information exists on the order:

  • Employer Name / Job Title / Start & End Date / Etc.

  • Academic Institution Name / Degree / Graduation Date / Etc.

  • Reference Name / Phone Number / Email Address / Etc.

  • License Agency Name / License Type / License Number / Etc.

The data elements required are based on the summation of ALL products contained on the order. Once the file request is received via the Create Background Check Order Request (POST) process, it will be validated, and the order placed if the minimum requirements are met.

• All data elements are sent from the ATS/HRIS system within (1) file.

• Candidate release forms are collected & maintained within the ATS/HRIS system (Not sent within the order file).

• The ‘Get Background Check Status (GET)’ can be invoked during the order process to receive status updates relating to the order.

• Upon order completion, a URL to the completed background report will be sent in the final status result.

Two-Step Integration

The ATS/HRIS system collects a MINIMUM set of information required to submit a background check applicant. The applicant will receive a direct email communication, and a link to supply ALL required information directly into the customer’s branded portal. Verified Credentials will assist in developing the required data elements and custom portal workflow based on your specific ordering requirements.

• Package – Product(s) – Account Information

  • Package Ordered

  • Product(s) Ordered

  • Customer Account Information & Authentication

  • Client Order Reference Number (Optional)

• Fields Collected Include:

  • Current Name

  • Email Address

ALL data elements required for order placement are completed by the applicant via the customer’s branded portal (2^nd Step).

• Minimum data elements are sent from ATS/HRIS system within (1) file.

• Required order & client release forms are signed/collected via the customer’s branded portal.

• The ‘Get Background Check Status (GET)’ can be invoked during the order process to receive status updates relating to the order.

• Upon order completion, a URL to the completed background report will be sent in the final status result.

API information & URLs

Create background check request (POST)

The following URLs are used to submit background check requests to Verified Credentials:

Testing / Quality Assurance

https://qa-atsapi.verifiedcredentials.com/bgcheck/5000

Production

https://atsapi.verifiedcredentials.com/bgcheck/5000

Create background check status (GET)

The following URLs are used to request background check status on submitted orders:

Testing / quality assurance

https://qa-atsapi.verifiedcredentials.com/bgcheck/5000/status/{id}

Production

https://atsapi.verifiedcredentials.com/bgcheck/5000/status/{id}

Note:  The {id} referenced in the URLs above is the initial ‘orderReference’ returned after successful order placement using the ‘Create Background Check Request (POST)’. The ‘orderReference’ must be saved within the ATS/HRIS system to invoke the ‘Create Background Check Status (GET).

Web service authentication

Web service requests via the API will be authenticated using Basic Web Service Authentication. Verified Credentials will provide all necessary credentials to access our Testing / Quality Assurance and Production environments. Contact your dedicated Account Manager or our Client Services team at clientservices@verifiedcredentials.com for more information.

Generic connector JSON formats

Create background check request (POST)

Note:  Required fields are in green and fields containing “null” are not required in final payload if information is not available (“Null” values are for reference purpose only and must be omitted when sending the background check request).  In addition, if a list does not have any values, it should be removed from the payload (Example: If there is no employment history, the entire “employment” list should be removed). 

Create background check response & status

Note: Use the ‘orderReference’ returned as {id} during GetStatus request.

Error messages