Introduction


This is a guide for developers wishing to use the Verifile API. It will guide you through setting up an API account and accessing an API subscription key, the API methods available and how to structure the data for each request.

Currently you can raise an order, check its progress and get the interim and final report of the order. Each order can contain a number of checks and is for a single candidate.

A check is a type of verification that can be performed on a person or an organisation. A list of available checks will be supplied along with this document.

An order can be raised as client entry (you have all the data required about the candidate to start the process) or a candidate entry (Verifile emails the candidate direct and requests them to input the data required themselves).

Supporting documentation can be uploaded to an order that contains information to help process the order.

The orders created in the API are compatible with Verifile’s current web site, so orders raised via the API can be seen and tracked in the same way they are currently in the Verifile Web Application.

Dictionary


Below is a list of terms used when discussing the Verifile API

Client developer A consumer of the API.
Client user A user that acts on behalf of the organisation to create new orders.
Candidate The person to whom the background check is being performed on.
Order A series of checks to be performed on a single candidate.
Check An area of background research on a candidate. It is possible for same type of check to be performed in the same order. An example of this could be 2 Employment History Checks for a candidate against two different previous employers.
Final Report The collection of findings from Verifile about the candidate for each check performed.
Interim Report The final report before it is complete. Some checks complete at different speeds so it is possible to see some of the results before the final report is formally issued.
Verifile Web Application The operational website of Verifile. It is the portal that candidates use to enter data and client users can use to track order progress.