Endpoint versions

The v2 endpoints are versioned individually (v1 or v2), with the version forming part of the request path (e.g. POST /addApplicant/v2).

Tip

API reference: View the v2 OpenAPI definition ›.

Version matrix

The version forms part of the request path for every v2 endpoint.

Submission

Endpoint	Payload	Notes
POST /addApplication/v2	XML	Full application submission (DBS Standard / Enhanced, DBS Basic, or DS Basic).
POST /addApplicant/v2	XML	Simplified applicant submission.
POST /addApplicantRequest/v2	JSON	Emails an invitation link to the applicant, who then completes their own forms. Sent as a single json POST parameter.

Results & status

Endpoint	Payload	Notes
POST /getResults/v2	JSON	Returns all completed check results for a given date (or date range).
POST /getResultReport/v1	JSON request, PDF response	Returns the raw bytes of a PDF report; response body is binary, not JSON.
POST /getStatus/v2	JSON	Returns the current processing status of in-progress DBS Basic and DBS Standard / Enhanced applications.
POST /getBarredResults/v1	JSON	Returns barred-list results for applications whose results match a requested date.

Choosing a version

• Add Applicant and Add Application are v2 only.

• A request without a recognised version is not processed.

Add Applicant vs Add Application

Add Applicant and Add Application share the same addApplicantV2 server implementation and core request, but differ in payload and in the range of application kinds they support:

• Add Application submits a full application in one of three formats — DBS Standard / Enhanced (with <PotentialEmployerDetails> and a full <RBdetails>: disclosure type, workforce and the vulnerable-adults / children / volunteer flags), DBS Basic, and DS Basic (Disclosure Scotland) (a <DSApplicationsBatch> payload with an <IDTypeVerified> identity block).

• Add Applicant is a simplified DBS submission: no <PotentialEmployerDetails> or <RBdetails>, a mandatory <MotherMaidenname>, and an optional <ApplicantIdentityDetails> limited to <NINumber>.

See the Add Application and Add Applicant pages for the complete request formats.