Sign in

3335603aa636

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-31424367.3 KB
Credential API

Create a generic credential offer with the given content

Create a new credential offer, which can then be collected by the holder. The returned deep link has to be provided to the holder through another channel, for example as QR-Code. The credentialSubjectData can be a json object or a JWT, if the signer has been configured to perform data integrity checks. Returns both the ID used to interact with the offer and later issued VC, and the deep link to be provided to

post/management/api/credentials

Request body

metadata_credential_supported_idstring[] required

ID linking the offer to the issuer metadata.

{"stackTrail":"components:schemas:CreateCredentialOfferRequest:properties:credential_subject_data","oasType":"schema","type":"unknown","description":" The user data to be written in the verifiable credential. Can be a json object or a JWT.\n credentialSubjectData\": {\"lastName\": \"Example\",\"firstName\": \"Edward\"}\n When using data integrity JWT the value are as claims inside the JWT.\n \"credentialSubjectData\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsYXN0TmFtZSI6IkV4YW1wbGUiLCJmaXJzdE5hbWUiOiJFZHdhcmQiLCJkYXRlT2ZCaXJ0aCI6IjEuMS4xOTcwIn0.2VMjj1RpJ7jUjn1SJHDwwzqx3kygn88UxSsG5j1uXG8\"\n","example":{"lastName":"Example","firstName":"Edward"}}
offer_validity_secondsinteger

how long the offer should be usable in seconds. Example is 1 Day.

deferred_offer_validity_secondsinteger

how long the offer should be valid after it reached the deferred state in seconds. Example is 7 Days.

credential_valid_untilstring date-time

Setting for until when the VC shall be valid. XMLSchema dateTimeStamp https://www.w3.org/TR/xmlschema11-2/#dateTimeStamp

credential_valid_fromstring date-time

Setting for from when the VC shall be valid. XMLSchema dateTimeStamp https://www.w3.org/TR/xmlschema11-2/#dateTimeStamp

status_listsstring[]

List of URIs of the status lists to be used with the credential. Status Lists must be initialized. Can provide multiple status lists to have multiple status sources.

Example request

{
  "credential_subject_data": {
    "lastName": "Example",
    "firstName": "Edward"
  },
  "offer_validity_seconds": 86400,
  "deferred_offer_validity_seconds": 604800,
  "credential_valid_until": "2010-01-01T19:23:24Z",
  "credential_valid_from": "2010-01-01T18:23:24Z"
}

Response

Credential offer created