Skip to main content
API docs by Redocly

Access Checks API (1.0.0)

Download OpenAPI specification:Download

Introduction

This documentation is designed to provide assistance to Access Checks customers wishing to integrate with our API

The API allows you to submit and retrieve different check results.

Overview

This page sets out a high level overview of the integration that can be created between 3rd party applications & Access Checks.

Authentication

Generate Token

Request Body schema: application/json
required

The Request Body

grant_type
string
client_id
string <uuid>
client_secret
string

Responses

Request samples

Content type
application/json
{
  • "grant_type": "client_credentials",
  • "client_id": "127b241c-dd54-4442-b755-f2402f966270",
  • "client_secret": "<Enter Client Secret>"
}

Response samples

Content type
application/json
{
  • "access_token": "<JWT TOKEN>",
  • "token_type": "Bearer",
  • "expires_in": 3600
}

Adverse Financial Detail

Lookup addresses by postcode

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

postCode
required
string <= 10 characters

The postcode to lookup addresses for.

object (metaData)

Responses

Request samples

Content type
application/json
{
  • "postCode": "SE9 3PA",
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "totalResults": "2",
  • "addresses": [
    ]
}

Match Address

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

object (matchAddressRequestAddress)
object (metaData)

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "matchStatus": "UniqueMatch",
  • "addresses": [
    ]
}

Create

Authorizations:
bearer_auth
header Parameters
X-Check-Version
string
Enum: "current" "next"

Optional Check Version (Default: current)

Request Body schema: application/json
required

The Request Body

required
object (equifaxCandidate)
required
object (equifaxCandidateAddress)
required
object (metaData)

Responses

Request samples

Content type
application/json
{
  • "candidate": {
    },
  • "currentAddress": {
    },
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "00000000-0000-0000-0000-000000000000",
  • "data": {
    }
}

Results

Authorizations:
bearer_auth
query Parameters
uuid
string <uuid>

The UUID for the adverse financial detail results

backgroundCheckUuid
string <uuid>

Deprecated: Use 'uuid' instead. The Background Check UUID for the adverse financial detail results

Responses

Response samples

Content type
application/json
{
  • "checkId": 0,
  • "started": "2026-08-27T14:44:16.4526352Z",
  • "completed": "2026-08-27T14:49:16.4526359Z",
  • "status": "Pending",
  • "yourReference": "ABC123",
  • "customerName": "Example Customer",
  • "data": {
    }
}

Adverse Financial Summary

Lookup addresses by postcode

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

postCode
required
string <= 10 characters

The postcode to lookup addresses for.

object (metaData)

Responses

Request samples

Content type
application/json
{
  • "postCode": "SE9 3PA",
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "totalResults": "2",
  • "addresses": [
    ]
}

Match Address

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

object (matchAddressRequestAddress)
object (metaData)

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "matchStatus": "UniqueMatch",
  • "addresses": [
    ]
}

Create

Authorizations:
bearer_auth
header Parameters
X-Check-Version
string
Enum: "current" "next"

Optional Check Version (Default: current)

Request Body schema: application/json
required

The Request Body

required
object (equifaxCandidate)
required
object (equifaxCandidateAddress)
required
object (metaData)

Responses

Request samples

Content type
application/json
{
  • "candidate": {
    },
  • "currentAddress": {
    },
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "00000000-0000-0000-0000-000000000000",
  • "data": {
    }
}

Results

Authorizations:
bearer_auth
query Parameters
uuid
string <uuid>

The UUID for the adverse financial summary check results

backgroundCheckUuid
string <uuid>

Deprecated: Use 'uuid' instead. The Background Check UUID for the adverse financial summary check results

Responses

Response samples

Content type
application/json
{
  • "checkId": 0,
  • "started": "2026-08-27T14:44:16.4371447Z",
  • "completed": "2026-08-27T14:49:16.4371452Z",
  • "status": "Pending",
  • "yourReference": "ABC123",
  • "customerName": "Example Customer",
  • "data": {
    }
}

Adverse Media

Create

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

required
object (northRowPerson)
required
object (northRowAddress)
required
object (adverseMediaMetaData)

Responses

Request samples

Content type
application/json
{
  • "candidate": {
    },
  • "currentAddress": {
    },
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "00000000-0000-0000-0000-000000000000"
}

Results

Authorizations:
bearer_auth
query Parameters
uuid
required
string <uuid>

The UUID for the adverse media results

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Checks

Get Check Attachments

Authorizations:
bearer_auth
query Parameters
uuid
required
string <uuid>

