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": "d4053774-da8b-4f4a-930d-85cade6afefd",
  • "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-09-29T12:55:56.6165953Z",
  • "completed": "2026-09-29T13:00:56.6165958Z",
  • "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-09-29T12:55:56.4289530Z",
  • "completed": "2026-09-29T13:00:56.4289532Z",
  • "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": "e8188d74-1971-479c-9bc6-0b6ab302b127",
  • "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-09-28T12:55:56.6652281Z",
  • "started": "2026-09-28T12:55:56.6652287Z",
  • "completed": "2026-09-29T12:55:56.6652288Z",
  • "status": "Completed",
  • "yourReference": "your-reference-123",
  • "customerName": "Example Customer",
  • "data": {
    }
}

DBS Enhanced

Get Document Types

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

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

Responses

Request samples

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

Response samples

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

Get Position Setting

Authorizations:
bearer_auth
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
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
required
object (dbsEnhancedCandidate)
Array of objects (disclosureAddress)
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)
Array of objects (disclosureOtherName)
hasReadPrivacyPolicy
boolean
hasSeenStatementOfFairProcessing
boolean
consentToObtainResult
boolean
candidateDeclarationHasUnspentConvictions
boolean
candidateDeclarationHasUnprotectedConvictions
required
boolean
paperCertToCandidate
boolean
object (paperCertificateRecipient)

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

customerNameOnCert
boolean
idVerifyName
string
object (disclosurePositionSectionX)

Indicates the Section X information for this position.

purposeOfCheck
string
currentAddressChecked
boolean
dsOrganisationId
integer or null <int32>
object (metaData)

Responses

Request samples

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

Response samples

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

DBS Standard

Get Document Types

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

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

Responses

Request samples

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

Response samples

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

Get Position Setting

Authorizations:
bearer_auth
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
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-09-28T12:55:56.6804367Z",
  • "started": "2026-09-28T12:56:56.6804375Z",
  • "completed": "2026-09-29T12:55:56.6804379Z",
  • "status": "Completed",
  • "yourReference": "REF-12345",
  • "customerName": "Example Customer",
  • "data": {
    }
}

Digital Identity - High

Create

Creates a Trust ID Digital Right to Work High (H2B) check and returns the hosted URL in data.url. Demo-only checks complete automatically without candidate verification. With demoMode=true and sandboxMode=false, candidate.lastName selects HappyPath or NoMatch (case-insensitive, surrounding spaces ignored; other names use HappyPath). Live and supplier-sandbox checks are unaffected. See the Trust ID H2B High migration guide.

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

required
object (trustIdH2BCandidate)
object (trustIdH2BMetaData)

Responses

Request samples

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

Response samples

Content type
application/json
{}

Results

Returns cached Trust ID H2B results in the standard Access Checks layout: the supplier's native container shape under data.container, with data.reportUrl, data.documentImages and data.expired alongside. data.reportUrl links to the authenticated attachment download after asynchronous PDF storage succeeds. See the Trust ID H2B migration guide.

Authorizations:
bearer_auth
query Parameters
uuid
required
string <uuid>

The Access Checks UUID returned by the H2B initiation endpoint.

Responses

Response samples

