[CF]

The following article discusses the Verifile Global Background Check API, which can integrate into your own Applicant Tracking System.

TABLE OF CONTENTS

• What is an API?
• The Verifile Global Background Check API
• Benefits of API
• What is possible with the Verifile API?
• Costs
• Security
• Next steps

Verifile API Developer Portal - Sign up and discover.

Developer Documentation site.

With our API, you can simply and quickly access global background checks directly from your own platform, using a Modern REST and JSON architecture that supports minimal development time.

If you'd like to learn more about our API, please review our Developer Documentation site.

What is an API?

An Application-Programming Interface (API) is a set of programming instructions, standards, and tools for accessing a system by another system. The API can be made available to customers, suppliers, and partners so developers can link between systems.

The API allows two systems to exchange information and request services.

The Verifile Global Background Check API

Verifile’s API is a RESTful API and uses a data-transfer format called JSON to transfer data to a third-party system.

Our clients typically want to connect their Applicant Tracking System (ATS) with our system, and the Verifile API is designed for this purpose.

Sharing economy clients use our API to automate their authentication and screening processes without needing to run on two separate platforms.

Our API offers access to over 600 different background checks worldwide and the option to set up packages for easier deployment.

Benefits of API

An API can avoid the need for your team members to log into the Verifile system and your own ATS. By linking your ATS to our system, you can eliminate manual tasks, speed up processing times and avoid errors associated with manual data entry.

Orders can be placed at the click of a button. Updates on progress such as the traffic light results and final reports can be fed into the ATS without the need for manual checking and saving of reports from the system/email.

What is possible with the Verifile API?

You can integrate part of or the full workflow.

An order can be raised as client entry (you have all the data and consent to start checks) or a candidate entry (Verifile emails the candidate directly asking them to provide data and consent). Supporting documentation can be uploaded to an order.

The orders created in the API are compatible with Verifile’s web-based system, so orders raised via the API can be viewed and tracked in the same way as if you’d placed them manually (not via API).

Should your ATS encounter any technical difficulties, your team members can, in the meantime, use our portal for order placement, progress tracking, and report collection.

Costs

There is no cost to use Verifile's API.

You'll be provided with a sandbox and credentials for testing.

You can also ask us for support when building your integration, all at no cost.

If you would like Verifile to build the integration, please contact us to discuss the scope and cost.

Security

We use Azure API Management (APIM) which handles user authentication and key management. The overall security of the API has been verified via an independent security assessment performed by NCC Group.

Verifile has ISO 27001 and Cyber Essentials Plus certifications. We take information security seriously.

We will issue you with digital keys that will allow access to place orders and view your data on our system. You can change these keys at any time via the APIM portal.

It is critical that you keep these keys safe and reset the keys if any users at your organisation no longer need access to them.

Next steps

If you would like to learn more about our API, please review our Developer Documentation site.

This will provide your development team with detailed information on:

• Registration to obtain keys
• Live & Test API
• Headers
• Raising orders
• Order statuses
• Final reports
• Packages
• Attachments
• Helper methods
• Error messages

We will also provide product specific documents.

When your development team is ready, we will provide access to a sandbox. You can use this test environment to complete test scenarios whilst you are building the integration.

We’ll give you access to the live system once integration is complete and mandatory tests are passed.

Whilst we have taken care to ensure that this information is accurate, we update articles regularly. If you feel something is incorrect, please use the feedback buttons below to tell us how we could improve.e, Developer