The UUID of the check.

id
required
integer <int64>

The ID of the attachment.

Responses

Response samples

Content type
application/pdf
stream

Upload a customer logo

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

fileContents
string

Logo file contents in Base64

contentType
string

The MIME content type of the logo (e.g. image/png, image/jpeg)

Responses

Request samples

Content type
application/json
{
  • "fileContents": "string",
  • "contentType": "string"
}

Response samples

Content type
application/json
{
  • "customerId": 0,
  • "logoServeUrl": "string"
}

Delete a customer logo

Authorizations:
bearer_auth

Responses

Serve a customer logo

path Parameters
customerId
required
integer <int32>

The ID of the customer

Responses

DBS Basic England and Wales

Get Document Types

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

countryCode
required
string = 2 characters
route
integer <int32> [ 1 .. 2 ]
excludePassport
boolean
excludeDrivingLicence
boolean

Responses

Request samples

Content type
application/json
{
  • "countryCode": "GB",
  • "route": 1,
  • "excludePassport": false,
  • "excludeDrivingLicence": false
}

Response samples

Content type
application/json
{
  • "numberOfDocumentsRequired": 2,
  • "nextRoute": 2,
  • "documents": {
    }
}

Create

Authorizations:
bearer_auth
header Parameters
X-Check-Version
string
Enum: "current" "next"

Optional Check Version (Default: current)

Request Body schema: application/json
required

The Request Body

required
object (dbsEAndWCandidate)

The candidate on which to perform the check.

required
Array of objects (dbsEAndWAddress)

The addresses to check against.

required
object (dbsEAndWBirthDetails)

The required details of the candidate's birth.

object (dbsEAndWPassport)

The optional passport details of the candidate.

object (dbsEAndWDrivingLicence)

The optional driving licence details of the candidate.

Array of objects (disclosureIdentityDocument)

The optional identity document selections of the candidate.

Array of objects (disclosureOtherName)

The other names of the candidate if required.

hasReadPrivacyPolicy
boolean

Indicates that the candidate has read all necessary privacy policies.

hasSeenStatementOfFairProcessing
boolean

Indicates that the candidate has seen the statement of fair processing.

consentToObtainResult
boolean

Indicates that the candidate has consented to obtain the result.

candidateDeclarationHasUnspentConvictions
boolean

The candidate's declaration as to whether they have unspent convictions.

paperCertToCandidate
boolean

Indicates whether the paper certificate should be sent to the candidate.

required
object (paperCertificateRecipient)

The details of the paper certificate recipient, if not the candidate.

customerNameOnCert
boolean

Indicates whether the customer name should be printed on the certificate.

idVerifyName
required
string <= 60 characters

The name of the person who has verified the candidate's ID docs.

required
object (dbsEAndWSectionX)

Indicates the Section X information for this position.

purposeOfCheck
string

The purpose of the check. Default = 'Employment'

required
object (metaData)

Responses

Request samples

Content type
application/json
{
  • "candidate": {
    },
  • "addresses": [
    ],
  • "birthDetails": {
    },
  • "passport": {
    },
  • "drivingLicence": {
    },
  • "identityDocuments": [
    ],
  • "otherNames": [
    ],
  • "hasReadPrivacyPolicy": true,
  • "hasSeenStatementOfFairProcessing": true,
  • "consentToObtainResult": true,
  • "candidateDeclarationHasUnspentConvictions": false,
  • "paperCertToCandidate": false,
  • "paperCertRecipient": {
    },
  • "customerNameOnCert": true,
  • "idVerifyName": "John Doe",
  • "sectionX": {
    },
  • "purposeOfCheck": "employment",
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "a2820da8-4803-47ef-8829-f6ac951e91b4",
  • "data": {
    }
}

Results

Authorizations:
bearer_auth
query Parameters
uuid
string <uuid>

The Check UUID for the DBS Basic E&W results

backgroundCheckUuid
string <uuid>

Deprecated: Use 'uuid' instead. The Background Check UUID for the DBS Basic E&W results

Responses

Response samples

Content type
application/json
{
  • "checkId": 1,
  • "created": "2026-08-26T14:44:16.5146043Z",
  • "started": "2026-08-26T14:44:16.5146055Z",
  • "completed": "2026-08-27T14:44:16.5146055Z",
  • "status": "Completed",
  • "yourReference": "your-reference-123",
  • "customerName": "Example Customer",
  • "data": {
    }
}

DBS Enhanced

Get Document Types

