Standard API Request and Response Formats

Verified First provides an API that allows access to client data for full or partial integrations with various partner systems. We also provide standard request and response formats that can be used to:

Place orders and retrieve order information

Retrieve account information and product information

Create, modify, or delete packages and users

Verified First provides endpoints for both production and staging/test environments:

All new integrations and API connections must first be implemented and reviewed in the Staging/Test Environment. In order to successfuly implement and review in Staging/Test environment, you must meet the following requirements:

There must be a user account in both the Verified First Production and Staging Portals

You must coordinate with the Verified First Integrations team to configure, setup, and activate the formats. You can contact our Integrations Team at integrations@verifiedfirst.com to request a partial or full API integration with the Verified First platform.

The Verified First API provides a method to send order results to an external platform if the following items are provided from the external system:

API Endpoint

Authorization header or credentials to authenticate the message

The data sent from Verified First does not contain any Personally Identifiable Information (PII) and can be stored in external platforms without the worry of inadvertently releasing access to sensitive information.

products_ordered - The list of products contained in the selected package for the order

reference_code - Reference code associated with the order (optional)

status - The latest status of the order

Canceled - Order has been canceled by the vendor

Error - An error was generated when an order for a report was placed

Waiting on Applicant - Order has been created by the vendor

Invitation Sent - Invitation has been sent to applicant

Partially Ordered - Verified First Portal user has performed Pre-Pull tasks and has developed jurisdictions for the applicant, but has not completed the order

Ready to Order - Applicant has finished the invitation and the order is ready for review. Requires Account settings (Gear > Admin > Account > Review Process) to be set to either "Allow Both" or "Manual Order Only"

File Ordered - Background check file has been ordered

Partially Complete - At least one selected product has been completed for the file

Complete - The file has been completed and returned

state - The activation state of the order. Orders that are archived (either manually or by scheduled expiration) move from "Active" state to "Inactive" state. (Active/Inactive)

adjudication - Adjudication status of the order (this field will only have values populated if "status" is "Complete")

In Need of Review

Approved

Pre-Adverse Action

Adverse Action

url - Link to view order

order_completed_date - Date that the order was completed (will be filled when "status" is "Complete")

last_status_date - Date of the most up-to-date status

If you have any further questions, or need a product enabled on your account, please contact Verified First Client Services for assistance.