API Reference

Create Or Refresh Profile DBS Check

post
https://app.credentially.io/gateway/api/dbs/

Creates or refreshes a DBS check for the requested profile in the authenticated organisation context. The public profileId path parameter maps to the upstream employeePublicId. Provide the certificate details exactly as shown on the DBS certificate.

Rate Limit: profile-dbs-load (100 req / 1s)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Credentially profile ID. This maps to the upstream employeePublicId.

Body Params

Certificate details used to create or refresh the DBS check

string
required
length ≥ 1
\d{12}

DBS certificate number

date
required

Profile birth date

string
required
length between 0 and 60
^[A-Za-z0-9\- ']*$

Profile surname used for the DBS request

date

Issue date to send when no downstream print date is returned

Headers
string
enum
Defaults to 2.0.0
Allowed:
Responses

400

Invalid request data

404

Profile not found in the authenticated organisation context

429

Too many DBS refresh attempts for the submitted certificate

500

Internal server error

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*

Updated 3 months ago

Did this page help you?