Read credential definition

GET 
/v2/config/digital-wallet/openid/sdjwt/credential-definition/:credentialDefinitionId

This endpoint is used to read credential definition by ID.

Request

Path Parameters

credentialDefinitionId stringrequired

Identifier for the credential definition.

Responses

200

Response Headers

application/json

Schema

Schema

credentialDefinition object
credentialDefinitionId stringrequired
Identifier for the credential definition
type string[]
Specifies the credential type to be present in verifiable credential issued.
credentialDefinition objectrequired
Defines the structure of the verifiable credential as per JSON schema specification.
createdAt numberrequired
Timestamp when the record was created.
updatedAt numberrequired
Timestamp when the record was updated.
label stringrequired
Defines the usage purpose for the credential definition. For e.g. Issue Portable Document A1
expirationInDays numberrequired
Defines the expiration for verifiable credential in days. If not specified, by default it is specified as 30 days.
display object
name stringrequired
Defines name for the credential
locale stringrequired
Defines language for the credential. eg. en-GB
description string
Defines the discription for the credential definition.
backgroundColor stringrequired
Defines background color for the credential
textColor stringrequired
Defines text color for the credential.
credentialFormat string
Possible values: [jwt_vc_json, dc+sd-jwt, mso_mdoc]
Specifies the credential format for verifiable credential.
vct string
Specifies the credential type to be present in verifiable credential issued for ietf sd-jwt.
doctype string
Specifies the credential type to be present in verifiable credential issued for mso mdoc.
claims object
Defines the structure of the verifiable credential as per JSON schema specification for ietf sd-jwt and mso mdoc.
property name* any
Defines the structure of the verifiable credential as per JSON schema specification for ietf sd-jwt and mso mdoc.
supportRevocation boolean
Specifies the verifiable credential supports revocation.
enforceWUA boolean
Specifies the verifiable credential should enforce wallet unit attestation
validationPath string
Possible values: [$.vc.credentialSubject, $.vc, $]
Specifies the validation path for the credential definition
version string
Possible values: [draft_11, draft_13]
Specifies the version of oid4vci draft specification
kid string
Specifies the key identifier of keys to be used for credential issuance
trustAnchor string
Possible values: [jwk, did:key, did:ebsi, did:web]
Specifies the trust anchor used for credential issuance
revocationMethod string
Possible values: [status_list, status_list_2021]
Specifies the revocation method for the credential definition
enforceCredentialUniqueness boolean
Specifies the verifiable credential supports credential uniqueness
supportCredentialReissuance boolean
Specifies the verifiable credential supports credential reissuance
credentialDefinitions object[]
Array [
type string[]
Specifies the credential type to be present in verifiable credential issued.
credentialDefinition object
Defines the structure of the verifiable credential as per JSON schema specification.
property name* any
Defines the structure of the verifiable credential as per JSON schema specification.
expirationInDays number
Defines the expiration for verifiable credential in days. If not specified, by default it is specified as 30 days.
credentialDefinitionUri string
display object
name string
Defines name for the credential
description string
Defines the discription for the credential definition.
backgroundColor string
Defines background color for the credential
textColor string
Defines text color for the credential.
credentialFormat string
Possible values: [jwt_vc_json, dc+sd-jwt, mso_mdoc]
Specifies the credential format for verifiable credential.
vct string
Specifies the credential type to be present in verifiable credential issued for ietf sd-jwt.
doctype string
Specifies the credential type to be present in verifiable credential issued for mso mdoc.
claims object
Defines the structure of the verifiable credential as per JSON schema specification for ietf sd-jwt and mso mdoc.
property name* any
Defines the structure of the verifiable credential as per JSON schema specification for ietf sd-jwt and mso mdoc.
supportRevocation boolean
Specifies the verifiable credential supports revocation.
enforceWUA boolean
Specifies the verifiable credential should enforce wallet unit attestation
validationPath string
Possible values: [$.vc.credentialSubject, $.vc, $]
Specifies the validation path for the credential definition
revocationMethod string
Possible values: [status_list, status_list_2021]
Specifies the revocation method for the credential definition
enforceCredentialUniqueness boolean
Specifies the verifiable credential supports credential uniqueness
supportCredentialReissuance boolean
Specifies the verifiable credential supports credential reissuance
id string
Specifies the identifier for credential definition object
]

Example (from schema)

{
  "credentialDefinition": {
    "credentialDefinitionId": "string",
    "type": [
      "string"
    ],
    "credentialDefinition": {},
    "createdAt": 0,
    "updatedAt": 0,
    "label": "string",
    "expirationInDays": 0,
    "display": {
      "name": "string",
      "locale": "string",
      "description": "string",
      "backgroundColor": "string",
      "textColor": "string"
    },
    "credentialFormat": "jwt_vc_json",
    "vct": "string",
    "doctype": "string",
    "claims": {},
    "supportRevocation": true,
    "enforceWUA": true,
    "validationPath": "$.vc.credentialSubject",
    "version": "draft_11",
    "kid": "string",
    "trustAnchor": "jwk",
    "revocationMethod": "status_list",
    "enforceCredentialUniqueness": true,
    "supportCredentialReissuance": true,
    "credentialDefinitions": [
      {
        "type": [
          "string"
        ],
        "credentialDefinition": {},
        "expirationInDays": 0,
        "credentialDefinitionUri": "string",
        "display": {
          "name": "string",
          "description": "string",
          "backgroundColor": "string",
          "textColor": "string"
        },
        "credentialFormat": "jwt_vc_json",
        "vct": "string",
        "doctype": "string",
        "claims": {},
        "supportRevocation": true,
        "enforceWUA": true,
        "validationPath": "$.vc.credentialSubject",
        "revocationMethod": "status_list",
        "enforceCredentialUniqueness": true,
        "supportCredentialReissuance": true,
        "id": "string"
      }
    ]
  }
}

Loading...