Sign in

v8

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

Deprecate or reactivate a schema version (deprecated blocks NEW issuance only).

Update the status of a schema version. Use this to change whether that version can be used for new issuance. The response includes the schema and its version family.

patch/v1/credential-schemas/{uuid}

Path parameters

uuidstring required

UUID of the credential schema version to update.

Request body

statusstring required

New lifecycle status for the schema version.

Example request

{
  "status": "deprecated"
}

Response

The schema version status was updated.

uuidstring uuid

Unique identifier of the 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.

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 after the update.

supersedesstring uuid nullable

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

created_atstring date-time

Timestamp when the schema version was created.

Example response

{
  "uuid": "c24a6fbe-3375-42d0-aead-c5f628f6a18d",
  "name": "Employee Badge kgm1",
  "vct": "EmployeeBadge",
  "version": "1.0",
  "format": "sd_jwt_vc",
  "attributes": [
    {
      "name": "employee_id",
      "sd": true
    },
    {
      "name": "department",
      "sd": false
    }
  ],
  "branding": {},
  "revocable": true,
  "status": "deprecated",
  "created_at": "2026-07-02T23:33:33.625738Z",
  "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"
    }
  ]
}