Skip to main content
Version: Next

CredentialQuery

idstringrequired

Unique identifier for this credential query

Example: identity_credential
formatstringrequired

Credential format identifier

Possible values: [jwt_vc_json, ldp_vc, dc+sd-jwt, mso_mdoc]

Example: dc+sd-jwt
multipleboolean

Whether multiple credentials can be returned for this query

Example: false
meta object

Format-specific metadata and constraints

vct_valuesstring[]

For SD-JWT VC: allowed vct values

Example: ["https://credentials.example.com/identity_credential"]
type_valuesarray[]

For W3C VC: allowed type values

Example: [["VerifiableCredential","IDCredential"]]
doctype_valuestring

For mdoc: document type value

Example: org.iso.18013.5.1.mDL
trusted_authorities object[]

Trusted authorities or trust frameworks

  • Array [
  • typestringrequired

    Type of trusted authority mechanism

    Possible values: [aki, etsi_tl, openid_federation]

    Example: openid_federation
    valuesstring[]required

    Array of trusted authority identifiers

    Example: ["https://trustanchor.example.com"]
  • ]
  • require_cryptographic_holder_bindingboolean

    Whether cryptographic holder binding is required

    Example: true
    claims object[]

    Specific claims to request from the credential

  • Array [
  • idstring

    Unique identifier for this claim query

    Example: family_name_claim
    pathstring[]required

    Array representing path to claim in credential

    Example: ["credentialSubject","familyName"]
    valuesstring[]

    Expected values for value matching

    Example: ["Doe","Smith"]
  • ]
  • claim_setsarray[]

    Alternative combinations of claims

    Example: [["claim1","claim2"],["claim3"]]
    CredentialQuery
    {
    "id": "identity_credential",
    "format": "dc+sd-jwt",
    "multiple": false,
    "meta": {
    "vct_values": [
    "https://credentials.example.com/identity_credential"
    ],
    "type_values": [
    [
    "VerifiableCredential",
    "IDCredential"
    ]
    ],
    "doctype_value": "org.iso.18013.5.1.mDL"
    },
    "trusted_authorities": [
    {
    "type": "openid_federation",
    "values": [
    "https://trustanchor.example.com"
    ]
    }
    ],
    "require_cryptographic_holder_binding": true,
    "claims": [
    {
    "id": "family_name_claim",
    "path": [
    "credentialSubject",
    "familyName"
    ],
    "values": [
    "Doe",
    "Smith"
    ]
    }
    ],
    "claim_sets": [
    [
    "claim1",
    "claim2"
    ],
    [
    "claim3"
    ]
    ]
    }