CreateCredentialOfferBodyDto

credentialDefinitionIdstringrequired

AnonCreds credential definition identifier

Example: did:webvh:QmaZYZF4aaHUTWzaKu23TowgvsX7JWfCRgQZX488EAssPQ:dm.chatbot.demos.dev.2060.io/resources/zQmevazUUyXBhGoXJwJNNEqXgvPPQ5WrwTE8G5MdhfWsmxM

claims object[]required

Name and value pairs that preview the attributes of the credential

Array [

namestringrequired

Name of the attribute

Example: phoneNumber

valuestringrequired

Value of the attribute

Example: +57128348520

mimeTypestring

MIME type of the value

Example: image/png

]

revocationRegistryDefinitionIdstring

Revocation registry that holds the status of this credential

Example: did:webvh:QmaZYZ:issuer.example.com/resources/zQmRDLcQ3jZvK4PfcDcf3sbvPzV4Ww5X7Sn2pzyHqUrZp2Z

revocationRegistryIndexnumber

Index of this credential in the revocation registry

Example: 1

connectionIdstring

An established connection to send the offer on. The agent creates an Out-of-Band invitation when the caller omits it.

Example: conn-1234-5678

autoAcceptboolean

Complete the issuer steps without a call: the agent issues the credential on request-received, with no acceptCredentialRequest call.

Default value: false

useLegacyDidboolean

Advertise the legacy did:web form when the DID of the agent is did:webvh. The agent ignores it when connectionId is present.

didcommVersionstring

DIDComm envelope version of the invitation. Defaults to 'v2' when omitted. The agent ignores it when connectionId is present.

Possible values: [v1, v2]

CreateCredentialOfferBodyDto

{
  "credentialDefinitionId": "did:webvh:QmaZYZF4aaHUTWzaKu23TowgvsX7JWfCRgQZX488EAssPQ:dm.chatbot.demos.dev.2060.io/resources/zQmevazUUyXBhGoXJwJNNEqXgvPPQ5WrwTE8G5MdhfWsmxM",
  "claims": [
    {
      "name": "phoneNumber",
      "value": "+57128348520",
      "mimeType": "image/png"
    }
  ],
  "revocationRegistryDefinitionId": "did:webvh:QmaZYZ:issuer.example.com/resources/zQmRDLcQ3jZvK4PfcDcf3sbvPzV4Ww5X7Sn2pzyHqUrZp2Z",
  "revocationRegistryIndex": 1,
  "connectionId": "conn-1234-5678",
  "autoAccept": false,
  "useLegacyDid": true,
  "didcommVersion": "v1"
}