Authorizations:
bearer_auth
header Parameters
X-Check-Version
string
Enum: "current" "next"

Optional Check Version (Default: current)

Request Body schema: application/json
required

The Request Body

route
required
integer or null <int32> [ 1 .. 3 ]
countryCode
required
string = 2 characters
isVolunteer
boolean or null
excludePassport
boolean
excludeDrivingLicence
boolean

Responses

Request samples

Content type
application/json
{
  • "route": 1,
  • "countryCode": "GB",
  • "isVolunteer": false,
  • "excludePassport": false,
  • "excludeDrivingLicence": false
}

Response samples

Content type
application/json
{
  • "numberOfDocumentsRequired": 1,
  • "nextRoute": 2,
  • "documents": {
    }
}

Get Position Setting

Authorizations:
bearer_auth
header Parameters
X-Check-Version
string
Enum: "current" "next"

Optional Check Version (Default: current)

Request Body schema: application/json
required

The Request Body

positionSettingId
integer or null <int32>
settingName
string

Responses

Request samples

Content type
application/json
{
  • "positionSettingId": 0,
  • "settingName": "Hospital"
}

Response samples

Content type
application/json
{
  • "count": 1,
  • "results": [
    ]
}

Get Postions

Authorizations:
bearer_auth
header Parameters
X-Check-Version
string
Enum: "current" "next"

Optional Check Version (Default: current)

Request Body schema: application/json
required

The Request Body

positionId
integer or null <int32>
positionName
string
levelOfCheck
string
workForceType
string
positionSettingId
integer or null <int32>
inUse
boolean or null

Responses

Request samples

Content type
application/json
{
  • "positionId": 1,
  • "positionName": "Nurse",
  • "levelOfCheck": "ENHANCED",
  • "workForceType": "ADULT",
  • "positionSettingId": 1,
  • "inUse": true
}

Response samples

Content type
application/json
{
  • "count": 1,
  • "results": [
    ]
}

Results

Authorizations:
bearer_auth
query Parameters
uuid
string <uuid>

The Check UUID for the disclosure services results

backgroundCheckUuid
string <uuid>

Deprecated: Use 'uuid' instead. The Background Check UUID for the disclosure services results

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create

Authorizations:
bearer_auth
header Parameters
X-Check-Version
string
Enum: "current" "next"

Optional Check Version (Default: current)

Request Body schema: application/json
required

The Request Body

required
object (dsEnhancedCandidate)

The candidate on which to perform the check.

required
Array of objects (dsEnhancedAddress)

The addresses to check against.

required
object (dsEnhancedBirthDetails)

The required details of the candidate's birth.

object (dsPassport)

The optional passport details of the candidate.

object (dsDrivingLicence)

The optional driving licence details of the candidate.

Array of objects (dsIdentityDocument)

The optional identity document selections of the candidate.

Array of objects (dsOtherName)

The other names of the candidate if required.

hasReadPrivacyPolicy
boolean

Indicates that the candidate has read all necessary privacy policies.

hasSeenStatementOfFairProcessing
boolean

Indicates that the candidate has seen the statement of fair processing.

consentToObtainResult
boolean

Indicates that the candidate has consented to obtain the result.

candidateDeclarationHasUnspentConvictions
boolean

Deprecated: The candidate's declaration as to whether they have unspent convictions. This property will be removed when current version is decommissioned.

candidateDeclarationHasUnprotectedConvictions
boolean

Deprecated: The candidate's declaration as to whether they have unprotected convictions. This property will be removed when current version is decommissioned.

paperCertToCandidate
boolean

Deprecated: Indicates whether the paper certificate should be sent to the candidate. This property will be removed when current version is decommissioned.

object (dsPaperCertificateRecipient)

Deprecated: The details of the paper certificate recipient, if not the candidate. This property will be removed when current version is decommissioned.

customerNameOnCert
boolean

Deprecated: Indicates whether the customer name should be printed on the certificate. This property will be removed when current version is decommissioned.

idVerifyName
required
string <= 60 characters

The name of the person who has verified the candidate's ID docs.

required
object (dsEnhancedSectionX)

Indicates the Section X information for this position.

purposeOfCheck
string

Deprecated: The purpose of the check. Default = 'Employment'. This property will be removed when current version is decommissioned.

currentAddressChecked
boolean

Deprecated: Indicates whether the candidate's current address is checked. This property will be removed when current version is decommissioned.

dsOrganisationId
integer <int32>

Deprecated: The organisation ID for Disclosure Scotland. This property will be removed when current version is decommissioned.

