v8

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

Credentials

Fetch one schema plus its full version family.

Fetch one credential schema and its version family. Use this to inspect the current schema fields and see which versions are active or deprecated.

get/v1/credential-schemas/{uuid}

Path parameters

uuidstring required

UUID of the credential schema to fetch.

Response

Credential schema details with its version history.

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",
  "versions": [
    {
      "created_at": "2026-07-02T23:33:33.468912+00:00",
      "is_latest": true,
      "issued_count": 0,
      "status": "active",
      "supersedes": null,
      "uuid": "2e844e4b-e7da-4d94-828e-eee9bdf66349",
      "vct": "AirlineLoyalty",
      "version": "1.0"
    }
  ]
}