Skip to main content
POST
/
api
/
{serviceId}
/
vci
/
offer
/
info
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.getOfferInfo({
    serviceId: "<id>",
    vciOfferInfoRequest: {},
  });

  console.log(result);
}

run();
{
  "resultCode": "<string>",
  "resultMessage": "<string>",
  "action": "OK",
  "info": {
    "identifier": "<string>",
    "credentialOffer": "<string>",
    "credentialIssuer": "<string>",
    "authorizationCodeGrantIncluded": true,
    "issuerStateIncluded": true,
    "issuerState": "<string>",
    "preAuthorizedCodeGrantIncluded": true,
    "preAuthorizedCode": "<string>",
    "subject": "<string>",
    "expiresAt": 123,
    "context": "<string>",
    "properties": [
      {
        "key": "<string>",
        "value": "<string>",
        "hidden": true
      }
    ],
    "jwtAtClaims": "<string>",
    "authTime": 123,
    "acr": "<string>",
    "credentialConfigurationIds": [
      "<string>"
    ],
    "txCode": "<string>",
    "txCodeInputMode": "<string>",
    "txCodeDescription": "<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

​
identifier
string

The identifier of the credential offer.

Response

Credential offer info 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 result of the /vci/offer/info API call.

Available options:
OK,
FORBIDDEN,
NOT_FOUND,
CALLER_ERROR,
AUTHLETE_ERROR
​
info
object