Content type
application/json
Example
"[{\"checkId\":123,\"created\":\"2026-09-23T09:00:00.0000000Z\",\"started\":\"2026-09-23T09:00:00.0000000Z\",\"completed\":\"2026-09-23T09:01:00.0000000Z\",\"status\":\"Completed\",\"yourReference\":\"h2b-eu-passport\",\"customerName\":\"Example Customer\",\"data\":{\"container\":{\"AccessLock\":{\"AnonymousSessionId\":null,\"Locked\":false,\"Timestamp\":\"2026-01-15T13:26:14.0370000Z\",\"UserDisplay\":null,\"UserId\":null},\"AddressHistory\":[],\"ApplicantPhotoImage\":null,\"ApplicationFlexibleFieldList\":[{\"m_Item1\":{\"BranchId\":null,\"CreationDate\":\"0001-01-01T00:00:00.0000000Z\",\"DataRange\":\"450\",\"DataType\":1,\"DefaultValue\":null,\"DisplayName\":\"Guest Name\",\"EntityId\":null,\"FieldOrderIndex\":100,\"Flags\":3,\"FlexibleFieldId\":\"00000000-0000-0000-0000-000000000000\",\"HelpText\":\"Name of person sent a guest link.\",\"Id\":\"00000000-0000-0000-0000-000000000000\",\"IsActive\":false,\"IsEnabled\":true,\"IsGlobal\":true,\"IsValidationField\":false,\"LastModifield\":\"0001-01-01T00:00:00.0000000Z\",\"Mandatory\":false,\"Name\":\"__SYS_GuestName\",\"ValidationFailValue\":null,\"ValidationPassValue\":null,\"ValidationWarningValue\":null},\"m_Item2\":{\"BehaviourFlagsDup\":256,\"DataRangeDup\":null,\"DefaultValueDup\":null,\"DocumentContainerId\":\"00000000-0000-0000-0000-000000000000\",\"FieldOrderIndexDup\":0,\"FieldValueDate\":null,\"FieldValueDecimal\":null,\"FieldValueInt\":null,\"FieldValueString\":\"John Doe\",\"FlexibleFieldDataTypeIdDup\":1,\"FlexibleFieldDisplayNameDup\":\"Guest Name\",\"FlexibleFieldId\":\"00000000-0000-0000-0000-000000000000\",\"FlexibleFieldNameDup\":\"__SYS_GuestName\",\"FlexibleFieldVersionId\":\"00000000-0000-0000-0000-000000000000\",\"HelpTextDup\":null,\"MandatoryDup\":false,\"MandatoryIfValueListORDup\":null,\"Template\":{\"BranchId\":null,\"CreationDate\":\"0001-01-01T00:00:00.0000000Z\",\"DataRange\":\"450\",\"DataType\":1,\"DefaultValue\":null,\"DisplayName\":\"Guest Name\",\"EntityId\":null,\"FieldOrderIndex\":100,\"Flags\":3,\"FlexibleFieldId\":\"00000000-0000-0000-0000-000000000000\",\"HelpText\":\"Name of person sent a guest link.\",\"Id\":\"00000000-0000-0000-0000-000000000000\",\"IsActive\":false,\"IsEnabled\":true,\"IsGlobal\":true,\"IsValidationField\":false,\"LastModifield\":\"0001-01-01T00:00:00.0000000Z\",\"Mandatory\":false,\"Name\":\"__SYS_GuestName\",\"ValidationFailValue\":null,\"ValidationPassValue\":null,\"ValidationWarningValue\":null},\"ValidationStatus\":null}},{\"m_Item1\":{\"BranchId\":null,\"CreationDate\":\"0001-01-01T00:00:00.0000000Z\",\"DataRange\":\"320\",\"DataType\":1,\"DefaultValue\":null,\"DisplayName\":\"Guest Email Address\",\"EntityId\":null,\"FieldOrderIndex\":101,\"Flags\":3,\"FlexibleFieldId\":\"00000000-0000-0000-0000-000000000000\",\"HelpText\":\"Email address of person sent a guest link.\",\"Id\":\"00000000-0000-0000-0000-000000000000\",\"IsActive\":false,\"IsEnabled\":true,\"IsGlobal\":true,\"IsValidationField\":false,\"LastModifield\":\"0001-01-01T00:00:00.0000000Z\",\"Mandatory\":false,\"Name\":\"__SYS_GuestEmail\",\"ValidationFailValue\":null,\"ValidationPassValue\":null,\"ValidationWarningValue\":null},\"m_Item2\":{\"BehaviourFlagsDup\":256,\"DataRangeDup\":null,\"DefaultValueDup\":null,\"DocumentContainerId\":\"00000000-0000-0000-0000-000000000000\",\"FieldOrderIndexDup\":0,\"FieldValueDate\":null,\"FieldValueDecimal\":null,\"FieldValueInt\":null,\"FieldValueString\":\"john.doe@example.com\",\"FlexibleFieldDataTypeIdDup\":1,\"FlexibleFieldDisplayNameDup\":\"Guest Email Address\",\"FlexibleFieldId\":\"00000000-0000-0000-0000-000000000000\",\"FlexibleFieldNameDup\":\"__SYS_GuestEmail\",\"FlexibleFieldVersionId\":\"00000000-0000-0000-0000-000000000000\",\"HelpTextDup\":null,\"MandatoryDup\":false,\"MandatoryIfValueListORDup\":null,\"Template\":{\"BranchId\":null,\"CreationDate\":\"0001-01-01T00:00:00.0000000Z\",\"DataRange\":\"320\",\"DataType\":1,\"DefaultValue\":null,\"DisplayName\":\"Guest Email Address\",\"EntityId\":null,\"FieldOrderIndex\":101,\"Flags\":3,\"FlexibleFieldId\":\"00000000-0000-0000-0000-000000000000\",\"HelpText\":\"Email address of person sent a guest link.\",\"Id\":\"00000000-0000-0000-0000-000000000000\",\"IsActive\":false,\"IsEnabled\":true,\"IsGlobal\":true,\"IsValidationField\":false,\"LastModifield\":\"0001-01-01T00:00:00.0000000Z\",\"Mandatory\":false,\"Name\":\"__SYS_GuestEmail\",\"ValidationFailValue\":null,\"ValidationPassValue\":null,\"ValidationWarningValue\":null},\"ValidationStatus\":null}}],\"ApplicationRead\":false,\"BranchId\":\"00000000-0000-4000-8000-000000000005\",\"BranchName\":\"Demo Digital Identity High H2B\",\"ClientAppId\":1000,\"CreatedAt\":\"2026-01-15T10:42:03.8270000Z\",\"DbsCheckInitiation\":{\"State\":0},\"DbsStatus\":null,\"DocumentContainerFieldList\":[{\"DescriptionText\":null,\"DisplayName\":null,\"DocumentContainerId\":\"3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\"FieldValueDate\":null,\"FieldValueString\":\"3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\"Id\":1001,\"Name\":\"ClientApplicationReference\",\"Source\":0},{\"DescriptionText\":null,\"DisplayName\":null,\"DocumentContainerId\":\"3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\"FieldValueDate\":null,\"FieldValueString\":\"00000000-0000-4000-8000-000000000006\",\"Id\":1002,\"Name\":\"FacetecReference\",\"Source\":0},{\"DescriptionText\":null,\"DisplayName\":null,\"DocumentContainerId\":\"3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\"FieldValueDate\":null,\"FieldValueString\":\"64\",\"Id\":1003,\"Name\":\"GuestDigitalIdentificationScheme\",\"Source\":0}],\"DocumentContainerValidationList\":[{\"ActionsText\":null,\"DescriptionText\":null,\"DetailedResult\":\"\",\"DisplayName\":\"DBS Standard Or Enhanced Digital Identity Verification Check\",\"DocumentContainerId\":\"3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\"Id\":1010,\"InformationText\":null,\"Name\":\"DBSStandardOrEnhancedDigitalIdentityVerificationCheck\",\"OutcomeCommentText\":null,\"RefFieldNames\":null,\"ValidationOutcome\":4},{\"ActionsText\":null,\"DescriptionText\":null,\"DetailedResult\":\"Match\",\"DisplayName\":\"Address Verification\",\"DocumentContainerId\":\"3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\"Id\":1011,\"InformationText\":null,\"Name\":\"AddressVerification\",\"OutcomeCommentText\":null,\"RefFieldNames\":null,\"ValidationOutcome\":4},{\"ActionsText\":null,\"DescriptionText\":null,\"DetailedResult\":\"\",\"DisplayName\":\"DBS Standard Or Enhanced Digital Identity Permitted Document Verification\",\"DocumentContainerId\":\"3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\"Id\":1005,\"InformationText\":null,\"Name\":\"DBSStandardOrEnhancedDigitalIdentityPermittedDocumentVerification\",\"OutcomeCommentText\":null,\"RefFieldNames\":null,\"ValidationOutcome\":4},{\"ActionsText\":null,\"DescriptionText\":null,\"DetailedResult\":\"\",\"DisplayName\":\"DBS Standard Or Enhanced Digital Identity Document Validation Verification\",\"DocumentContainerId\":\"3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\"Id\":1006,\"InformationText\":null,\"Name\":\"DBSStandardOrEnhancedDigitalIdentityDocumentValidationVerification\",\"OutcomeCommentText\":null,\"RefFieldNames\":null,\"ValidationOutcome\":4},{\"ActionsText\":null,\"DescriptionText\":null,\"DetailedResult\":\"\",\"DisplayName\":\"DBS Standard Or Enhanced Digital Identity Identity Fraud Verification\",\"DocumentContainerId\":\"3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\"Id\":1007,\"InformationText\":null,\"Name\":\"DBSStandardOrEnhancedDigitalIdentityIdentityFraudVerification\",\"OutcomeCommentText\":null,\"RefFieldNames\":null,\"ValidationOutcome\":4},{\"ActionsText\":null,\"DescriptionText\":null,\"DetailedResult\":\"\",\"DisplayName\":\"DBS Standard Or Enhanced Digital Identity Face Match Verification\",\"DocumentContainerId\":\"3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\"Id\":1008,\"InformationText\":null,\"Name\":\"DBSStandardOrEnhancedDigitalIdentityFaceMatchVerification\",\"OutcomeCommentText\":null,\"RefFieldNames\":null,\"ValidationOutcome\":4},{\"ActionsText\":null,\"DescriptionText\":null,\"DetailedResult\":\"\",\"DisplayName\":\"DBS Standard Or Enhanced Digital Identity Liveness Verification\",\"DocumentContainerId\":\"3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\"Id\":1009,\"InformationText\":null,\"Name\":\"DBSStandardOrEnhancedDigitalIdentityLivenessVerification\",\"OutcomeCommentText\":null,\"RefFieldNames\":null,\"ValidationOutcome\":4}],\"DocumentSource\":4,\"DocumentStorageType\":3,\"Documents\":[{\"AspectRatio\":1.4196531772613525,\"Audited\":true,\"AuditedByUser\":\"Demo Auditor\",\"AuditorMessage\":null,\"AuditorStatus\":1,\"Blacklisted\":false,\"BlacklistedAt\":null,\"BranchName\":\"Demo Digital Identity High H2B\",\"CompatibilityDocumentSubTypeCode\":null,\"CompatibilityDocumentTypeCode\":null,\"CompatibilityIssuingCountryCode\":null,\"CompatibilityNationalityCode\":null,\"ContactlessChipReadState\":null,\"ContainerId\":\"3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\"ContinuedManually\":false,\"CreatedAt\":\"2026-01-15T11:42:47.4500000Z\",\"CustomFieldDictionary\":[],\"CustomFieldKeys\":[],\"DetectedOrientation\":0,\"DocumentCompleted\":false,\"DocumentConfiguration\":{\"DisableExpiredEUDocumentsFailure\":true,\"DisableExpiredNonEuDocumentsFailure\":true},\"DocumentFields\":[{\"DataType\":1,\"DescriptionText\":null,\"DisplayName\":\"Expiration Date\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"FieldValueDate\":\"2029-11-27T00:00:00.0000000Z\",\"FieldValueString\":null,\"Id\":1011,\"ImageType\":999,\"Name\":\"VIZ Expiration Date\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":1},{\"DataType\":1,\"DescriptionText\":null,\"DisplayName\":\"Birth Date\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"FieldValueDate\":\"1990-01-01T00:00:00.0000000Z\",\"FieldValueString\":null,\"Id\":1012,\"ImageType\":999,\"Name\":\"VIZ Birth Date\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":1},{\"DataType\":0,\"DescriptionText\":null,\"DisplayName\":\"Sex\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"FieldValueDate\":null,\"FieldValueString\":\"M\",\"Id\":1013,\"ImageType\":999,\"Name\":\"VIZ Sex\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":1},{\"DataType\":0,\"DescriptionText\":null,\"DisplayName\":\"Nationality Code\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"FieldValueDate\":null,\"FieldValueString\":\"DEU\",\"Id\":1014,\"ImageType\":999,\"Name\":\"VIZ Nationality Code\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":1},{\"DataType\":0,\"DescriptionText\":null,\"DisplayName\":\"Firstname\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"FieldValueDate\":null,\"FieldValueString\":\"JOHN\",\"Id\":1015,\"ImageType\":999,\"Name\":\"VIZ Firstname\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":1},{\"DataType\":0,\"DescriptionText\":null,\"DisplayName\":\"Middlename\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"FieldValueDate\":null,\"FieldValueString\":\"DEMO\",\"Id\":1016,\"ImageType\":999,\"Name\":\"VIZ Middlename\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":1},{\"DataType\":0,\"DescriptionText\":null,\"DisplayName\":\"Surname\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"FieldValueDate\":null,\"FieldValueString\":\"DOE\",\"Id\":1017,\"ImageType\":999,\"Name\":\"VIZ Surname\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":1},{\"DataType\":0,\"DescriptionText\":null,\"DisplayName\":\"PhotoMatchesApplicantTrustId Score\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"FieldValueDate\":null,\"FieldValueString\":\"0\",\"Id\":1018,\"ImageType\":null,\"Name\":\"VIZ PhotoMatchesApplicantTrustId Score\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":1},{\"DataType\":0,\"DescriptionText\":null,\"DisplayName\":\"Document Number\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"FieldValueDate\":null,\"FieldValueString\":\"000000001\",\"Id\":1019,\"ImageType\":null,\"Name\":\"VI Document Number\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":2},{\"DataType\":0,\"DescriptionText\":null,\"DisplayName\":\"Firstname\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"FieldValueDate\":null,\"FieldValueString\":\"John\",\"Id\":1020,\"ImageType\":null,\"Name\":\"VI Firstname\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":2},{\"DataType\":0,\"DescriptionText\":null,\"DisplayName\":\"Surname\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"FieldValueDate\":null,\"FieldValueString\":\"Doe\",\"Id\":1021,\"ImageType\":null,\"Name\":\"VI Surname\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":2},{\"DataType\":0,\"DescriptionText\":null,\"DisplayName\":\"Middlename\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"FieldValueDate\":null,\"FieldValueString\":\"Demo\",\"Id\":1022,\"ImageType\":null,\"Name\":\"VI Middlename\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":2},{\"DataType\":1,\"DescriptionText\":null,\"DisplayName\":\"Birth Date\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"FieldValueDate\":\"1990-01-01T00:00:00.0000000Z\",\"FieldValueString\":null,\"Id\":1023,\"ImageType\":null,\"Name\":\"VI Birth Date\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":2},{\"DataType\":0,\"DescriptionText\":null,\"DisplayName\":\"Sex\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"FieldValueDate\":null,\"FieldValueString\":\"M\",\"Id\":1024,\"ImageType\":null,\"Name\":\"VI Sex\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":2},{\"DataType\":1,\"DescriptionText\":null,\"DisplayName\":\"Expiration Date\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"FieldValueDate\":\"2029-11-27T00:00:00.0000000Z\",\"FieldValueString\":null,\"Id\":1025,\"ImageType\":null,\"Name\":\"VI Expiration Date\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":2}],\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"DocumentName\":\"Passport\",\"DocumentResultsSummary\":[{\"ErrorMessage\":null,\"Name\":\"Photo Matches Applicant (TrustId)\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"General Document Assessments\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"MRZ Validations\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Amberhill Check\",\"Value\":true,\"ValueUndefined\":false}],\"DocumentSubType\":{\"DocumentType\":0,\"Id\":\"0\",\"Mrz\":\"\",\"Name\":\"None\",\"RewriteDocumentNumber\":0,\"RewriteDocumentType\":0},\"DocumentType\":0,\"DocumentValidations\":[{\"ActionsText\":null,\"DescriptionText\":null,\"DisplayName\":\"Birth Date Check Digit\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"Id\":1026,\"ImageType\":0,\"InformationText\":null,\"Name\":\"Birth Date Check Digit\",\"OutcomeCommentText\":null,\"RefFieldNames\":[\"MRZ\"],\"RegionCoordinates\":null,\"Result\":4},{\"ActionsText\":null,\"DescriptionText\":null,\"DisplayName\":\"Composite Check Digit\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"Id\":1027,\"ImageType\":0,\"InformationText\":null,\"Name\":\"Composite Check Digit\",\"OutcomeCommentText\":null,\"RefFieldNames\":[\"MRZ\"],\"RegionCoordinates\":null,\"Result\":4},{\"ActionsText\":null,\"DescriptionText\":null,\"DisplayName\":\"Document Number Check Digit\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"Id\":1028,\"ImageType\":0,\"InformationText\":null,\"Name\":\"Document Number Check Digit\",\"OutcomeCommentText\":null,\"RefFieldNames\":[\"MRZ\"],\"RegionCoordinates\":null,\"Result\":4},{\"ActionsText\":null,\"DescriptionText\":null,\"DisplayName\":\"Expiration Date Check Digit\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"Id\":1029,\"ImageType\":0,\"InformationText\":null,\"Name\":\"Expiration Date Check Digit\",\"OutcomeCommentText\":null,\"RefFieldNames\":[\"MRZ\"],\"RegionCoordinates\":null,\"Result\":4},{\"ActionsText\":null,\"DescriptionText\":null,\"DisplayName\":\"Issuing State Valid\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"Id\":1030,\"ImageType\":0,\"InformationText\":null,\"Name\":\"Issuing State Valid\",\"OutcomeCommentText\":null,\"RefFieldNames\":[\"MRZ\"],\"RegionCoordinates\":null,\"Result\":4},{\"ActionsText\":null,\"DescriptionText\":null,\"DisplayName\":\"MRZ Name Format Valid\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"Id\":1031,\"ImageType\":0,\"InformationText\":null,\"Name\":\"MRZ Name Format Valid\",\"OutcomeCommentText\":null,\"RefFieldNames\":[\"MRZ\"],\"RegionCoordinates\":null,\"Result\":4},{\"ActionsText\":null,\"DescriptionText\":null,\"DisplayName\":\"Nationality Valid\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"Id\":1032,\"ImageType\":0,\"InformationText\":null,\"Name\":\"Nationality Valid\",\"OutcomeCommentText\":null,\"RefFieldNames\":[\"MRZ\"],\"RegionCoordinates\":null,\"Result\":4},{\"ActionsText\":null,\"DescriptionText\":null,\"DisplayName\":\"Personal Number Check Digit\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"Id\":1033,\"ImageType\":0,\"InformationText\":null,\"Name\":\"Personal Number Check Digit\",\"OutcomeCommentText\":null,\"RefFieldNames\":[\"MRZ\"],\"RegionCoordinates\":null,\"Result\":4},{\"ActionsText\":null,\"DescriptionText\":null,\"DisplayName\":\"PhotoMatchTrustId Auditor Valid\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"Id\":1034,\"ImageType\":999,\"InformationText\":null,\"Name\":\"PhotoMatchTrustId Auditor Valid\",\"OutcomeCommentText\":null,\"RefFieldNames\":null,\"RegionCoordinates\":null,\"Result\":4},{\"ActionsText\":null,\"DescriptionText\":null,\"DisplayName\":\"PhotoMatchTrustId Software Valid\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"Id\":1035,\"ImageType\":0,\"InformationText\":null,\"Name\":\"PhotoMatchTrustId Software Valid\",\"OutcomeCommentText\":null,\"RefFieldNames\":null,\"RegionCoordinates\":null,\"Result\":3},{\"ActionsText\":null,\"DescriptionText\":null,\"DisplayName\":\"Validity Period Valid\",\"DocumentId\":\"00000000-0000-4000-8000-000000000007\",\"Id\":1036,\"ImageType\":0,\"InformationText\":null,\"Name\":\"Validity Period Valid\",\"OutcomeCommentText\":null,\"RefFieldNames\":null,\"RegionCoordinates\":null,\"Result\":0}],\"DocumentVersion\":{\"AllowIncorrectExtendedDocumentNumber\":false,\"ChipFields\":null,\"ChipLocked\":false,\"ChipValidationFields\":[55],\"Country\":{\"Alias1\":\"Great Britain\",\"Alias2\":\"Britain\",\"Alias3\":\"England\",\"AltMrz\":null,\"EU\":true,\"Mrz\":\"DEU\",\"Name\":\"United Kingdom\",\"Nationality\":null,\"UK\":true},\"DateFormat\":0,\"DocumentSubType\":null,\"DocumentType\":0,\"Features\":[],\"Id\":\"00000000-0000-4000-8000-000000000008\",\"Images\":[],\"Laminated\":false,\"MRZFields\":[],\"Mrz\":true,\"MrzCharacters\":44,\"MrzLines\":2,\"Name\":\"UK Passport\",\"RFID\":true,\"ValidityRules\":null,\"Year\":null},\"DrivingLicenceCategory\":null,\"Editable\":true,\"ExpiryNotification\":false,\"ExternalServices\":[{\"CallerId\":\"00000000-0000-4000-8000-000000000009\",\"ErrorMessage\":null,\"ID\":\"amberhill\",\"Match\":false,\"MatchedProperties\":[{\"Key\":\"document_number\",\"Value\":\"\"},{\"Key\":\"document_type\",\"Value\":\"P\"},{\"Key\":\"issuing_country\",\"Value\":\"DEU\"},{\"Key\":\"firstname\",\"Value\":\"JOHN\"},{\"Key\":\"middlename\",\"Value\":\"DEMO\"},{\"Key\":\"lastname\",\"Value\":\"DOE\"},{\"Key\":\"gender\",\"Value\":\"M\"},{\"Key\":\"date_of_birth\",\"Value\":\"1990-01-01\"},{\"Key\":\"expiry_date\",\"Value\":\"2029-11-27\"}],\"Name\":\"Amberhill Check\",\"ServiceCallPending\":false,\"ServiceCalled\":true,\"Success\":true,\"Timestamp\":\"2026-01-15T11:43:27.8870000Z\"}],\"ExternalServicesQueried\":true,\"FeedbackFace\":null,\"FeedbackFeatures\":[],\"FeedbackHasMrz\":null,\"FeedbackPersonMatches\":null,\"FeedbackRFIDImageMatches\":null,\"FeedbackUV\":null,\"FeedbackUVPattern\":null,\"Font\":null,\"FontAlignment\":null,\"FontHeight\":null,\"Forwarded\":false,\"GeneralDocumentProperties\":[{\"ErrorMessage\":null,\"Name\":\"Photo Matches Applicant (TrustId)\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Document in date\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Document details complete\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Amberhill Check\",\"Value\":true,\"ValueUndefined\":false}],\"HasError\":false,\"HighRiskCountry\":null,\"Images\":[],\"IsBiometric\":true,\"IssuingAuthority\":\"DEMO AUTHORITY\",\"IssuingCountry\":{\"Alias1\":\"Great Britain\",\"Alias2\":\"Britain\",\"Alias3\":\"England\",\"AltMrz\":null,\"EU\":true,\"Mrz\":\"DEU\",\"Name\":\"United Kingdom\",\"Nationality\":null,\"UK\":true},\"KDB\":true,\"Locked\":true,\"MRZCorrected\":false,\"MRZCorrectionProvided\":true,\"MandatoryDocumentFieldsFlag\":508,\"MaxAgeFailed\":null,\"MinAgeFailed\":null,\"MissingFieldsProperties\":[],\"Mrz\":\"P<DEUDOE<<JOHN<DEMO<<<<<<<<<<<<<<<<<<<<<<<<<\\n0000000011DEU9001011M2911272<<<<<<<<<<<<<<04\",\"MrzCharacterCount\":44,\"MrzImageType\":2,\"MrzLineCount\":2,\"MrzSameLength\":true,\"MrzValidationProperties\":[{\"ErrorMessage\":null,\"Name\":\"All MRZ lines have the same length\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Valid MRZ codeline length\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"All characters valid\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Overall checksum\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Document number checksum\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Date of birth checksum\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Expiry date checksum\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Personal number checksum\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Name formatted correctly\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Issuing state valid\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Nationality valid\",\"Value\":true,\"ValueUndefined\":false}],\"Nationality\":{\"Alias1\":\"Great Britain\",\"Alias2\":\"Britain\",\"Alias3\":\"England\",\"AltMrz\":null,\"EU\":true,\"Mrz\":\"DEU\",\"Name\":\"United Kingdom\",\"Nationality\":null,\"UK\":true},\"NoInitialFaceImage\":true,\"Notes\":\"\",\"OcrDataApplied\":true,\"OcrFieldData\":[],\"OcrType\":5,\"OperatorMessage\":\"\",\"OperatorStatus\":2,\"OptionalDocumentFieldsFlag\":1539,\"OriginalMrz\":\"\",\"PartiallyRecognised\":false,\"RFIDFailed\":false,\"ReadingAttemptsCount\":2,\"RfidMrz\":\"\",\"RuleDenied\":false,\"ScanCounter\":1,\"ScannedAt\":\"2026-01-15T11:42:47.4500000Z\",\"ScannerType\":\"CLOUD\",\"SeenBeforeDocumentContainerId\":null,\"SeenBeforeDocumentId\":null,\"SuccessfullyRead\":true,\"SupportingDocumentName\":null,\"SystemId\":1,\"Unrecognised\":false,\"UpdatedAt\":\"2026-01-15T13:26:12.1730000Z\",\"ValidFrom\":\"1753-01-01T00:00:00.0000000Z\",\"ValidLength\":true,\"VpeDeviceId\":\"00000000-0000-4000-8000-000000000013\",\"VpeName\":\"TrustID Demo\",\"WizardCompleted\":true,\"WorkflowFlags\":0},{\"AspectRatio\":1.4196531772613525,\"Audited\":true,\"AuditedByUser\":\"Demo Auditor\",\"AuditorMessage\":null,\"AuditorStatus\":1,\"Blacklisted\":false,\"BlacklistedAt\":null,\"BranchName\":\"Demo Digital Identity High H2B\",\"CompatibilityDocumentSubTypeCode\":null,\"CompatibilityDocumentTypeCode\":null,\"CompatibilityIssuingCountryCode\":null,\"CompatibilityNationalityCode\":null,\"ContactlessChipReadState\":null,\"ContainerId\":\"3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\"ContinuedManually\":false,\"CreatedAt\":\"2026-01-15T11:42:47.4500000Z\",\"CustomFieldDictionary\":[],\"CustomFieldKeys\":[],\"DetectedOrientation\":0,\"DocumentCompleted\":false,\"DocumentConfiguration\":{\"DisableExpiredEUDocumentsFailure\":true,\"DisableExpiredNonEuDocumentsFailure\":true},\"DocumentFields\":[{\"DataType\":0,\"DescriptionText\":null,\"DisplayName\":\"Document Number\",\"DocumentId\":\"66666666-6666-4666-8666-666666666666\",\"FieldValueDate\":null,\"FieldValueString\":\"000000001\",\"Id\":1019,\"ImageType\":null,\"Name\":\"VI Document Number\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":2},{\"DataType\":0,\"DescriptionText\":null,\"DisplayName\":\"Firstname\",\"DocumentId\":\"66666666-6666-4666-8666-666666666666\",\"FieldValueDate\":null,\"FieldValueString\":\"John\",\"Id\":1020,\"ImageType\":null,\"Name\":\"VI Firstname\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":2},{\"DataType\":0,\"DescriptionText\":null,\"DisplayName\":\"Surname\",\"DocumentId\":\"66666666-6666-4666-8666-666666666666\",\"FieldValueDate\":null,\"FieldValueString\":\"Doe\",\"Id\":1021,\"ImageType\":null,\"Name\":\"VI Surname\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":2},{\"DataType\":0,\"DescriptionText\":null,\"DisplayName\":\"Middlename\",\"DocumentId\":\"66666666-6666-4666-8666-666666666666\",\"FieldValueDate\":null,\"FieldValueString\":\"Demo\",\"Id\":1022,\"ImageType\":null,\"Name\":\"VI Middlename\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":2},{\"DataType\":1,\"DescriptionText\":null,\"DisplayName\":\"Birth Date\",\"DocumentId\":\"66666666-6666-4666-8666-666666666666\",\"FieldValueDate\":\"1990-01-01T00:00:00.0000000Z\",\"FieldValueString\":null,\"Id\":1023,\"ImageType\":null,\"Name\":\"VI Birth Date\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":2},{\"DataType\":0,\"DescriptionText\":null,\"DisplayName\":\"Sex\",\"DocumentId\":\"66666666-6666-4666-8666-666666666666\",\"FieldValueDate\":null,\"FieldValueString\":\"M\",\"Id\":1024,\"ImageType\":null,\"Name\":\"VI Sex\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":2},{\"DataType\":1,\"DescriptionText\":null,\"DisplayName\":\"Expiration Date\",\"DocumentId\":\"66666666-6666-4666-8666-666666666666\",\"FieldValueDate\":\"2029-11-27T00:00:00.0000000Z\",\"FieldValueString\":null,\"Id\":1025,\"ImageType\":null,\"Name\":\"VI Expiration Date\",\"RegionCoordinates\":null,\"Reliability\":0,\"SourceId\":2}],\"DocumentId\":\"66666666-6666-4666-8666-666666666666\",\"DocumentName\":\"DRIVING LICENCE\",\"DocumentResultsSummary\":[{\"ErrorMessage\":null,\"Name\":\"Photo Matches Applicant (TrustId)\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"General Document Assessments\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"MRZ Validations\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Amberhill Check\",\"Value\":true,\"ValueUndefined\":false}],\"DocumentSubType\":{\"DocumentType\":0,\"Id\":\"0\",\"Mrz\":\"\",\"Name\":\"None\",\"RewriteDocumentNumber\":0,\"RewriteDocumentType\":0},\"DocumentType\":3,\"DocumentValidations\":[],\"DocumentVersion\":{\"AllowIncorrectExtendedDocumentNumber\":false,\"ChipFields\":null,\"ChipLocked\":false,\"ChipValidationFields\":[55],\"Country\":{\"Alias1\":\"Great Britain\",\"Alias2\":\"Britain\",\"Alias3\":\"England\",\"AltMrz\":null,\"EU\":true,\"Mrz\":\"DEU\",\"Name\":\"United Kingdom\",\"Nationality\":null,\"UK\":true},\"DateFormat\":0,\"DocumentSubType\":null,\"DocumentType\":0,\"Features\":[],\"Id\":\"00000000-0000-4000-8000-000000000008\",\"Images\":[],\"Laminated\":false,\"MRZFields\":[],\"Mrz\":true,\"MrzCharacters\":44,\"MrzLines\":2,\"Name\":\"UK Passport\",\"RFID\":true,\"ValidityRules\":null,\"Year\":null},\"DrivingLicenceCategory\":null,\"Editable\":true,\"ExpiryNotification\":false,\"ExternalServices\":[{\"CallerId\":\"00000000-0000-4000-8000-000000000009\",\"ErrorMessage\":null,\"ID\":\"amberhill\",\"Match\":false,\"MatchedProperties\":[{\"Key\":\"document_number\",\"Value\":\"\"},{\"Key\":\"document_type\",\"Value\":\"P\"},{\"Key\":\"issuing_country\",\"Value\":\"DEU\"},{\"Key\":\"firstname\",\"Value\":\"JOHN\"},{\"Key\":\"middlename\",\"Value\":\"DEMO\"},{\"Key\":\"lastname\",\"Value\":\"DOE\"},{\"Key\":\"gender\",\"Value\":\"M\"},{\"Key\":\"date_of_birth\",\"Value\":\"1990-01-01\"},{\"Key\":\"expiry_date\",\"Value\":\"2029-11-27\"}],\"Name\":\"Amberhill Check\",\"ServiceCallPending\":false,\"ServiceCalled\":true,\"Success\":true,\"Timestamp\":\"2026-01-15T11:43:27.8870000Z\"}],\"ExternalServicesQueried\":true,\"FeedbackFace\":null,\"FeedbackFeatures\":[],\"FeedbackHasMrz\":null,\"FeedbackPersonMatches\":null,\"FeedbackRFIDImageMatches\":null,\"FeedbackUV\":null,\"FeedbackUVPattern\":null,\"Font\":null,\"FontAlignment\":null,\"FontHeight\":null,\"Forwarded\":false,\"GeneralDocumentProperties\":[{\"ErrorMessage\":null,\"Name\":\"Photo Matches Applicant (TrustId)\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Document in date\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Document details complete\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Amberhill Check\",\"Value\":true,\"ValueUndefined\":false}],\"HasError\":false,\"HighRiskCountry\":null,\"Images\":[],\"IsBiometric\":true,\"IssuingAuthority\":\"DEMO AUTHORITY\",\"IssuingCountry\":{\"Alias1\":\"Great Britain\",\"Alias2\":\"Britain\",\"Alias3\":\"England\",\"AltMrz\":null,\"EU\":false,\"Mrz\":\"GBR\",\"Name\":\"United Kingdom\",\"Nationality\":null,\"UK\":true},\"KDB\":true,\"Locked\":true,\"MRZCorrected\":false,\"MRZCorrectionProvided\":true,\"MandatoryDocumentFieldsFlag\":508,\"MaxAgeFailed\":null,\"MinAgeFailed\":null,\"MissingFieldsProperties\":[],\"Mrz\":null,\"MrzCharacterCount\":44,\"MrzImageType\":2,\"MrzLineCount\":2,\"MrzSameLength\":true,\"MrzValidationProperties\":[{\"ErrorMessage\":null,\"Name\":\"All MRZ lines have the same length\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Valid MRZ codeline length\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"All characters valid\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Overall checksum\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Document number checksum\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Date of birth checksum\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Expiry date checksum\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Personal number checksum\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Name formatted correctly\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Issuing state valid\",\"Value\":true,\"ValueUndefined\":false},{\"ErrorMessage\":null,\"Name\":\"Nationality valid\",\"Value\":true,\"ValueUndefined\":false}],\"Nationality\":{\"Alias1\":\"Great Britain\",\"Alias2\":\"Britain\",\"Alias3\":\"England\",\"AltMrz\":null,\"EU\":true,\"Mrz\":\"DEU\",\"Name\":\"United Kingdom\",\"Nationality\":null,\"UK\":true},\"NoInitialFaceImage\":true,\"Notes\":\"\",\"OcrDataApplied\":true,\"OcrFieldData\":[],\"OcrType\":5,\"OperatorMessage\":\"\",\"OperatorStatus\":2,\"OptionalDocumentFieldsFlag\":1539,\"OriginalMrz\":null,\"PartiallyRecognised\":false,\"RFIDFailed\":false,\"ReadingAttemptsCount\":2,\"RfidMrz\":null,\"RuleDenied\":false,\"ScanCounter\":1,\"ScannedAt\":\"2026-01-15T11:42:47.4500000Z\",\"ScannerType\":\"CLOUD\",\"SeenBeforeDocumentContainerId\":null,\"SeenBeforeDocumentId\":null,\"SuccessfullyRead\":true,\"SupportingDocumentName\":null,\"SystemId\":1,\"Unrecognised\":false,\"UpdatedAt\":\"2026-01-15T13:26:12.1730000Z\",\"ValidFrom\":\"1753-01-01T00:00:00.0000000Z\",\"ValidLength\":true,\"VpeDeviceId\":\"00000000-0000-4000-8000-000000000013\",\"VpeName\":\"TrustID Demo\",\"WizardCompleted\":true,\"WorkflowFlags\":0}],\"EntityId\":\"00000000-0000-4000-8000-000000000005\",\"Fullname\":\"John Demo Doe\",\"Id\":\"3f2504e0-4f89-41d3-9a0c-0305e82c3301\",\"IsFullCheck\":false,\"JourneyId\":null,\"LivenessTestCount\":1,\"LivenessTestResult\":1,\"LivenessTestResultAuto\":1,\"OrganisationId\":\"00000000-0000-4000-8000-000000000014\",\"OrganisationName\":\"Demo Organisation\",\"OverallStatus\":0,\"ProcessExpiryTimeUtc\":\"2026-01-15T12:43:29.5890000Z\",\"ReferralHistory\":[{\"CompletedAt\":\"2026-01-15T13:26:14.0380000Z\",\"ReferralType\":1,\"ReferredAt\":\"2026-01-15T11:43:29.5730000Z\",\"ReferredBy\":{\"DisplayName\":\"Demo User\",\"UserId\":\"00000000-0000-4000-8000-000000000015\"},\"ReferredTo\":{\"DisplayName\":\"Demo User\",\"UserId\":\"00000000-0000-4000-8000-000000000016\"}}],\"ReferralType\":null,\"Referred\":false,\"ReferredAt\":null,\"ReferredFrom\":null,\"ReviewApplicationInstigatingUser\":null,\"ReviewApplicationState\":null,\"ScannedByUser\":\"Demo API User\",\"Synchronised\":false,\"SystemId\":1,\"TotalAlerts\":null,\"TtaImport\":null,\"UpdatedAt\":\"2026-01-15T13:26:14.8500000Z\",\"UserId\":\"00000000-0000-4000-8000-000000000015\",\"VpeDeviceId\":\"00000000-0000-4000-8000-000000000013\",\"VpeName\":\"TrustID Demo\",\"VpeType\":18,\"WorkflowType\":1},\"reportUrl\":\"api/check-attachment?uuid=3f2504e0-4f89-41d3-9a0c-0305e82c3301&id=1\",\"documentImages\":[],\"expired\":false}}]"

Generate Token Deprecated

Deprecated: Onfido SDK tokens for both Medium and High. Remains operational for existing Onfido checks. Trust ID M1A and H2B use data.url from their respective create endpoints and need no SDK token. See the Trust ID M1A migration guide. See the Trust ID H2B High migration guide.

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-09-29T14:25:56.2471520Z"
}

