Skip to main content

Name(s) of the Credential(s) – Credential Documentation

1. About this Document​

This document describes the Name(s) of the Credential(s) to help potential verifiers determine whether it is suitable for their needs. The intended audience includes policy analysts, privacy specialists, solution architects, developers, and data architects.

1.1 Version History​

Ver.DateNotes
1.0

2. Credential Overview​

A paragraph summarizing what the Credential(s) is, its purpose, and other notable information.

2.1 Credential Details​

Name(s) of the Credential(s):Names(s) of the Credential(s)
Issuer:Issuer of the Credential(s)
Holders:Summary of who is eligible to be issued the Credential(s)
Data Source:Summary of the source(s) of the information in the credential(s)
Issuer DID:DID of the Issuer
Format:Technical format, e.g., AnonCreds, W3C
Schema:- Name, version, and address of the Schema Documentation of the Schema, if available
Credential Definition:- Name address of the credential definition
Data Registry:Registry address
OCA:Link to the Overlay Capture Architecture bundle for this credential

2.2 Attribute Summary​

Display Name of AttributeAttributeFormat
Given Namesgiven_namesstring
Family Namefamily_namestring
Date of Birthbirthdate_dateintinteger
.........

3. Governance & Legal​

3.1 Governing Authority & Administrative Authority​

The governing body with the authority to issue and revoke the credential(s), including contact information unless an administrative authority is intended to be the contact.
[https://glossary.trustoverip.org/#term:governing-body]

The Ministry of Citizens’ Services, as the Provincial Identity Information Services Provider as defined in section 69.2 of the Freedom of Information and Access to Information Act, is the governing authority for the BC Person credential.

_If different than the Governing Authority, the administrative body that has been delegated operational responsibilities by the governing authority, including contact information.
[https://glossary.trustoverip.org/#term:administering-body] _

Within the Ministry of Citizens’ Services, the Cybersecurity and Digital Trust Branch and the Service BC Division have operational responsibility for the BC Person credential.

3.2.1 For Verifiers​

A statement – included or linked to – limiting the liability of the issuer (and, if different, the governing and administrative authorities) for any harms suffered by parties that accept the credential.

3.2.2 For End Users​

A statement – included or linked to – limiting the liability of the issuer (and, if different, the governing and administrative authorities) for any harms suffered by parties that are issued the credential. This will often be presented to end users during the issuance process.

Person credential Terms of Use.

4. Credential Data, Issuance, and Changes​

4.1 Data Source(s)​

Where the data in the credential comes from, and how the issuer ensures that it is correct when collected.

4.2 Data Updates​

How and when the Issuer gets updates to the data that goes into the credential. How the credential gets updated should be left for the Revocation section, below.

4.3 Issuance​

Describes the process for issuing the credential sufficiently that a prospective verifier will have a good sense of how the issuer ensures that the credential is issued to only the correct party. This should include how the prospective holder is identified and authenticated before being issued a credential. This may reference the Data Source(s) section in explaining how the holder will have a credential with correct data.

Also: if the credential is issued to individuals or organizations, indicate what type(s) of wallets (e.g., BC Wallet) the credential will be issued to, or if the credential will be issued to any brand or type of wallet.

4.4 Revocation​

Describes the circumstances – either specifically or in general – that would cause the issuer to revoke a credential after it has been issued to the Holder.

  • The credential will be revoked in the following cases: ...
  • The credential will be revoked and re-issued in the following cases: ...

5. Credential Definition​

5.1 Subject​

The type of entity – e.g., a person, company, title – that is described by the attributes.

The subject of a Person credential is the individual to whom it was issued, i.e., its holder. See the Credential Assurance section, above, for why a verifier can be confident that the holder of a Person credential is the subject of the credential.

5.2 Attributes​

A list of all the attributes in the credential, with a table describing each attribute. Subheadings and notes may be used to provide information that applies to a group of attributes, e.g., “Name” to describe Given Names and Family Name, “Address” to describe the set of address attributes. Repeat the table for each individual attribute

FieldDescription
Display NameName displayed in the wallet next to the data value (e.g. Birthdate)
DescriptionDescribes the data that will be in the attribute (e.g. The individual's documented birth date recorded from valid identification.)
AttributeName of attribute in schema or credential (e.g. birthdate_dateint)
FormatHow the data is presented (e.g., minimum or maximum characters, how multiple values are delimited, date format is YYYYMMDD)
RulesThings such as whether the attribute can be blank or not, and how data is handled if the source system data has more characters than the maximum characters defined in the Format
ExamplesOne to three samples of the data that a verifier could find in this attribute (e.g. 19711225, 19711013, 19580816)
NotesAdditional information about the data that may (or not) be present in the attribute, in particular any “quirks” in the data that could affect a verifier trying to process the data or compare it to other records (including common attributes, such as family_name, in other credentials that may be part of the same proof request but have come from different issuers).
FieldDescription
Display Name
Description
Attribute
Format
Rules
Examples
Notes