Raising an Order

Client Entry Orders vs Candidate Entry Orders

There are two types of orders you can raise with Verifile: candidate entry order and client entry order.

Client entry order

With a client entry order, all the data required for the checks are passed directly to Verifile from the client for Verifile to start processing it immediately.

POST /api/v1/orders/cliententry
Candidate entry order

A candidate entry order differs in that we only need, at a minimum, a candidate’s name, date of birth, email address and the checks you wish to be carried out. When the order is placed, an email is sent to the candidate with log in details for the Verifile Web Application where we collect the required data from the candidate.

POST /api/v1/orders/candidateentry

Placing the new order

If the order is successfully placed, you will receive a 201 (Created) HTTP status code, a response body containing a unique Id which is the order number, the status of the order in the OrderState object with the name StateDescription and the status of each check in the CheckState object, again with the name StateDescription.

If it is a candidate order, an email will be sent to the value in the CandidateEmail field. An email will also be sent to the email account of the VerifileUserId to confirm that the order was placed; email preferences and content can be configured in the Verifile Web Application.

The order number is used to track the order within the Verifile Web Application. This is typically prefixed with “VF” when viewed in the Verifile Web Application, emails and reports.