required
object (metaData)

Responses

Request samples

Content type
application/json
{
  • "candidate": {
    },
  • "addresses": [
    ],
  • "birthDetails": {
    },
  • "passport": {
    },
  • "drivingLicence": {
    },
  • "identityDocuments": [
    ],
  • "otherNames": [
    ],
  • "hasReadPrivacyPolicy": true,
  • "hasSeenStatementOfFairProcessing": true,
  • "consentToObtainResult": true,
  • "candidateDeclarationHasUnspentConvictions": false,
  • "candidateDeclarationHasUnprotectedConvictions": false,
  • "paperCertToCandidate": false,
  • "paperCertRecipient": {
    },
  • "customerNameOnCert": true,
  • "idVerifyName": "John Doe",
  • "sectionX": {
    },
  • "purposeOfCheck": "employment",
  • "currentAddressChecked": true,
  • "dsOrganisationId": 894,
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "12345678-1234-1234-1234-123456789012",
  • "data": {
    }
}

Patch

Authorizations:
bearer_auth
path Parameters
uuid
required
string

The UUID of the check to patch

Request Body schema: application/json
required

The Request Body

required
object (dsEnhancedCandidate)

The candidate on which to perform the check.

required
Array of objects (dsEnhancedAddress)

The addresses for the candidate.

required
object (dsEnhancedBirthDetails)

The required details of the candidate's birth.

object (dsPassport)

The optional passport details of the candidate.

object (dsDrivingLicence)

The optional driving licence details of the candidate.

Array of objects (dsIdentityDocument)

The candidate's identity document selections.

Array of objects (dsOtherName)

The candidate's other names.

idVerifyName
required
string <= 60 characters

The name of the person who has verified the candidate's ID docs.

required
object (dsEnhancedSectionX)

Indicates the Section X information for this position.

object (metaData)

Responses

Request samples

Content type
application/json
{
  • "candidate": {
    },
  • "addresses": [
    ],
  • "birthDetails": {
    },
  • "passport": {
    },
  • "drivingLicence": {
    },
  • "identityDocuments": [
    ],
  • "otherNames": [
    ],
  • "idVerifyName": "John Doe",
  • "sectionX": {
    },
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "12345678-1234-1234-1234-123456789012"
}

Get Rejections

Authorizations:
bearer_auth
query Parameters
pageNumber
integer <int32>

Page number (default: 1)

pageSize
integer <int32>

Page size (default: 10)

demoMode
boolean

Enable demo mode (default: false)

sandboxMode
boolean

Enable sandbox mode (default: false)

Responses

Response samples

Content type
application/json
{
  • "rejections": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "totalPages": 0
}

DBS Standard

Get Document Types

Authorizations:
bearer_auth
header Parameters
X-Check-Version
string
Enum: "current" "next"

Optional Check Version (Default: current)

Request Body schema: application/json
required

The Request Body

route
required
integer or null <int32> [ 1 .. 3 ]
countryCode
required
string = 2 characters
isVolunteer
boolean or null
excludePassport
boolean
excludeDrivingLicence
boolean

Responses

Request samples

Content type
application/json
{
  • "route": 1,
  • "countryCode": "GB",
  • "isVolunteer": false,
  • "excludePassport": false,
  • "excludeDrivingLicence": false
}

Response samples

Content type
application/json
{
  • "numberOfDocumentsRequired": 1,
  • "nextRoute": 2,
  • "documents": {
    }
}

Get Position Setting

Authorizations:
bearer_auth
header Parameters
X-Check-Version
string
Enum: "current" "next"

Optional Check Version (Default: current)

Request Body schema: application/json
required

The Request Body

positionSettingId
integer or null <int32>
settingName
string

Responses

Request samples

Content type
application/json
{
  • "positionSettingId": 0,
  • "settingName": "Hospital"
}

Response samples

Content type
application/json
{
  • "count": 1,
  • "results": [
    ]
}

Get Postions

Authorizations:
bearer_auth
header Parameters
X-Check-Version
string
Enum: "current" "next"

Optional Check Version (Default: current)

Request Body schema: application/json
required

The Request Body

positionId
integer or null <int32>
positionName
string
levelOfCheck
string
workForceType
string
positionSettingId
integer or null <int32>
inUse
boolean or null

Responses

Request samples

Content type
application/json
{
  • "positionId": 1,
  • "positionName": "Nurse",
  • "levelOfCheck": "ENHANCED",
  • "workForceType": "ADULT",
  • "positionSettingId": 1,
  • "inUse": true
}

