Skip to content

credentials

The vocabulary and schemas associated with the production of credentials by GOV.UK One Login.

URI: https://vocab.account.gov.uk/linkml/credentials-schema

Name: credentials

Classes

Class Description
BankAccountDetailsClass The details of a Bank Account as presented by a user for checking for identit...
BirthDateClass BirthDate object that represents a user's claimed date of birth
CheckDetailsClass
ContraIndicatorClass
CredentialSubjectClass Verifiable credential subjects use multiple inheritance; this base class is i...
        PersonClass
                AddressAssertionClass
                PersonWithIdentityClass A credential subject representing a person only by core identity attributes
                        PersonExtendedMatchingClass An extended version of the PersonIdentity class for situations like Life Even...
                        PersonWithDocumentsClass
                                IdentityCheckSubjectClass
DocumentDetailsClass
        DrivingPermitDetailsClass The details of a driving license/permit as presented by Optical Character Rec...
        IdCardDetailsClass The details of a National Identification Card as presented by a user for iden...
        PassportDetailsClass The details of a passport as presented by the biometric chip data using near-...
        ResidencePermitDetailsClass The details of a biometric residency permit as presented by reading the biome...
        SocialSecurityRecordDetailsClass The details of a social security record as input by a user
EvidenceRequestedClass The levels of evidence_requested which are minimum GPG45 criteria that are re...
IdentityCheckClass
InterventionClass
JWTClass
        AddressCredentialJWTClass A [JWT-encoded VC](https://www
        AuthorizationRequestClass An [Authorization Request compliant with OAuth 2
                IssuerAuthorizationRequestClass An Authorization Request that provides shared claims and other user/session d...
                OpenIDConnectAuthenticationRequestClass An [Authentication Request compliant with OpenID Connect 2
        CoreIdentityJWTClass A [JWT-encoded VC](https://www
        IdentityAssertionCredentialJWTClass A [JWT-encoded VC](https://www
        IdentityCheckCredentialJWTClass A [JWT-encoded VC](https://www
        InheritedIdentityJWTClass A [JWT-encoded VC](https://www
        RiskAssessmentCredentialJWTClass A [JWT-encoded VC](https://www
        SecurityCheckCredentialJWTClass A [JWT-encoded VC](https://www
MitigatingCredentialClass
MitigationClass
NameClass Name object that represents a user's claimed identity
NamePartClass Abstract class to define a name part value and name part type for an optional...
        FamilyNameClass Name part object that represents a Family Name
        GivenNameClass Name part object that represents a Given Name
PostalAddressClass Any postal address associated with a user, returned by an Address Lookup API ...
PostalAddressGeneralClass An abstract class containing common elements of a postal address
        PostalAddressInternationalClass An international postal address associated with a user, returned by an Addres...
        PostalAddressUKClass A UK postal address associated with a user, returned by an Address Lookup API...
RiskAssessmentClass
SecurityCheckClass
SexClass
StructuredAttributeClass
        ISODateClass Contains a complete or partial ISO date, with no time part and in which the d...
ValidityClass
VerifiableCredentialClass
        AddressCredentialClass
        IdentityAssertionCredentialClass
        IdentityCheckCredentialClass A [VC](https://www
        RiskAssessmentCredentialClass A [VC](https://www
        SecurityCheckCredentialClass A [VC](https://www
        VerifiableIdentityCredentialClass A [VC](https://www

Slots

Slot Description
@context
accountNumber The account number for a bank account
activityFrom The date of the earliest activity found for the user
activityHistoryScore The activity history score based on the check that has taken place as defined...
address
addressCountry The country
addressLocality The town or city in which the address resides
addressRegion The region in which the locality is, and which is in the country, provided as...
aud The aud (audience) claim identifies the recipients that the JWT is intended...
bankAccount
biometricVerificationProcessLevel For a biometric verification process, the level corresponding to the verifica...
birthDate
buildingName The building name is a description applied to a single building or a small gr...
buildingNumber The building number is a number given to a single building or a small group o...
checkDetails
checkMethod An identifier from the OpenID Check Methods list
ci
claims The claims
client_id The client id
code A system level code to indentify a contra-indicator
contraIndicator
credentialJWT
credentialSubject
dataCheck Specifies the kind of data check performed allows for the distinction between...
departmentName For some organisations, department name is indicated because mail is received...
dependentAddressLocality Dependent locality areas define an area within a town
dependentStreetName In certain places, for example, town centres, there are named thoroughfares/s...
description
document The single string representation of a document that a contra-indicator was ra...
documentNumber An identifier generated for the specific document when it was issued, for exa...
documentType An identifier of the type of document, for example IR for Biometric Residence...
doubleDependentAddressLocality This is used to distinguish between similar thoroughfares/streets or the same...
drivingPermit
evidence
evidence_requested
exp The exp (expiration time) claim identifies the time the JWT expires
expiryDate The date the document expires
failedCheckDetails
fraudCheck Specifies the kind of fraud check performed as defined in the [Good Practice ...
fullAddress Unparsed address string as retrieved from optical character recognition read ...
govuk_signin_journey_id The journey id value as assigned by the GOV
iat The iat (issued at) claim identifies the time at which the JWT was issued
icaoIssuerCode An identifier for the issuing State or Organisation of a passport as defined ...
id The identifier of a verifiable credential
idCard
identityCheckLevel A measure of the level of identity confidence held by the issuer or previousl...
identityCheckPolicy Details of the type of policy that was checked as part of the identity check
identityFraudScore The identity fraud score based on the check that has taken place as defined i...
incompleteMitigation A partial or uncompleted mitigation that has taken place against a particular...
intervention Intervention required by the risk assessment
interventionCode
interventionReason
iss The iss (issuer) claim identifies the principal that issued the JWT
issuanceDate The date a contra-indicator was generated
issueDate The date the document was issued by the issuing authority
issuedBy An identifier for the issuing authority, for example, DVLA
issueNumber An identifier that changes with each issue of the document - unique only with...
issuer The issuer of a verifiable credential
issuers An array of cri issuers
issuingCountry Issuing country for documents represented as an [ISO 3166 two character count...
jti The jti (JWT ID) claim identifies the unique identifier of the JWT
kbvQuality The quality of a knowledge-based verification (KBV) question
kbvResponseMode Describes the way a KBV question was presented to the user
mitigatingCredential Details of the credential that was generated as part of the mitigation journe...
mitigation A completed mitigation that has taken place against a particular contra-indic...
name
nameParts The list of name parts that make up a [Name](
nbf The nbf (not before) claim identifies the time the JWT is valid from
nonce The nonce
organisationName The organisation name is the business name given to a delivery point within a...
passport
personalNumber An identifier that is common across documents issued to the same individual, ...
photoVerificationProcessLevel For a photo-based verification process, the level corresponding to the verifi...
poBoxNumber Post Office Box (PO Box) number
postalCode A UK postcode is an abbreviated form of address made up of combinations of be...
prompt Use the value login to force a user to authenticate again even if they have...
redirect_uri The redirect uri
residencePermit
response_type The response type
scope The scope
scoringPolicy The scoring policy that is applicable for the evidence requested scores
sex A person's legal sex
shared_claims The shared claims
socialSecurityRecord
sortCode The sort code for a bank account
state The state
streetName A thoroughfare/street is fundamentally a road, track or named access route, f...
strengthScore The strength score based on the check that has taken place as defined in the ...
sub The sub (subject) claim identifies the principal that is the subject of the...
subBuildingName The sub-building name and/or number are identifiers for subdivisions of prope...
txn A unique transaction identifier for this check, or part of a check, if any
type The type of name represented by the [NamePart](
uprn The Unique Property Reference Number (UK and Northern Ireland Addresses Only)...
validFrom
validityScore The validity score based on the check that has taken place as defined in the ...
validUntil
value
vc
verificationScore The verification score based on the check that has taken place as defined in ...
vot The vot identifies the Vector Of Trust
vtm The vtm identifies the Vector Trust Mark
vtr The Vector of Trust request

Enumerations

Enumeration Description
CheckMethodType
DataCheckType
FraudCheckType
IdentityCheckPolicyType
IdentityCheckType
IdentityVectorOfTrust
KBVResponseModeType
NamePartType Reference data enumeration applied to the type property for a specific [Nam...
VerifiableCredentialType

Types

Type Description
Boolean A binary (true or false) value
Curie a compact URI
Date a date (year, month and day) in an idealized calendar
DateOrDatetime Either a date or a datetime
Datetime The combination of a date and time
Decimal A real number with arbitrary precision that conforms to the xsd:decimal speci...
Double A real number that conforms to the xsd:double specification
Float A real number that conforms to the xsd:float specification
Integer An integer
Jsonpath A string encoding a JSON Path
Jsonpointer A string encoding a JSON Pointer
JWS
Ncname Prefix part of CURIE
Nodeidentifier A URI, CURIE or BNODE that represents a node in a model
Objectidentifier A URI or CURIE that represents an object in the model
Sparqlpath A string encoding a SPARQL Property Path
String A character string
StringOrURI
Time A time object represents a (local) time of day, independent of any particular...
Uri a complete URI
Uriorcurie a URI or a CURIE

Subsets

Subset Description