Fetch SD-JWT VC Type Metadata

GET

/credentials/{vct_path}

const url = 'https://example.com/credentials/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/credentials/example

Returns public SD-JWT VC Type Metadata for a configured OID4VCI credential configuration whose vct exactly matches the requested absolute URL. The path key uses the OpenAPI single-segment form {vct_path} for standard tooling compatibility, but the route is a multi-segment catch-all: vct_path captures the full path remainder after /credentials/ (slashes included, not percent-encoded) and may span multiple segments. This route is intentionally unversioned and must remain at /credentials/{vct_path} (without a /v1/ prefix): per SD-JWT VC type-metadata dereference, a client resolves the credential type by dereferencing the vct claim directly (for example, https://{host}/credentials/{vct_path}), so the server path must match the vct URL path component exactly. Adding a /v1/ prefix would break dereference for any credential whose vct does not include that prefix. This route serves type metadata only and is unrelated to POST /v1/credentials (credential issuance).

Parameters

Path Parameters

vct_path

required

string

/^[^/]+(/[^/]+)*$/

Full path remainder after /credentials/ captured as a multi-segment catch-all. The value is the unencoded path suffix of the VCT URL (slashes not percent-encoded) and may contain one or more segments.

Responses

200

SD-JWT VC Type Metadata

application/json

object

claims

required

Array<object>

object

display

required

Array<object>

object

label

required

string

locale

required

string

key

additional properties

any

mandatory

required

boolean

path

required

Array<string>

registry_notary_semantics

Optional semantic binding for a Notary claim. These fields label the claim output or predicate with external vocabulary terms such as PublicSchema URIs; they do not change the Notary result shape or by themselves prove privacy minimization.

object

concept

External concept URI, for example https://publicschema.org/Person.

string

derived_from

External property URIs the predicate or derived value depends on.

Array<string>

predicate

External or local predicate URI/URN for derived boolean claims.

string

property

External property URI for raw value claims, for example https://publicschema.org/date_of_birth.

string

value_mapping

Operator label for the value mapping/canonicalization applied before returning the claim.

string

vocabulary

External vocabulary or value-set URI used by the claim value.

string

required

string

Allowed values: always

key

additional properties

any

description

string

display

required

Array<object>

object

locale

required

string

name

required

string

key

additional properties

any

name

required

string

vct

required

string format: uri

key

additional properties

any

Example

{
  "claims": [
    {
      "display": [
        {
          "label": "Person is alive",
          "locale": "en-US"
        }
      ],
      "mandatory": true,
      "path": [
        "person-is-alive"
      ],
      "registry_notary_semantics": {
        "concept": "https://publicschema.org/Person",
        "derived_from": [
          "https://publicschema.org/date_of_death"
        ],
        "predicate": "urn:registry-notary:predicate:person-is-alive"
      },
      "sd": "always"
    }
  ],
  "display": [
    {
      "background_color": "#0057B8",
      "description": "Proof that the civil registry currently records this person as alive.",
      "locale": "en-US",
      "name": "Person is alive",
      "text_color": "#FFFFFF"
    }
  ],
  "name": "Person is alive",
  "vct": "https://issuer.example.gov/credentials/person-is-alive"
}

404

OpenID4VCI issuer is disabled or no configured vct matches the requested URL