Retrieving the DBS Form

Most of the data required for a DBS check is captured while the candidate is completing the DBS form during the Guestlink process. Following API end point will allow you retrieve this form to verify provided details.

Raw

Request

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

{
    "DeviceId": "device-id",
    "SessionId": "...",
    "ContainerId": "..."
}

For details, see the /dataAccess/retrieveDBSForm/ endpoint.

Response

This contains the actual data of the DBS form through the RetrieveDBSFormResponse.DBSForm property.

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

Note

See more details about the DBSForm here DbsForm.