Sign in
Verifiable Credential Issuer

Create Credential Offer

Create a verifiable credential offer

post/api/{serviceId}/vci/offer/create

Path parameters

serviceIdstring required

A service ID.

Request body

authorizationCodeGrantIncludedboolean

The flag indicating whether the authorization_code object is included in the grants object.

issuerStateIncludedboolean

The flag indicating whether the issuer_state property is included in the authorization_code object in the grants object.

preAuthorizedCodeGrantIncludedboolean

The flag to include the urn:ietf:params:oauth:grant-type:pre-authorized_code object in the grants object.

subjectstring

The subject associated with the credential offer.

durationinteger

The duration of the credential offer.

contextstring

The general-purpose arbitrary string.

jwtAtClaimsstring

Additional claims that are added to the payload part of the JWT access token.

authTimeinteger

The time at which the user authentication was performed during the course of issuing the credential offer.

acrstring

The Authentication Context Class Reference of the user authentication performed during the course of issuing the credential offer.

credentialConfigurationIdsstring[]

The value of the credential_configuration_ids array.

{
  "credential_issuer": "...",
  "credential_configuration_ids": [ ... ],
  "grants": { ... }
}

This property is mandatory.

txCodestring

The transaction code that should be associated with the credential offer.

If this parameter is not empty and the preAuthorizedCodeGrantIncluded parameter is true, the urn:ietf:params:oauth:grant-type:pre-authorized_code object will include the tx_code object.

The length of the value of this parameter will be used as the value of the length property in the tx_code object.

{
  "credential_issuer": "...",
  "credential_configuration_ids": [ ... ],
  "grants": {
    "urn:ietf:params:oauth:grant-type:pre-authorized_code": {
      "pre-authorized_code": "...",
      "tx_code": {
        "length": length
      }
    }
  }
}
txCodeInputModestring

The input mode of the transaction code.

The value of this property will be used as the value of the input_mode property in the tx_code object.

{
  "credential_issuer": "...",
  "credential_configuration_ids": [ ... ],
  "grants": {
    "urn:ietf:params:oauth:grant-type:pre-authorized_code": {
      "pre-authorized_code": "...",
      "tx_code": {
        "length": length,
        "input_mode": "..."
      }
    }
  }
}
txCodeDescriptionstring

The description of the transaction code.

The value of this property will be used as the value of the description property in the tx_code object.

{
  "credential_issuer": "...",
  "credential_configuration_ids": [ ... ],
  "grants": {
    "urn:ietf:params:oauth:grant-type:pre-authorized_code": {
      "pre-authorized_code": "...",
      "tx_code": {
        "length": length,
        "description": "..."
      }
    }
  }
}

Response

resultCodestring

The code which represents the result of the API call.

resultMessagestring

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

action'CREATED' | 'FORBIDDEN' | 'CALLER_ERROR' | 'AUTHLETE_ERROR'

The result of the /vci/offer/create API call.

Changes