Type alias CredentialQuery

CredentialQuery: {
    docType: string;
    nameSpaces: {
        [nameSpace: string]: {
            [claim: string]: CredentialQueryClaim;
        };
    };
    profile: OpenidPresentationCredentialProfileSupported;
}

Credential query

Type declaration

  • docType: string

    the mDL’s type. Confirm with the certificate issuer for what docType they are issuing. Some common examples include:

    • Mobile Driver License (org.iso.18013.5.1.mDL).
    • PhotoID (org.iso.23220.photoid.1).
    • Mobile Vehicle Registration Card (org.iso.7367.1.mVRC).
    • Health certificate (org.micov.vtr.1).
  • nameSpaces: {
        [nameSpace: string]: {
            [claim: string]: CredentialQueryClaim;
        };
    }

    Each namespace corresponds to a group of claims included in the credential. These can be claims that are part of a specific standard, jurisdiction or any other reference. The namespace would usually correspond to the requested docType.

  • profile: OpenidPresentationCredentialProfileSupported

    Credential format of the credential that will be verified. Currently only mobile (mDocs) is supported.

Example

// The following example credential query will request the `birthdate` and `portrait` claims from a `mobile` credential `profile` with `org.iso.18013.5.1.mDL` as a `docType`:
 {
  "profile": "mobile",
  "docType": "org.iso.18013.5.1.mDL",
  "nameSpaces": {
    "org.iso.18013.5.1": {
      "birthdate": {
          "intentToRetain": false
       },
      "portrait": {
        "intentToRetain": false
      },
      "resident_postal_code": {
        "intentToRetain": false
       }
     },
   }
 }

Settings

Member Visibility

Theme

Generated using TypeDoc