Sign in

v8

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-05730512.7 KB
Credentials

Create a credential schema

Create a credential schema for your tenant. You define the schema name, VCT (Verifiable Credential Type), and claim attributes. The API returns the stored schema with defaults such as format, version, branding, revocability, and status.

post/v1/credential-schemas

Request body

namestring required

Human-readable schema name.

vctstring required

VCT (Verifiable Credential Type) value to embed in issued credentials.

Example request

{
  "name": "Loyalty Membership",
  "vct": "AirlineLoyalty",
  "attributes": [
    {
      "name": "given_name",
      "sd": true
    },
    {
      "name": "tier",
      "sd": true
    }
  ]
}

Response

The credential schema was created.

uuidstring uuid

Unique identifier of the credential schema.

namestring

Human-readable schema name.

vctstring

VCT (Verifiable Credential Type) value embedded in credentials issued from this schema.

versionstring

Schema version string.

formatstring

Credential format. The captured value is sd_jwt_vc, the SD-JWT VC (Selective-Disclosure JWT Verifiable Credential) format.

brandingobject

Wallet branding object returned with the schema. The captured example is an empty object.

revocableboolean

Whether issued credentials from this schema can be revoked.

statusstring

Lifecycle status of this schema version.

supersedesstring uuid nullable

Schema UUID that this version supersedes. Null means this is the first version.

created_atstring date-time

Timestamp when the schema was created.

Example response

{
  "uuid": "2e844e4b-e7da-4d94-828e-eee9bdf66349",
  "name": "Loyalty Membership",
  "vct": "AirlineLoyalty",
  "version": "1.0",
  "format": "sd_jwt_vc",
  "attributes": [
    {
      "name": "given_name",
      "sd": true
    },
    {
      "name": "tier",
      "sd": true
    }
  ],
  "branding": {},
  "revocable": true,
  "status": "active",
  "created_at": "2026-07-02T23:33:33.468912Z"
}