Objects > DBSSearchSummary (DBS)

Parameters

Parameter Type Format Description
Id Int64   ID number of the search
DateSearched DateTime ISO 8601 The date the DBS search was created
DateUpdated DateTime ISO 8601 The date the DBS search was last updated
Status String   Status of the DBS search, one of the following values (items in bold are headings to show the grouping of status messages, and are NOT actual status values):
  • Waiting for Applicant
  • Application pending completion
  • Applicant information in progress (20%)
  • Applicant information in progress (40%)
  • Applicant information in progress (60%)
  • Applicant information in progress (80%)
  • Waiting for User
  • ID verification required
  • Submission required by ID checker
  • Waiting for Submission
  • Pending Submission to DBS
  • Sent to DBS: (XXX)
  • Waiting for Response
  • Received
  • Forwarded
  • Awaiting Disclosure
  • Disclosed (Email Pending)
  • Disclosed

"Sent to DBS" includes additional free-text information in brackets, if you want to detect this status you should check for the presence of the phrase "Sent to DBS" in the status string.

DisclosureStatus String   If the search has been disclosed, this will be the disclosure status.
IsApplicantInfoCompleted Boolean   Has the applicant has completed their information (true), or not (false).
IsIdCheckCompleted Boolean   Has the ID Checker has verified the applicant's ID (true), or not (false).
IsApplicationCompleted Boolean   Has the application been completed and is ready to be submitted (true), or not (false).
IsApplicationSubmitted Boolean   Has the application has been submitted (true), or not (false).
IsApplicationDisclosed Boolean   Has the application has been disclosed (true), or not (false).
DisclosureLevel String Max length 10 characters The disclosure level of the DBS, one of the following values:
  • Basic
  • Standard
ApplicantInformation ApplicantInformation   Instance of DBS ApplicantInformation see below

ApplicantInformation

Parameter Type Format Description
Name String Max length 250 characters The full name of the applicant
DateOfBirth String Max length 10 characters Date of birth for the applicant. DD/MM/YYYY format.
Email String Max length 250 characters The email address of the applicant
MobileInternational String Max length 15 characters The applicant's mobile phone number in international format (e.g. '+447123456789').
JobLocation String Max length 100 characters The country where the Job is located, one of the following values:
  • England
  • Northern Ireland
  • Scotland
  • Wales
Reference String Max length 250 characters Your reference