Response samples

Content type
application/json
{
  • "count": 1,
  • "results": [
    ]
}

Results

Authorizations:
bearer_auth
query Parameters
uuid
string <uuid>

The Check UUID for the disclosure services results

backgroundCheckUuid
string <uuid>

Deprecated: Use 'uuid' instead. The Background Check UUID for the disclosure services results

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

disclosureType
string

The level of disclosure check to perform

required
object (disclosureCandidate)

The candidate on which to perform the check.

Array of objects (disclosureAddress)

The addresses to check against.

object (disclosureBirthDetails)

The required details of the candidate's birth.

object (disclosurePassport)

The optional passport details of the candidate.

object (disclosureDrivingLicence)

The optional driving licence details of the candidate.

Array of objects (disclosureIdentityDocument)

The optional identity document selections of the candidate.

Array of objects (disclosureOtherName)

The other names of the candidate if required.

hasReadPrivacyPolicy
boolean

Indicates that the candidate has read all necessary privacy policies.

hasSeenStatementOfFairProcessing
boolean

Indicates that the candidate has seen the statement of fair processing.

consentToObtainResult
boolean

Indicates that the candidate has consented to obtain the result.

candidateDeclarationHasUnspentConvictions
required
boolean

The candidate's declaration as to whether they have unspent convictions.

candidateDeclarationHasUnprotectedConvictions
required
boolean

The candidate's declaration as to whether they have unprotected convictions.

paperCertToCandidate
required
boolean

Indicates whether the paper certificate should be sent to the candidate.

object (paperCertificateRecipient)

The details of the paper certificate recipient, if not the candidate.

customerNameOnCert
boolean

Indicates whether the customer name should be printed on the certificate.

idVerifyName
string

The name of the person who has verified the candidate's ID docs.

object (disclosurePositionSectionX)

Indicates the Section X information for this position.

purposeOfCheck
string

The purpose of the check. Default = 'Employment'

currentAddressChecked
boolean

Indicates whether the candidate's current address is checked.

dsOrganisationId
integer <int32>

The ID of the DS organisation to perform the check.

object (metaData)

Responses

Request samples

