List credential definition templates

GET 
/v2/config/digital-wallet/openid/sdjwt/credential-definition/templates

Lists the pre-defined credential schema templates that you can use to create a credential definition. The platform returns only the latest version of each schema. A claim path pointer schema has one entry for each credential format, so the same name and version can appear more than once. When the platform cannot read the schema repository, it returns an empty templates array and no pagination object.

Request

Query Parameters

offset integerrequired

Default value: 0

Number of records to skip for pagination. A negative or unreadable value falls back to 0.

limit integerrequired

Default value: 10

Maximum number of records to return per page.

Responses

200

Credential definition templates listed successfully

Response Headers

application/json

Schema

Schema

templates object[]

Credential schema templates for the current page.

pagination object

Offset based pagination for the template list. This operation does not use the page based pagination of the other list operations.

offset integer

Number of templates that the server skipped.

limit integer

Maximum number of templates per page. Defaults to 10.

totalItems integer

Total number of templates available.

hasPrevious boolean

Indicates whether a previous page exists.

hasNext boolean

Indicates whether a next page exists.

Example (from schema)

{
  "templates": [
    {
      "name": "LegalPersonIdentificationData",
      "type": "jsonSchema",
      "version": "1.0.0",
      "schema": {},
      "metadata": {
        "id": "WgWxqztrNooG92RXvxSTWv",
        "credentialType": "LegalPersonIdentificationData",
        "isJwt": true,
        "isMsoMdoc": true,
        "isSdJwt": true,
        "title": "Legal Person Identification Data (LPID)",
        "isClaimPathPointer": true,
        "doctype": "org.iso.18013.5.1.mDL",
        "namespace": "org.iso.18013.5.1",
        "versionSupported": [
          "version_01"
        ]
      }
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 10,
    "totalItems": 12,
    "hasPrevious": false,
    "hasNext": true
  }
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...