Results Deprecated

Deprecated: Onfido results for both Medium and High. Remains operational for existing Onfido checks. For Trust ID M1A use 'GET /digital-identity-results'; for Trust ID H2B use 'GET /digital-identity-high-h2b-results'. Existing Onfido UUIDs must continue using this route. See the Trust ID M1A migration guide. See the Trust ID H2B High migration guide.

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 Deprecated

Deprecated: Use 'POST /digital-identity-high-h2b' for Trust ID Digital Identity High (H2B). Existing Onfido High checks remain operational and must continue using their original results and SDK-token endpoints. See the Trust ID H2B High migration guide.

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

Results

Returns cached Trust ID M1A results in the supplier's native container shape. The optional top-level reportUrl links to the authenticated attachment download after asynchronous PDF storage succeeds. See the Trust ID M1A migration guide.

Authorizations:
bearer_auth
query Parameters
uuid
required
string <uuid>

The UUID for the Trust ID digital identity results

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create

Creates a Trust ID Digital Right to Work Medium (M1A) check and returns the hosted URL in data.url. Demo-only checks complete automatically without candidate verification. With demoMode=true and sandboxMode=false, candidate.lastName selects HappyPath or ExpiredPassport (case-insensitive, surrounding spaces ignored; other names use HappyPath). Live and supplier-sandbox checks are unaffected. See the Trust ID M1A migration guide.

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

