`DbsForm`

Represents a Dbs form.

DBS form is captured while the candidate is completing the DBS form during the Guestlink process.

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

The response message contains a list of DbsForm instances:

{
        "Success": true,
        "Message": "Operation executed successfully.",
        ...
        "DBSForm": {
          "AdditionalAddresses": [],
          "AdditionalInformation": null,
          "ApplicationReference": null,
          "ApplicationType": "Basic",
          "BirthSurname": null,
          "BirthSurnameChanged": false,
          "BirthSurnameUsedUntil": null,
          "CertificateAddress": null,
          "CertificateToCurrentAddress": false,
          "ConfirmReadPrivacyPolicyFlag": true,
          "ContainerId": "fbe22d20-a978-45b9-9ee9-5652462cdde4",
            "CurrentAddress": {
              "AddressLine1": "3 Street Name",
              "AddressLine2": "Leyland",
              "Country": "GBR",
              "County": "",
              "DateFrom": "\/Date(1577836800000+0000)\/",
              "DateTo": null,
              "Postcode": "PR12 5ay",
              "Town": "Leyland"
            },
          "CurrentNationality": null,
          "DBSConsentProvidedFlag": true,
          "DateOfBirth": "\/Date(500083200000+0000)\/",
          "DrivingLicenceCountryOfIssue": null,
          "DrivingLicenceIssueDate": null,
          "DrivingLicenceIssueType": "photo",
          "DrivingLicenceNumber": null,
          "Email": "mark.smith@trustid.co.uk",
          "Forename": "MARK",
          "Gender": "MALE",
          "Middlename1": "DAVID",
          "Middlename2": "",
          "Middlename3": "",
          "NINumber": null,
          "NationalityBirthChanged": false,
          "NationalityOfBirth": "GBR",
          "OtherNames": [],
          "PaperCertificate": false,
          "PassportCountryOfIssue": "GBR",
          "PassportIssueDate": "\/Date(1735689600000+0000)\/",
          "PassportNumber": "5554128211",
          "PlaceOfBirthCountry": "GBR",
          "PlaceOfBirthCounty": null,
          "PlaceOfBirthTown": "TOWN",
          "PositionAppliedFor": "TEST",
          "RecipientDepartment": null,
          "RecipientName": null,
          "Surname": "SMITH",
          "TelephoneNumber": null,
          "Title": "MR",
          "UnderstandWithdrawConsentFlag": true,
          "UnspentConvictions": null,
          "ValidPassport": true,
          "ValidUKDrivingLicence": false
        }
    }

The following list describes all properties of a DbsForm instance:

DBSForm.ApplicationType

= ApplicationType

The type of application being submitted (e.g., Basic, Standard / Enhanced).

DBSForm.Gender

= Gender

Applicant’s gender identity.

DBSForm.Title

= Title

Applicant’s title (e.g., Mr, Mrs, Dr).

DBSForm.Forename

= Forename

Applicant’s first name.

DBSForm.Middlename1

= Middlename1

Applicant’s first middle name, if any.

DBSForm.Middlename2

= Middlename2

Applicant’s second middle name, if any.

DBSForm.Middlename3

= Middlename3

Applicant’s third middle name, if any.

DBSForm.Surname

= Surname

Applicant’s current last name.

DBSForm.DateOfBirth

= DateOfBirth

Applicant’s date of birth.

DBSForm.ValidPassport

= ValidPassport

Indicates if the applicant has a valid passport.

DBSForm.PassportNumber

= PassportNumber

Applicant’s passport number.

DBSForm.PassportIssueDate: = PassportIssueDate

The date the applicant’s passport was issued.

DBSForm.PassportCountryOfIssue

= PassportCountryOfIssue

Country where the passport was issued.

DBSForm.ValidUKDrivingLicence

= ValidUKDrivingLicence

Indicates if the applicant has a valid UK driving licence.

DBSForm.DrivingLicenceCountryOfIssue

= DrivingLicenceCountryOfIssue

Country where the driving licence was issued.

DBSForm.DrivingLicenceIssueDate

= DrivingLicenceIssueDate

The date the driving licence was issued.

DBSForm.DrivingLicenceIssueType

= DrivingLicenceIssueType

Type/category of the driving licence issued.

DBSForm.DrivingLicenceNumber

= DrivingLicenceNumber

Driving licence number of the applicant.

DBSForm.NINumber

= NINumber

Applicant’s UK National Insurance Number.

DBSForm.TelephoneNumber

= TelephoneNumber

Applicant’s contact telephone number.

DBSForm.Email

= Email

Applicant’s email address.

DBSForm.CurrentAddress

= CurrentAddress

Applicant’s current residential address.

DBSForm.AdditionalAddresses

= AdditionalAddresses

List of previous addresses lived at by the applicant.

DBSForm.PlaceOfBirthTown

= PlaceOfBirthTown

Town or city where the applicant was born.

DBSForm.PlaceOfBirthCounty

= PlaceOfBirthCounty

County or region where the applicant was born.

DBSForm.PlaceOfBirthCountry

= PlaceOfBirthCountry

Country where the applicant was born.

DBSForm.NationalityOfBirth

= NationalityOfBirth

Applicant’s nationality at birth.

DBSForm.NationalityBirthChanged

= NationalityBirthChanged

Indicates if the applicant’s nationality has changed since birth.

DBSForm.CurrentNationality

= CurrentNationality

Applicant’s current nationality.

DBSForm.BirthSurnameChanged

= BirthSurnameChanged

Indicates if the applicant’s surname at birth has changed.

DBSForm.OtherNames

= OtherNames

List of any other names the applicant has been known by.

DBSForm.PositionAppliedFor

= PositionAppliedFor

The job or role the applicant is applying for.

DBSForm.PaperCertificate

= PaperCertificate

Whether a physical paper certificate is requested.

DBSForm.CertificateToCurrentAddress

= CertificateToCurrentAddress

Whether the certificate should be sent to the applicant’s current address.

DBSForm.RecipientName

= RecipientName

Name of the person who should receive the certificate.

DBSForm.RecipientDepartment

= RecipientDepartment

Department where the recipient works (if applicable).

DBSForm.CertificateAddress

= CertificateAddress

Address where the certificate should be sent.

DBSForm.UnspentConvictions

= UnspentConvictions

Indicates if the applicant has any unspent criminal convictions.

DBSForm.DBSConsentProvidedFlag

= DBSConsentProvidedFlag

Confirms if the applicant has given consent for a DBS check.

DBSForm.UnderstandWithdrawConsentFlag

= UnderstandWithdrawConsentFlag

Confirms if the applicant understands their right to withdraw consent.

DBSForm.ConfirmReadPrivacyPolicyFlag

= ConfirmReadPrivacyPolicyFlag

Confirms if the applicant has read and understood the privacy policy.

DBSForm.AdditionalInformation

= AdditionalInformation

Any other relevant information the applicant wishes to provide.

DBSForm.ApplicationReference

= ApplicationReference

A unique reference identifier for the application.

DBSForm.BirthSurname

= BirthSurname

Applicant’s surname at birth.

DBSForm.BirthSurnameUsedUntil

= BirthSurnameUsedUntil

Date until which the applicant used their birth surname.

DbsForm

`DbsForm`