Content type
application/json
{
  • "disclosureType": "DBS Standard",
  • "candidate": {
    },
  • "addresses": [
    ],
  • "birthDetails": {
    },
  • "passport": {
    },
  • "drivingLicence": {
    },
  • "identityDocuments": [
    ],
  • "otherNames": [
    ],
  • "hasReadPrivacyPolicy": true,
  • "hasSeenStatementOfFairProcessing": true,
  • "consentToObtainResult": true,
  • "candidateDeclarationHasUnspentConvictions": false,
  • "candidateDeclarationHasUnprotectedConvictions": false,
  • "paperCertToCandidate": false,
  • "paperCertRecipient": {
    },
  • "customerNameOnCert": true,
  • "idVerifyName": "John Doe",
  • "sectionX": {
    },
  • "purposeOfCheck": "employment",
  • "currentAddressChecked": true,
  • "dsOrganisationId": 894,
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

DBS Update Service

Create

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

organisationName
required
string <= 50 characters ^[^#]+$
requesterForename
required
string <= 50 characters ^(?!')[A-Za-z\s'-]+$
requesterSurname
required
string <= 50 characters ^(?!')[A-Za-z\s'-]+$
certificateNumber
required
string = 12 characters ^\d{12}$
applicantSurname
required
string <= 50 characters ^(?!')[A-Za-z\s'-]+$
applicantDateOfBirth
required
string <date> (dateOnly)

Date in the format YYYY-MM-DD

webhookBaseUrl
string
required
object (metaData)

Responses

Request samples

Content type
application/json
{
  • "organisationName": "Example Organisation Ltd",
  • "requesterForename": "John",
  • "requesterSurname": "Smith",
  • "certificateNumber": "123456789012",
  • "applicantSurname": "Doe",
  • "applicantDateOfBirth": "1990-01-15",
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "00000000-0000-0000-0000-000000000000",
  • "data": {
    }
}

Get DBS Update Service Results

Authorizations:
bearer_auth
query Parameters
uuid
string <uuid>

The UUID of the DBS Update Service check

checkUuid
string <uuid>

Deprecated: Use 'uuid' instead. The UUID of the DBS Update Service check

Responses

Response samples

Content type
application/json
{
  • "checkId": "12345678-1234-1234-1234-123456789012",
  • "created": "2026-08-26T14:44:16.5356817Z",
  • "started": "2026-08-26T14:45:16.5356831Z",
  • "completed": "2026-08-27T14:44:16.5356836Z",
  • "status": "Completed",
  • "yourReference": "REF-12345",
  • "customerName": "Example Customer",
  • "data": {
    }
}

Digital Identity - High

Generate Token

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

uuid
string <uuid>

The UUID for the digital identity check.

background_check_uuid
string <uuid>

Deprecated: Use 'uuid' instead. The Background Check UUID for the digital identity check.

Responses

Request samples

Content type
application/json
{
  • "uuid": "00000000-0000-0000-0000-000000000000"
}

Response samples

Content type
application/json
{
  • "token": "dummy_token",
  • "expiry": "2026-08-27T16:14:16.2425789Z"
}

Results

Authorizations:
bearer_auth
query Parameters
uuid
string <uuid>

The UUID for the digital identity results

backgroundCheckUuid
string <uuid>

Deprecated: Use 'uuid' instead. The Background Check UUID for the digital identity results

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create

Authorizations:
bearer_auth
header Parameters
X-Check-Version
string
Enum: "current" "next"

Optional Check Version (Default: current)

Request Body schema: application/json
required

The Request Body

required
object (onfidoCandidate)
required
object (onfidoCandidateAddress)
object (metaData)

Responses

Request samples

Content type
application/json
{
  • "candidate": {
    },
  • "currentAddress": {
    },
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "data": {
    }
}

Digital Identity - Medium

Generate Token

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

uuid
string <uuid>

The UUID for the digital identity check.

background_check_uuid
string <uuid>

Deprecated: Use 'uuid' instead. The Background Check UUID for the digital identity check.

Responses

Request samples

Content type
application/json
{
  • "uuid": "00000000-0000-0000-0000-000000000000"
}

Response samples

Content type
application/json
{
  • "token": "dummy_token",
  • "expiry": "2026-08-27T16:14:16.2425789Z"
}

Results

Authorizations:
bearer_auth
query Parameters
uuid
string <uuid>

The UUID for the digital identity results

backgroundCheckUuid
string <uuid>

Deprecated: Use 'uuid' instead. The Background Check UUID for the digital identity results

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create

Authorizations:
bearer_auth
header Parameters
X-Check-Version
string
Enum: "current" "next"

Optional Check Version (Default: current)

Request Body schema: application/json
required

The Request Body

required
object (onfidoCandidate)
object (metaData)

Responses

Request samples

Content type
application/json
{
  • "candidate": {
    },
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "baa5bc93-3f5b-4a3a-9772-db9165ce699e",
  • "data": {
    }
}

Directorship

Create

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

required
object (northRowPerson)
required
object (northRowAddress)
required
object (metaData)

Responses

Request samples

Content type
application/json
{
  • "person": {
    },
  • "currentAddress": {
    },
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "12345678-1234-1234-1234-123456789012",
  • "data": {
    }
}

Results

Authorizations:
bearer_auth
query Parameters
uuid
string <uuid>

The UUID of the directorship check.

backgroundCheckUuid
string <uuid>

Deprecated: Use 'uuid' instead. The UUID of the directorship check.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Driving Licence

Create

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

required
object (drivingLicencePerson)

The person getting the DrivingLicence check.

drivingLicenceNumber
string

The person's driving licence number.

object (metaData)

Responses

Request samples

Content type
application/json
{
  • "person": {
    },
  • "drivingLicenceNumber": "DOE99851010JLB94",
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "12345678-1234-1234-1234-123456789012",
  • "data": {
    }
}

Results

Authorizations:
bearer_auth
query Parameters
uuid
string <uuid>

The UUID of the driving licence check.

backgroundCheckUuid
string <uuid>

Deprecated: Use 'uuid' instead. The UUID of the driving licence check.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DS Basic Scotland

Get Document Types

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

route
integer <int32>
excludePassport
boolean
excludeDrivingLicence
boolean

Responses

Request samples

Content type
application/json
{
  • "route": 1,
  • "excludePassport": false,
  • "excludeDrivingLicence": false
}

Response samples

Content type
application/json
{
  • "numberOfDocumentsRequired": 2,
  • "nextRoute": 2,
  • "documents": {
    }
}

Create

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

disclosureType
string

The level of disclosure check to perform

object (dsBasicScotlandCandidate)

The candidate on which to perform the check.

Array of objects (disclosureAddress)

The addresses to check against.

object (disclosureBirthDetails)

The required details of the candidate's birth.

object (disclosurePassport)

The optional passport details of the candidate.

object (disclosureDrivingLicence)

The optional driving licence details of the candidate.

Array of objects (disclosureIdentityDocument)

The optional identity document selections of the candidate.

Array of objects (disclosureOtherName)

The other names of the candidate if required.

hasReadPrivacyPolicy
boolean

Indicates that the candidate has read all necessary privacy policies.

hasSeenStatementOfFairProcessing
boolean

Indicates that the candidate has seen the statement of fair processing.

consentToObtainResult
boolean

Indicates that the candidate has consented to obtain the result.

candidateDeclarationHasUnspentConvictions
required
boolean

The candidate's declaration as to whether they have unspent convictions.

paperCertToCandidate
required
boolean

Indicates whether the paper certificate should be sent to the candidate.

object (paperCertificateRecipient)

The details of the paper certificate recipient, if not the candidate.

customerNameOnCert
boolean

Indicates whether the customer name should be printed on the certificate.

idVerifyName
string

The name of the person who has verified the candidate's ID docs.

object (dsBasicScotlandSectionX)

Indicates the Section X information for this position.

purposeOfCheck
string

The purpose of the check. Default = 'Employment'

dsOrganisationId
integer <int32>

The ID of the DS organisation to perform the check.

object (metaData)

Responses

Request samples

Content type
application/json
{
  • "disclosureType": "DS Basic Scotland",
  • "candidate": {
    },
  • "addresses": [
    ],
  • "birthDetails": {
    },
  • "passport": {
    },
  • "drivingLicence": {
    },
  • "identityDocuments": [
    ],
  • "otherNames": [
    ],
  • "hasReadPrivacyPolicy": true,
  • "hasSeenStatementOfFairProcessing": true,
  • "consentToObtainResult": true,
  • "candidateDeclarationHasUnspentConvictions": false,
  • "paperCertToCandidate": false,
  • "paperCertRecipient": {
    },
  • "customerNameOnCert": true,
  • "idVerifyName": "John Doe",
  • "sectionX": {
    },
  • "purposeOfCheck": "employment",
  • "dsOrganisationId": 894,
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Results

Authorizations:
bearer_auth
query Parameters
uuid
string <uuid>

The Check UUID for the disclosure services results

backgroundCheckUuid
string <uuid>

Deprecated: Use 'uuid' instead. The Background Check UUID for the disclosure services results

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employment Reference

Create

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

object (employmentReferenceCandidate)
Array of objects (employmentReferenceReference)
object (metaData)

Responses

Request samples

Content type
application/json
{
  • "candidate": {
    },
  • "employmentReferences": [
    ],
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create

Authorizations:
bearer_auth
query Parameters
backgroundCheckUuid
required
string <uuid>

The Background Check UUID for the identity check results

Responses

Response samples

Content type
application/json
{
  • "references": [
    ]
}

Identity Check

Lookup addresses by postcode

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

postCode
required
string <= 10 characters

The postcode to lookup addresses for.

object (metaData)

Responses

Request samples

Content type
application/json
{
  • "postCode": "SE9 3PA",
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "totalResults": "2",
  • "addresses": [
    ]
}

Match Address

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

object (matchAddressRequestAddress)
object (metaData)

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "matchStatus": "UniqueMatch",
  • "addresses": [
    ]
}

Create

Authorizations:
bearer_auth
header Parameters
X-Check-Version
string
Enum: "current" "next"

Optional Check Version (Default: current)

Request Body schema: application/json
required

The Request Body

required
object (equifaxCandidate)
required
object (equifaxCandidateAddress)
required
object (metaData)

Responses

Request samples

Content type
application/json
{
  • "candidate": {
    },
  • "currentAddress": {
    },
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "00000000-0000-0000-0000-000000000000",
  • "data": {
    }
}

Results

Authorizations:
bearer_auth
query Parameters
uuid
string <uuid>

The UUID for the identity check results

backgroundCheckUuid
string <uuid>

Deprecated: Use 'uuid' instead. The Background Check UUID for the identity check results

Responses

Response samples

Content type
application/json
[
  • {
    }
]

MRZ Document Scan

Create

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

required
object (mrzDocumentScanCandidate)

The candidate on which to perform the check.

documentContents
required
string <= 27962026 characters

The Documents to be MRZ Scanned

object (metaData)

Responses

Request samples

Content type
application/json
{
  • "candidate": {
    },
  • "documentContents": "ZXhhbXBsZSBjb250ZW50",
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "00000000-0000-0000-0000-000000000000",
  • "data": {
    }
}

Results

Authorizations:
bearer_auth
query Parameters
uuid
required
string <uuid>

The Check UUID for the mrz document scan check results

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Rapid Employment Verification

Create

Authorizations:
bearer_auth
header Parameters
X-Check-Version
string
Enum: "current" "next"

Optional Check Version (Default: current)

Request Body schema: application/json
required

The Request Body

required
object (konfirCandidate)
required
object (konfirCandidateAddress)
required
Array of objects (konfirEmploymentReference)
Array of objects (konfirAcademicReference)
Array of objects (konfirGapReference)
required
object (konfirMetaData)

Responses

Request samples

Content type
application/json
{
  • "candidate": {
    },
  • "currentAddress": {
    },
  • "employmentReferences": [
    ],
  • "academicReferences": [
    ],
  • "gapReferences": [
    ],
  • "metaData": {}
}

Response samples

Content type
application/json
{
  • "uuid": "c5d6681c-f46b-4e95-875c-972b04488b77",
  • "data": {
    }
}

Results

Authorizations:
bearer_auth
query Parameters
uuid
string <uuid>

The UUID for the rapid employment verification results

backgroundCheckUuid
string <uuid>

Deprecated: Use 'uuid' instead. The Background Check UUID for the rapid employment verification results

Responses

Response samples

Content type
application/json
{
  • "checkId": 1,
  • "created": "2026-08-27T14:44:16.3944080Z",
  • "completed": "2026-08-27T14:44:16.3944084Z",
  • "status": "Completed",
  • "data": {
    }
}

Retry

Retry a failed check

Authorizations:
bearer_auth
query Parameters
backgroundCheckUuid
required
string <uuid>

The Background Check UUID for the check to retry

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "message": "string"
}

Right to Work Share Code

Create

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

shareCode
required
string = 9 characters ^[A-Za-z0-9]{9}$
dateOfBirth
string
companyName
required
string <= 100 characters
webhookBaseUrl
string
required
object (metaData)

Responses

Request samples

Content type
application/json
{
  • "shareCode": "ABC123DEF",
  • "dateOfBirth": "1996-08-27",
  • "companyName": "The Access Group",
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "00000000-0000-0000-0000-000000000000"
}

Get Right to Work Share Code Results

Authorizations:
bearer_auth
query Parameters
uuid
required
string <uuid>

The UUID of the Right to Work Share Code check

Responses

Response samples

Content type
application/json
{
  • "checkId": "12345678-1234-1234-1234-123456789012",
  • "created": "2026-08-26T14:44:16.2375221Z",
  • "started": "2026-08-26T14:45:16.2375440Z",
  • "completed": "2026-08-27T14:44:16.2375663Z",
  • "status": "Completed",
  • "yourReference": "REF-12345",
  • "customerName": "Example Customer",
  • "data": {
    }
}

Sanctions

Create

Authorizations:
bearer_auth
header Parameters
X-Check-Version
string
Enum: "current" "next"

Optional Check Version (Default: current)

Request Body schema: application/json
required

The Request Body

required
object (northRowPerson)
required
object (northRowAddress)
required
object (sanctionsMetaData)

Responses

Request samples

Content type
application/json
{
  • "candidate": {
    },
  • "currentAddress": {
    },
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "00000000-0000-0000-0000-000000000000",
  • "data": {
    }
}

Results

Authorizations:
bearer_auth
query Parameters
uuid
string <uuid>

The UUID for the sanctions check results

backgroundCheckUuid
string <uuid>

Deprecated: Use 'uuid' instead. The Background Check UUID for the sanctions check results

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Social Media

Create

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

required
object (socialMediaPerson)
checkType
string
Enum: "Essentials" "Plus"

The type of social media check. Either 'Essentials' or 'Plus'.

object (metaData)

Responses

Request samples

Content type
application/json
{
  • "person": {
    },
  • "checkType": "Essentials",
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "12345678-1234-1234-1234-123456789012",
  • "data": {
    }
}

Results

Authorizations:
bearer_auth
query Parameters
uuid
string <uuid>

The UUID of the Social Media Check.

backgroundCheckUuid
string <uuid>

Deprecated: Use 'uuid' instead. The UUID of the Social Media Check.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Webhooks

Results

Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
[]

Create

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

url
required
string
object
enabled
boolean or null
eventTypes
Array of strings

Responses

Request samples

Content type
application/json
{
  • "url": "https://example.com/",
  • "headers": {
    },
  • "enabled": true,
  • "eventTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0
}