Making your end-to-end Onboarding process as easy as possible is a crucial element in attracting great employees and reducing candidate dropout rates.
The purpose of our API is to provide you with the ability to integrate your applications and processes with the KnowYourPeople checks and services.
The GBG KnowYourPeople API gives you access to the following checks:
The API can be used for creating, managing and submitting KYP applications (one or more of the pre-employment background checks provided by our service) and for obtaining the results of those checks.
Our API enables you to pick and choose how much or how little you want to integrate with us.
Create a new application (or edit the configuration of an existing application). This involves specifying who the application is for, who will be completing it (yourself or the applicant), what checks are to be performed as part of the application and any other additional data to be captured like custom tags or DVLA electronic declaration requirements.
The API enables you to search for people and organisations. Applications and check details can be searched for using a comprehensive set of filters.
This involves retrieving the application form and submitting all the data required on that form for the requested checks. Additional steps such as applicant confirmation, verification and countersigning, withdrawal etc.
Obtain the results for whole applications or specific checks. Helper APIs are provided to obtain information around DVLA check results (licence statuses, entitlements, endorsements and restrictions).
All communication to the KnowYourPeople web service is secured using HTTPS.
Due to the sensitive nature of the data accessible in KnowYourPeople, any access to the web services requires authentication.
When appropriate, you’ll be set up with a Client ID and secret which will enable you to request a Bearer Token. Access to the API is not possible without this information.
Once you’ve requested and been granted access to the Developer Portal:
Our Customer Success team and API specialists will ensure that you’re fully supported and the solution created is as streamlined as possible.
The following documents will help you to gain an understanding of the KnowYourPeople platform.