Skip to main content
POST
/
api
/
{serviceId}
/
vci
/
metadata
Typescript (SDK)
import { Authlete } from "@authlete/typescript-sdk";

const authlete = new Authlete({
  bearer: process.env["AUTHLETE_BEARER"] ?? "",
});

async function run() {
  const result = await authlete.verifiableCredentials.getMetadata({
    serviceId: "<id>",
    vciMetadataRequest: {
      pretty: true,
    },
  });

  console.log(result);
}

run();
{
  "resultCode": "<string>",
  "resultMessage": "<string>",
  "action": "OK",
  "responseContent": "<string>"
}

Authorizations

​
Authorization
string
header
required

Authenticate every request with a Service Access Token or Organization Token. Set the token value in the Authorization: Bearer <token> header.

Service Access Token: Scoped to a single service. Use when automating service-level configuration or runtime flows.

Organization Token: Scoped to the organization; inherits permissions across services. Use for org-wide automation or when managing multiple services programmatically.

Both token types are issued by the Authlete console or provisioning APIs.

Path Parameters

​
serviceId
string
required

A service ID.

Body

​
pretty
boolean
required

The flag indicating whether the metadata is written in the pretty format or not.

Response

VCI metadata retrieved successfully

​
resultCode
string

The code which represents the result of the API call.

​
resultMessage
string

A short message which explains the result of the API call.

​
action
enum<string>

The next action that the implementation of the credential issuer metadata endpoint (/.well-known/openid-credential-issuer) should take after getting a response from Authlete's /vci/metadata API.

Available options:
OK,
NOT_FOUND,
INTERNAL_SERVER_ERROR
​
responseContent
string

Get the content that the implementation of the credential issuer metadata endpoint should use when it constructs a response.