required
object (trustIdCandidate)
required
object (metaData)

Responses

Request samples

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

Response samples

Content type
application/json
{}

Generate Token Deprecated

Deprecated: Onfido SDK tokens for both Medium and High. Remains operational for existing Onfido checks. Trust ID M1A and H2B use data.url from their respective create endpoints and need no SDK token. See the Trust ID M1A migration guide. See the Trust ID H2B High migration guide.

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-09-29T14:25:56.2471520Z"
}

Results Deprecated

Deprecated: Onfido results for both Medium and High. Remains operational for existing Onfido checks. For Trust ID M1A use 'GET /digital-identity-results'; for Trust ID H2B use 'GET /digital-identity-high-h2b-results'. Existing Onfido UUIDs must continue using this route. See the Trust ID M1A migration guide. See the Trust ID H2B High migration guide.

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 Deprecated

Deprecated: Use 'POST /digital-identity-medium-m1a' instead. See the Trust ID M1A migration guide.

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": "e276811c-b158-422f-bdea-017cd11bd600",
  • "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": {
    }
}

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

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": {
    }
}

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
[
  • {
    }
]

Qualification Check

Create

Authorizations:
bearer_auth
Request Body schema: application/json
required

The Request Body

instituteId
string
instituteName
string
required
object

The institute-specific field values returned by the institute-detail endpoint

