Get applicant information
There are five steps to follow to integrate the UK DBS service.
- Get applicant information
- Generate signed request
- Create the session
- Send instructions
- Generate results
The first step is not available via the API.
Get applicant information
In order to create a session you must first collect information about the customer including:
- Name of the applicant -
Hint This should be the applicants full legal name and MUST match what is on the ID document. Make this very clear to your users. - Address of the applicant - See applicant profile for structured address format.
- Date of birth of the applicant - This must be in yyyy-mm-dd format.
This information will be used to fill out the applicant profile, which is then cross referenced against the information on the customers documents when they are brought in for the checks.
Get Documents
In addition to the applicant information, you will also need the applicant to select the documents that they want to bring to be checked.
A list of documents that we support can be found here.
Branch look up
In order for the customer to know which branch to visit please use the Post Office branch look up API.
For further information around accessing this API, please contact support at clientsupport@yoti.com.