Skip to main content
Templates and catalogues

List credential definition templates

GET/v4/config/ows/issuer/credential-definition-templates

Lists the credential definition templates: ready claims for common credentials (for example PID, LPID, mDL, a student ID or a boarding pass), from the rulebooks of the platform. Each item is one credential format of the newest version of a rulebook, with the id <rulebook id>:<version>:<format>, so a name comes once for each format of its rulebook. The list is in the order of the rulebook id, then dc+sd-jwt, jwt_vc_json, mso_mdoc. Copy the schema of a template into a credential configuration of Create credential definition. The PID templates follow PID Rulebook v1.7, so a credential definition made from them passes the PID rules of the create call.

Authorizations

  • Authorizationstringheaderrequired

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

    Scope:credential-definitions:read

Query parameters

  • offsetinteger

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

    At least 0.

    Default:0

  • limitinteger

    Maximum number of records to return per page.

    Default:10

Response

application/json

One page of the templates.

  • templatesobject[]

    The templates of the page.

  • paginationobject

    The position of the page in the list. This call pages with offset and limit, not with a cursor.