Credential definitions

Read credential definition version

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

Returns a credential definition as it was in one version. Each create and update of a credential definition makes a new version, and a version never changes. An issuance history follows the version that it started with (credentialDefinition.definitionVersion of Read issuance history): use this call to see the settings that governed it. The answer has the shape of Read credential definition, without the checks of the signing keys.

Language of the request sample

curl 'https://demo-api.igrant.io/v4/config/ows/issuer/credential-definitions/{definitionId}/versions/{version}' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "credentialDefinition": {
    "id": "daecf451-6cf9-441e-b0e8-df60ebce09f3",
    "credentialDefinitionId": "daecf451-6cf9-441e-b0e8-df60ebce09f3",
    "createdAt": 1794148920,
    "updatedAt": 1794148920,
    "openIdOrganisationId": "60905277-d953-4ef7-aa4c-cec413d00d93",
    "label": "Person identification data",
    "validityDays": 180,
    "validitySeconds": 15552000,
    "display": {
      "name": "",
      "locale": "en-GB",
      "logo": {
        "uri": "https://demo-api.igrant.io/v4/onboard/platform/image/6ae2bf741c3dadfeb27982ee/web",
        "altText": ""
      },
      "description": "",
      "backgroundColor": "",
      "backgroundImage": {
        "uri": "https://demo-api.igrant.io/v4/onboard/platform/image/6ae2bf741c3dadfeb27982ed/web"
      },
      "textColor": ""
    },
    "credentialDefinitionUri": "",
    "credentialFormat": "dc+sd-jwt",
    "claims": {
      "claims": [
        {
          "path": [
            "family_name"
          ],
          "mandatory": true,
          "limitDisclosure": true
        },
        {
          "path": [
            "given_name"
          ],
          "mandatory": true,
          "limitDisclosure": true
        },
        {
          "path": [
            "birthdate"
          ],
          "mandatory": true,
          "limitDisclosure": true
        },
        {
          "path": [
            "nationalities"
          ],
          "mandatory": true,
          "limitDisclosure": true
        },
        {
          "path": [
            "issuing_authority"
          ],
          "mandatory": true,
          "limitDisclosure": true
        },
        {
          "path": [
            "issuing_country"
          ],
          "mandatory": true,
          "limitDisclosure": true
        },
        {
          "path": [
            "date_of_expiry"
          ],
          "mandatory": true,
          "limitDisclosure": true
        }
      ]
    },
    "requiresTrustedWalletProvider": false,
    "acceptedWalletProviders": [],
    "allowsJwtProof": true,
    "allowsAttestationProof": true,
    "externalOpenidProviderId": "",
    "validationPath": "$",
    "version": "version_01",
    "cryptographicKeyFormat": "x509",
    "cryptographicKeyIdentifier": "c6b150f6dcd446459a66192e8f8303d1",
    "requiresCredentialUniqueness": false,
    "allowsCredentialReissuance": true,
    "credentialConfigurations": [
      {
        "vct": "urn:eudi:pid:1",
        "claims": {
          "claims": [
            {
              "path": [
                "family_name"
              ],
              "mandatory": true,
              "limitDisclosure": true
            },
            {
              "path": [
                "given_name"
              ],
              "mandatory": true,
              "limitDisclosure": true
            },
            {
              "path": [
                "birthdate"
              ],
              "mandatory": true,
              "limitDisclosure": true
            },
            {
              "path": [
                "nationalities"
              ],
              "mandatory": true,
              "limitDisclosure": true
            },
            {
              "path": [
                "issuing_authority"
              ],
              "mandatory": true,
              "limitDisclosure": true
            },
            {
              "path": [
                "issuing_country"
              ],
              "mandatory": true,
              "limitDisclosure": true
            },
            {
              "path": [
                "date_of_expiry"
              ],
              "mandatory": true,
              "limitDisclosure": true
            }
          ]
        },
        "credentialFormat": "dc+sd-jwt",
        "validationPath": "$",
        "expirationInDays": 180,
        "expirationInSeconds": 15552000,
        "display": {
          "locale": "en-GB",
          "name": "Person identification data",
          "description": "Your PID from the national registry.",
          "logo": {
            "uri": "https://demo-api.igrant.io/v4/onboard/platform/image/6ae2bf741c3dadfeb27982ee/web"
          },
          "backgroundColor": "#1c3f94",
          "backgroundImage": {
            "uri": "https://demo-api.igrant.io/v4/onboard/platform/image/6ae2bf741c3dadfeb27982ed/web"
          },
          "textColor": "#ffffff"
        },
        "revocation": {
          "enabled": true,
          "method": "status_list",
          "revokeWhenHolderDeletes": true
        },
        "enforceCredentialUniqueness": false,
        "supportCredentialReissuance": true,
        "credentialBindingMethods": [
          "jwk"
        ],
        "keyAttestationsRequired": {},
        "supportJwtProof": true,
        "supportAttestationProof": true,
        "authorizationRequestType": "authorization_details",
        "scope": "urn:eudi:pid:1jwpQP4LV",
        "label": "PID",
        "credentialResponseInterval": 5,
        "cryptographicKeyFormat": "x509",
        "cryptographicKeyIdentifier": "c6b150f6dcd446459a66192e8f8303d1",
        "credentialCategory": "eaa",
        "id": "49225dfc-59eb-4c60-b16d-e7f53f00c16f",
        "credentialConfigurationId": "urn:eudi:pid:1jwpQP4LV"
      }
    ],
    "credentialBindingMethods": [
      "jwk"
    ],
    "namespace": "",
    "isSystemManaged": false,
    "isExtensionEnabled": false,
    "requiresInteractiveAuthorisation": false,
    "allowsWalletInitiatedIssuance": false,
    "allowsCredentialOfferReuse": false,
    "definitionVersion": 1
  }
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:credential-definitions:read

Path parameters

definitionIdstringrequired
The id of the credential definition (credentialDefinitionId), from List credential definitions.
versionintegerrequired
The version of the credential definition: definitionVersion of the definition, or credentialDefinition.definitionVersion of an issuance history. The first version is 1.
At least 1.

Response

application/json

The credential definition as it was in the version.

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.