/dataAccess/initiateBasicDbsCheck/

Initiates Dbs application. This can only be done after an application has been completed and a result received.

Request

POST {{server}}/VPE/dataAccess/initiateBasicDbsCheck/
Content-Type: application/json
Tid-Api-Key: xxx-xxx-xx
{
    "DeviceId": "device-id",
    "SessionId": "...",

    "ContainerId": "...",
    "EmployerName": "Employer Name",
    "CandidateOriginalDocumentsChecked": true,
    "CandidateAddressChecked": true,
    "CandidateDateOfBirthChecked": true,

    "EvidenceCheckedBy": "Mark Smith",
    "EvidenceCheckedDate": "/Date(752457600000)/",
    "SelfDeclarationCheck": true,
    "ApplicationConsent": true,

    "PurposeOfCheck": "Employment",
    "EmploymentSector": "NHS",
            "Other": "..."
}
InitiateBasicDbsCheckRequest.ContainerId

= ContainerId

Unique identifier of the document container that is being initiated.

InitiateBasicDbsCheckRequest.EmployerName

= EmployerName

Optional: Name of the employer dbs application is submited under.

InitiateBasicDbsCheckRequest.CandidateOriginalDocumentsChecked

= CandidateOriginalDocumentsChecked

When GPG45Profile has not been achieved, this property needs to be set to true to confirm the candidate’s original documents have been manually checked.

InitiateBasicDbsCheckRequest.CandidateAddressChecked

= CandidateAddressChecked

When Address has not been verified, this property needs to be set to true to confirm the candidate’s current address has been manually checked.

InitiateBasicDbsCheckRequest.CandidateDateOfBirthChecked

= CandidateDateOfBirthChecked

When GPG45Profile has not been achieved, this property needs to be set to true to confirm the date of birth has been manually checked.

InitiateBasicDbsCheckRequest.EvidenceCheckedBy

= EvidenceCheckedBy

When GPG45Profile has not been achieved, this property needs to be set with details of person checking the evidence.

InitiateBasicDbsCheckRequest.EvidenceCheckedDate

= EvidenceCheckedDate

When GPG45Profile has not been achieved, this property needs to be set with date when the evidence has been checked.

InitiateBasicDbsCheckRequest.SelfDeclarationCheck

= SelfDeclarationCheck

Set this property to true if a self declaration has been received and false if not.

InitiateBasicDbsCheckRequest.ApplicationConsent

= ApplicationConsent

This property needs to be set to true to confirm the applicant has given their consent to submit a DBS application.

InitiateBasicDbsCheckRequest.PurposeOfCheck

= PurposeOfCheck

PurposeOfCheck, one of the following options:

  • Personal Interest,

  • Employment,

  • Other

InitiateBasicDbsCheckRequest.EmploymentSector

= EmploymentSector

EmploymentSector, one of the following options:

  • LOCAL GOVERNMENT,

  • CENTRAL GOVERNMENT,

  • PUBLIC SECTOR- OTHER,

  • NHS,

  • PRESCHOOL EDUCATION,

  • PRIMARY EDUCATION,

  • SECONDARY EDUCATION,

  • ACADEMY EDUCATION,

  • FURTHER EDUCATION,

  • HIGHER EDUCATION,

  • INDEPENDENT EDUCATION,

  • VOLUNTARY/CHARITY,

  • PRIVATE HEALTHCARE,

  • AGRICULTURE,

  • FORESTRY AND FISHING,

  • MINING AND QUARRYING,

  • MANUFACTURING,

  • RETAIL,

  • ENERGY AND AIR CONDITIONING,

  • WATER AND WASTE MANAGEMENT,

  • CONSTRUCTION,

  • TRADE OR REPAIR OF VEHICLES,

  • TRANSPORTATION AND STORAGE,

  • ACCOMMODATION AND FOOD SERVICE,

  • INFORMATION AND COMMUNICATION,

  • FINANCIAL AND INSURANCE,

  • REAL ESTATE ACTIVITIES,

  • PROFESSIONAL, TECHNICAL,

  • ADMINISTRATIVE AND SUPPORT,

  • SOCIAL CARE,

  • ARTS AND ENTERTAINMENT,

  • LEISURE, SPORT AND TOURISM,

  • FOSTER/ADOPTION,

  • CHILD CARE,

  • DRIVERS,

  • LAW ENFORCEMENT AND SECURITY,

  • RECRUITMENT AND HR

InitiateBasicDbsCheckRequest.Other

= Other

When the value Other is used as InitiateBasicDbsCheckRequest.PurposeOfCheck value, details explaining the purpose of the check need to be provided in this field.

See also

Digital Identification Scheme Result for more information about retrieving GPG45Profile (Digital Identification Scheme) result.

Response

{
    "Success": true,
    "Message": "Operation executed successfully.",

    "DbsCheckResult":
            {
                    "DBSReference":"...",
                    "ErrorMessage":"..."
            },

}