Array of objects (qualificationCheckDocument)
required
object (metaData)

Responses

Request samples

Content type
application/json
{
  • "instituteId": "TEST-0001",
  • "fields": {
    },
  • "documents": [
    ],
  • "metaData": {
    }
}

Response samples

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

Get Regions

Authorizations:
bearer_auth
query Parameters
name
string

Optional (partial) name to filter regions by

Responses

Response samples

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

Get Institutes

Authorizations:
bearer_auth
query Parameters
regionId
required
integer <int32>

The region to list institutes for

name
string

Optional (partial) name to filter institutes by

Responses

Response samples

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

Get Institute Detail

Authorizations:
bearer_auth
path Parameters
instituteId
required
string

The institute to retrieve detail for

Responses

Response samples

Content type
application/json
{
  • "id": "50",
  • "name": "London College",
  • "surcharge": 10,
  • "region": {
    },
  • "product": {
    },
  • "consentFormRequired": false,
  • "fields": {
    },
  • "notices": [
    ],
  • "documentRequirements": [
    ],
  • "totalPrice": 20,
  • "minYear": 2008
}

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": "5e2690ee-9c22-4c36-8897-7f588e041783",
  • "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-09-29T12:55:56.3705931Z",
  • "completed": "2026-09-29T12:55:56.3705933Z",
  • "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-09-29",
  • "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-09-28T12:55:56.1828614Z",
  • "started": "2026-09-28T12:56:56.1828638Z",
  • "completed": "2026-09-29T12:55:56.1828640Z",
  • "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
}