Initiating the DBS Application¶

Most of the data required for a DBS check is captured while the candidate is completing the DBS form during the Guestlink process. However additional information needs to be provided when the DBS check gets initiated.

The data needed depends on the level of DBS check the candidate requires (Basic or Standard/ Enhanced) and the Digital Scheme validation level the candidate application achieved.

Note

See how to interpret Digital Identification Scheme Results Digital Identification Scheme Result.

Initiating the Basic DBS Application¶

An application comprises three outcomes:

GPG45 Scheme = PASSED + ADDRESS VALIDATION = PASSED
In this outcome only the following information is required:
PurposeOfCheck

EmployerName

EmploymentSector (mandatory if Employment selected as the Purpose of Check)

Other (mandatory if Other selected as the Purpose of Check)

ApplicationConsent
GPG45 Scheme = PASSED + ADDRESS VALIDATION = FAILED / NOT PERFORMED
In this outcome all above are required plus following:
CandidateAddressChecked
GPG45 Scheme = FAILED [Manual Route]
In this outcome all above are required plus following:
CandidateOriginalDocumentsChecked

CandidateDateOfBirthChecked

EvidenceCheckedBy

EvidenceCheckedDate

SelfDeclarationCheck

Request

POST {{server}}/VPE/dataAccess/initiateBasicDbsCheck/
Content-Type: application/json

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

For details of the endpoint, see /dataAccess/initiateBasicDbsCheck/.

Response

{
  "Success": true,
  "Message": "Operation executed successfully.",
  "DbsCheckResult":{    "DBSReference": "...", "ErrorMessage": "..."}
}

var api = new TVS.Api();
api.login('username', 'password').then(function() {
    // Initiate Basic DBS Check
    return api.initiateBasicDbsCheck(containerId,{
    PurposeOfCheck: "",
    EmploymentSector: "",
    Other: "",
    ApplicationConsent: true,
    EmployerName: "",
    CandidateOriginalDocumentsChecked: "",
    CandidateAddressChecked: true,
    CandidateDateOfBirthChecked: true,
    EvidenceCheckedBy: true,
    EvidenceCheckedDate: true,
    SelfDeclarationCheck: true
    });
}).then(function(containerResponse) {
    console.log(containerResponse);
});

Initiating the Standard or Enhanced DBS Application¶

GPG45 Scheme = PASSED + ADDRESS VALIDATION = PASSED
In this outcome only the following information is required:
ApplicationType

EmployerName

PositionAppliedFor

Workforce

WorkingWithAdults

WorkingWithChildren

VulnerableGroupsAtPrivateHomeAddress

Volunteer

AdultFirst

AdditionalInformation

ApplicationConsent
GPG45 Scheme = PASSED + ADDRESS VALIDATION = FAILED / NOT PERFORMED
In this outcome all above are required plus following:
CandidateAddressChecked
GPG45 Scheme = FAILED [Manual Route]
In this outcome all above are required plus following:
CandidateOriginalDocumentsChecked

CandidateDateOfBirthChecked

EvidenceCheckedBy

EvidenceCheckedDate

SelfDeclarationCheck

Request

POST {{server}}/VPE/dataAccess/initiateStandardOrEnhancedDbsCheck/
Content-Type: application/json

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

For details of the endpoint, see /dataAccess/initiateStandardOrEnhancedDbsCheck/.

Response

{
  "Success": true,
  "Message": "Operation executed successfully.",
  "DbsCheckResult":{    "DBSReference": "...", "ErrorMessage": "..."}
}

var api = new TVS.Api();
api.login('username', 'password').then(function() {
    // Initiate Standard Or Enhanced DBS Check
    return api.initiateStandardOrEnhancedDbsCheck(containerId, {
    ApplicationType: "",
    PositionAppliedFor: "",
    Workforce: "",
    WorkingWithAdults: false,
    WorkingWithChildren: false,
    VulnerableGroupsAtPrivateHomeAddress: false,
    Volunteer: false,
    AdultFirst: false,
    AdditionalInformation: "",
    ApplicationConsent: true,
    EmployerName: "",
    CandidateOriginalDocumentsChecked: "",
    CandidateAddressChecked: true,
    CandidateDateOfBirthChecked: true,
    EvidenceCheckedBy: true,
    EvidenceCheckedDate: true,
    SelfDeclarationCheck: true
    });
}).then(function(containerResponse) {
    console.log(containerResponse);
});

DBS Result¶

If Dbs check is performed, each DocumentContainer has a field DbsStatus. This field can be used to quickly determine Dbs result to interpret result.

CertificateNumber - represents the certificate number, it becomes available once DBS has issued a certificate to the candidate. This is provided regardless of whether the result is “Clear” or “Not Clear.” It can be retrieved when the application reaches the APP_COMPLETE status.
Clear - represents a flag whether result is “Clear” or “Not Clear.
CompletedDate - represents the completed date.
DbsCustomerReference - represents the DBS customer reference, it becomes available once the application has been countersigned and sent to DBS. It can be retrieved from the point the application reaches the APP_RECEIVED status.
Reference - represents the initial reference before the application is submitted to DBS.
Status - represents the DBS application status.
SubmittedDate - represents the date when DBS application is submitted.
Timestamp - represents the timestamp.
Type - represents the type of the DBS application (Basic or Standard/ Enhanced).
WithdrawalBy - represents who withdrew the DBS application.
WithdrawalReason - describes the reason for the application’s withdrawal.

Response

"DbsStatus": {
    "CertificateNumber": null,
    "Clear": null,
    "CompletedDate": null,
    "DbsCustomerReference": null,
    "Reference": "949WALK10369",
    "Status": "FORM_COMPLETE",
    "SubmittedDate": null,
    "Timestamp": "\/Date(1745571631360+0100)\/",
    "Type": "Basic",
    "WithdrawalBy": null,
    "WithdrawalReason": null
},

Interpreting DBS Status Results¶

Result code	Name	Description	TrustID Interpretation
`FORM_READY`	Submitted by applicant	Submitted by applicant, ready for processing	DBS Check Initiated
`FORM_COMPLETE`	Ready for RB to countersign	Ready for RB to countersign	DBS Check In Progress
`FORM_AUTHORISED`	Countersigned	Countersigned, ready for sending to checking authority (e.g. DBS)	DBS Check In Progress
`APP_SENT`	Sent to DBS	Sent to checking authority (e.g. DBS)	DBS Check In Progress
`FORM_INVALID`	Form Invalid	Invalid, was not sent to checking authority (e.g. DBS)	DBS Check In Progress
`APP_RECEIVED`	Countersigned	Received (receipted) by checking authority (e.g. DBS)	DBS Check In Progress
`APP_REJECTED`	Received by DBS	Rejected by checking authority (e.g. DBS) due to errors, needs correcting and resending	DBS Check Rejected
`APP_COMPLETE`	Application completed by DBS	Completed by checking authority (e.g. DBS), result is available	DBS Check Complete
`APP_WITHDRAWN`	Withdrawn from eBulkPlus	Withdrawn from eBulkPlus	BS Check Withdrawn
`AWAITING_DIGITAL_ID`	Awaiting Digital Id Result	Awaiting Digital Id Result	DBS Check In Progress
`AWAITING_MEDIA_CHECK`	Awaiting Media check	Awaiting Media check, waiting to be submit to the SP Index	DBS Check In Progress