Sign in

v8

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

Cut the next immutable version of a schema (bumps version, deprecates the source).

Create the next immutable version of a credential schema. You provide the attributes for the new version. The response returns the new version and the full version family.

post/v1/credential-schemas/{uuid}/versions

Path parameters

uuidstring required

UUID of the source credential schema version.

Request body

Example request

{
  "attributes": [
    {
      "name": "employee_id",
      "sd": true
    },
    {
      "name": "department",
      "sd": false
    },
    {
      "name": "clearance",
      "sd": true
    }
  ]
}

Response

The next schema version was created.

uuidstring uuid

Unique identifier of the new credential schema version.

namestring

Human-readable schema name.

vctstring

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

versionstring

Schema version string for the new version.

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 the new schema version.

supersedesstring uuid nullable

Schema UUID that this version supersedes.

created_atstring date-time

Timestamp when the new schema version was created.

Example response

{
  "uuid": "315145dd-d88e-41ae-997f-d35e2e81edd0",
  "name": "Employee Badge kgm1",
  "vct": "EmployeeBadge",
  "version": "1.1",
  "format": "sd_jwt_vc",
  "attributes": [
    {
      "name": "employee_id",
      "sd": true
    },
    {
      "name": "department",
      "sd": false
    },
    {
      "name": "clearance",
      "sd": true
    }
  ],
  "branding": {},
  "revocable": true,
  "status": "active",
  "supersedes": "c24a6fbe-3375-42d0-aead-c5f628f6a18d",
  "created_at": "2026-07-02T23:33:33.637740Z",
  "versions": [
    {
      "created_at": "2026-07-02T23:33:33.637740+00:00",
      "is_latest": true,
      "issued_count": 0,
      "status": "active",
      "supersedes": "c24a6fbe-3375-42d0-aead-c5f628f6a18d",
      "uuid": "315145dd-d88e-41ae-997f-d35e2e81edd0",
      "vct": "EmployeeBadge",
      "version": "1.1"
    },
    {
      "created_at": "2026-07-02T23:33:33.625738+00:00",
      "is_latest": false,
      "issued_count": 1,
      "status": "deprecated",
      "supersedes": null,
      "uuid": "c24a6fbe-3375-42d0-aead-c5f628f6a18d",
      "vct": "EmployeeBadge",
      "version": "1.0"
    }
  ]
}