/dataAccess/initiateStandardOrEnhancedDbsCheck/

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

Request

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

    "ContainerId": "...",
    "ApplicationConsent": true,
    "EmployerName": "Employer Name",
    "CandidateOriginalDocumentsChecked": true,
    "CandidateAddressChecked": true,
    "CandidateDateOfBirthChecked": true,
    "EvidenceCheckedBy" : "Mark Smith",
    "EvidenceCheckedDate":"/Date(752457600000)/",
    "SelfDeclarationCheck" : true,

    "ApplicationType":"Standard",
    "PositionAppliedFor":"Tester",
    "Workforce":"Adult Workforce",
    "WorkingWithAdults": false,
    "WorkingWithChildren": false,
    "VulnerableGroupsAtPrivateHomeAddress": false,
    "Volunteer": false,
    "AdultFirst": false,
    "AdditionalInformation":"",
}

IinitiateStandardOrEnhancedDbsCheckRequest.ContainerId

= ContainerId

Unique identifier of the document container that is being initiated.

IinitiateStandardOrEnhancedDbsCheckRequest.ApplicationConsent

= ApplicationConsent

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

IinitiateStandardOrEnhancedDbsCheckRequest.EmployerName

= EmployerName

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

IinitiateStandardOrEnhancedDbsCheckRequest.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.

IinitiateStandardOrEnhancedDbsCheckRequest.CandidateAddressChecked

= CandidateAddressChecked

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

IinitiateStandardOrEnhancedDbsCheckRequest.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.

IinitiateStandardOrEnhancedDbsCheckRequest.EvidenceCheckedBy

= EvidenceCheckedBy

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

IinitiateStandardOrEnhancedDbsCheckRequest.EvidenceCheckedDate

= EvidenceCheckedDate

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

IinitiateStandardOrEnhancedDbsCheckRequest.SelfDeclarationCheck

= SelfDeclarationCheck

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

IinitiateStandardOrEnhancedDbsCheckRequest.ApplicationType

= ApplicationType

ApplicationType one of following options: - Standard, - Enhanced

IinitiateStandardOrEnhancedDbsCheckRequest.PositionAppliedFor

= PositionAppliedFor

Position applier for.

IinitiateStandardOrEnhancedDbsCheckRequest.Workforce

= Workforce

Set this property to true if Workfoce selected

IinitiateStandardOrEnhancedDbsCheckRequest.WorkingWithAdults

= WorkingWithAdults

Set this property to true if applicant is working with vulnerable adults.

IinitiateStandardOrEnhancedDbsCheckRequest.WorkingWithChildren

= WorkingWithChildren

Set this property to true if applicant is working with vulnerable adults

IinitiateStandardOrEnhancedDbsCheckRequest.VulnerableGroupsAtPrivateHomeAddress

= VulnerableGroupsAtPrivateHomeAddress

Set this property to true if applicant is working with vulnerable groups at home address.

IinitiateStandardOrEnhancedDbsCheckRequest.Volunteer

= Volunteer

Set this property to true if applicant is a volonteer.

IinitiateStandardOrEnhancedDbsCheckRequest.AdultFirst

= AdultFirst

Set this property to true if Adult First Check Required.

IinitiateStandardOrEnhancedDbsCheckRequest.AdditionalInformation

= AdditionalInformation

Additional Information.

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":"..."
            },

}