Skip to main content
Credential definitions

Read credential definition

GET/v4/config/ows/issuer/credential-definitions/{definitionId}

Returns one credential definition with its credential configurations: for each, the format, the claims, the validity, the revocation, the holder binding and the signing key. Each configuration also has the check of its signing key at the time of the read (signingKeyCheck), so you see when a key does not fit its credential category. definitionVersion is the current version; read an earlier version with Read credential definition version.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:credential-definitions:read

Path parameters

Response

application/json

The credential definition.

  • credentialDefinitionobject

    A credential definition. The top-level members are the settings of the whole definition (label, signing key, trust in wallets, issuance options); credentialConfigurations has the credential configurations that the issuer publishes in the Credential Issuer Metadata. Some top-level members (the format, the type, the claims, the validity, the holder binding and the proof types) are read-only copies of the first credential configuration: the configurations govern the issuance.