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

InitiateStandardOrEnhancedDbsCheckRequest.ContainerId

= ContainerId

Unique identifier of the document container that is being initiated.

InitiateStandardOrEnhancedDbsCheckRequest.ApplicationConsent

= ApplicationConsent

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

InitiateStandardOrEnhancedDbsCheckRequest.EmployerName

= EmployerName

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

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

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

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

InitiateStandardOrEnhancedDbsCheckRequest.EvidenceCheckedBy

= EvidenceCheckedBy

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

InitiateStandardOrEnhancedDbsCheckRequest.EvidenceCheckedDate

= EvidenceCheckedDate

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

InitiateStandardOrEnhancedDbsCheckRequest.SelfDeclarationCheck

= SelfDeclarationCheck

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

InitiateStandardOrEnhancedDbsCheckRequest.ApplicationType

= ApplicationType

ApplicationType one of following options: - Standard, - Enhanced

InitiateStandardOrEnhancedDbsCheckRequest.PositionAppliedFor

= PositionAppliedFor

Position applier for.

InitiateStandardOrEnhancedDbsCheckRequest.Workforce

= Workforce

Set this property to true if Workfoce selected

InitiateStandardOrEnhancedDbsCheckRequest.WorkingWithAdults

= WorkingWithAdults

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

InitiateStandardOrEnhancedDbsCheckRequest.WorkingWithChildren

= WorkingWithChildren

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

InitiateStandardOrEnhancedDbsCheckRequest.VulnerableGroupsAtPrivateHomeAddress

= VulnerableGroupsAtPrivateHomeAddress

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

InitiateStandardOrEnhancedDbsCheckRequest.Volunteer

= Volunteer

Set this property to true if applicant is a volonteer.

InitiateStandardOrEnhancedDbsCheckRequest.AdultFirst

= AdultFirst

Set this property to true if Adult First Check Required.

To conduct an Adult First check, your user account must have the required permissions. You can contact TrustID customer services to confirm this.

If you don’t have the required permission, you will receive the following error message.

“Adult First Checks are disabled on your account, and you need to contact TrustID support”

Please note, Adult First Checks can only be performed when working with Adults, therefore

= WorkingWithAdults needs to be set to true

otherwise following error will be displayed:

“Adult First Checks can only be performed when working with Adults.”

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

}