Issue credential

POST 
/digital-wallet/credential/issue

This endpoint is used send holder a credential offer, independent of any proposal

Request

application/json

Body

autoIssue boolean

Whether to respond automatically to credential requests, creating and issuing requested credentials

autoRemove boolean

Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)

comment string

Human-readable comment

connectionId uuid

Connection identifier

credDefId string

Credential definition identifier

credentialPreview object
Credential preview
@type stringrequired
Message type identifier
attributes object[]required
Array [
mimeType string
MIME type
name stringrequired
Attribute name
value stringrequired
Attribute value
]
dataAgreementId string

Data agreement identifier

trace boolean

Whether to trace event (default false)

Responses

200

Response Headers

application/json

Schema

Schema

credentialHistory object

id string

unique identifier

autoIssue boolean

Issuer choice to issue to request in this credential exchange

autoOffer boolean

Holder choice to accept offer in this credential exchange

autoRemove boolean

Issuer choice to remove this credential exchange record when complete

connectionId string

Connection identifier

createdAt string

Time of record creation

credential object

Credential as stored

schemaId string

Schema identifier

credDefId string

Credential definition identifier

revRegId stringnullable

Revocation registry identifier

values object

Attribute values

raw string

encoded string

signature object

pCredential object

m2 string

a string

e string

v string

rCredential objectnullable

signatureCorrectnessProof object

se string

c string

revReg objectnullable

Revocation registry

witness objectnullable

Witness

credentialDefinitionId string

Credential definition identifier

credentialExchangeId string

Credential exchange identifier

credentialId string

Credential identifier

credentialOffer object

Indy credential offer

schemaId string

Schema identifier

credDefId string

Credential definition identifier

keyCorrectnessProof object

c string

xzCap string

xrCap string

nonce string

Nonce

credentialOfferDict object

Serialized credential offer message

@type string

Type of the credential offer

@id string

Identifier for the credential offer

~thread object

Thread information

property name* any

Thread information

~dataAgreementContext object

messageType string

Type of the data agreement context message

message object

@type string

Type of the message

@id string

Identifier for the message

from string

Sender of the message

to string

Receiver of the message

createdTime string

Time when the message was created

body object

Body of the message

context string[]

Context information

templateId string

Identifier for the data agreement template

templateVersion integer

Version of the data agreement template

dataControllerName string

Name of the data controller

dataControllerUrl string

URL of the data controller

purpose string

Purpose of data processing

purposeDescription string

Description of the purpose

lawfulBasis string

Legal basis for data processing

methodOfUse string

Method of data use

dataPolicy object

Data policy information

dataRetentionPeriod integer

Data retention period in days

policyUrl string

URL to the data policy

jurisdiction string

Jurisdiction information

industrySector string

Industry sector information

geographicRestriction string

Geographic restriction details

storageLocation string

Storage location details

thirdPartyDataSharing boolean

Indicates whether third-party data sharing is allowed

personalData object[]

List of personal data items

Array [

AttributeId stringrequired

Identifier for the attribute

AttributeName stringrequired

Name of the attribute

AttributeDescription stringrequired

Description of the attribute

AttributeCategory stringrequired

Category of the attribute

AttributeSensitive booleanrequired

Indicates whether the attribute is sensitive

]

dpia object

Data Protection Impact Assessment (DPIA) information

DpiaDate stringrequired

Date of the DPIA (Data Protection Impact Assessment)

DpiaSummaryUrl stringrequired

URL to the summary of the DPIA

event object

Data agreement event information

Did stringrequired

Decentralized Identifier (DID)

Id stringrequired

Identifier for the event

State stringrequired

State of the event

TimeStamp stringrequired

Timestamp of the event

proofChain object[]

List of proof chain items

Array [

Id stringrequired

Identifier for the proof

Type stringrequired

Type of the proof

Created stringrequired

Timestamp indicating when the proof was created

VerificationMethod stringrequired

Verification method used for the proof

ProofPurpose stringrequired

Purpose of the proof

ProofValue stringrequired

Value of the proof

]

dataSubjectDid string

DID (Decentralized Identifier) of the data subject

offersAttach object[]

List of offers attached

Array [

@id string

Identifier for the attachment

mimeType string

MIME type of the attachment

data object

base64 string

Base64-encoded data

]

credentialPreview object

Credential preview information

@type string

Type of the credential preview

attributes object[]

List of attributes in the credential preview

Array [

name string

value string

]

comment string

Comment associated with the credential offer

credentialProposalDict object

Serialized credential proposal message

@type string

Type of the credential proposal response

@id string

Identifier for the credential proposal response

credentialProposal object

Credential proposal information

type string

Type of the credential proposal

attributes object[]

List of attributes in the credential proposal

Array [

name string

Name of the attribute

value string

Value of the attribute

]

comment string

Comment associated with the credential proposal response

credDefId string

Credential definition identifier

credentialRequest object

Indy credential request

proverDid string

Prover's DID

credDefId string

Credential definition identifier

blindedMs object

Blinded master secret information

u string

Blinded master secret U

ur object

Ur

hiddenAttributes string[]

List of hidden attributes

committedAttributes object

Committed attributes

blindedMsCorrectnessProof object

Correctness proof for blinded master secret

c string

Correctness proof C

vDashCap string

VDashCap

mCaps object

Map of MCaps

property name* string

rCaps object

RCaps

nonce string

Nonce

credentialRequestMetadata object

Indy credential request metadata

dataAgreement object

Data agreement associated with the credential exchange

context string[]

Context information

templateId string

Identifier for the data agreement template

templateVersion integer

Version of the data agreement template

dataControllerName string

Name of the data controller

dataControllerUrl string

URL of the data controller

purpose string

Purpose of data processing

purposeDescription string

Description of the purpose

lawfulBasis string

Legal basis for data processing

methodOfUse string

Method of data use

dataPolicy object

Data policy information

dataRetentionPeriod integer

Data retention period in days

policyUrl string

URL to the data policy

jurisdiction string

Jurisdiction information

industrySector string

Industry sector information

geographicRestriction string

Geographic restriction details

storageLocation string

Storage location details

thirdPartyDataSharing boolean

Indicates whether third-party data sharing is allowed

personalData object[]

List of personal data items

Array [

AttributeId stringrequired

Identifier for the attribute

AttributeName stringrequired

Name of the attribute

AttributeDescription stringrequired

Description of the attribute

AttributeCategory stringrequired

Category of the attribute

AttributeSensitive booleanrequired

Indicates whether the attribute is sensitive

]

dpia object

Data Protection Impact Assessment (DPIA) information

DpiaDate stringrequired

Date of the DPIA (Data Protection Impact Assessment)

DpiaSummaryUrl stringrequired

URL to the summary of the DPIA

event object

Data agreement event information

Did stringrequired

Decentralized Identifier (DID)

Id stringrequired

Identifier for the event

State stringrequired

State of the event

TimeStamp stringrequired

Timestamp of the event

proofChain object[]

List of proof chain items

Array [

Id stringrequired

Identifier for the proof

Type stringrequired

Type of the proof

Created stringrequired

Timestamp indicating when the proof was created

VerificationMethod stringrequired

Verification method used for the proof

ProofPurpose stringrequired

Purpose of the proof

ProofValue stringrequired

Value of the proof

]

dataSubjectDid string

DID (Decentralized Identifier) of the data subject

dataAgreementId string

Data agreement identifier

dataAgreementProblemReport object

Data agreement problem report

dataAgreementStatus string

Data agreement status

dataAgreementTemplateId string

Data agreement template identifier

errorMsg string

Error message

initiator string

Possible values: [self, external]

Issue-credential exchange initiator: self or external

parentThreadId string

Parent thread identifier

rawCredential object

Raw credential

revocRegId string

Revocation registry identifier

revocationId string

Credential identifier within revocation registry

role string

Possible values: [holder, issuer]

Issue-credential exchange role: holder or issuer

schemaId string

Schema identifier

state string

Issue-credential exchange state

threadId string

Thread identifier

trace boolean

Record trace information, based on agent configuration

updatedAt string

Time of last record update

Example (from schema)

{
  "credentialHistory": {
    "id": "string",
    "autoIssue": false,
    "autoOffer": false,
    "autoRemove": false,
    "connectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdAt": "2024-02-28 07:03:35Z",
    "credential": {
      "schemaId": "string",
      "credDefId": "string",
      "revRegId": "string",
      "values": {
        "raw": "string",
        "encoded": "string"
      },
      "signature": {
        "pCredential": {
          "m2": "string",
          "a": "string",
          "e": "string",
          "v": "string"
        },
        "rCredential": {}
      },
      "signatureCorrectnessProof": {
        "se": "string",
        "c": "string"
      },
      "revReg": {},
      "witness": {}
    },
    "credentialDefinitionId": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag",
    "credentialExchangeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "credentialId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "credentialOffer": {
      "schemaId": "string",
      "credDefId": "string",
      "keyCorrectnessProof": {
        "c": "string",
        "xzCap": "string",
        "xrCap": "string"
      },
      "nonce": "string"
    },
    "credentialOfferDict": {
      "@type": "string",
      "@id": "string",
      "~thread": {},
      "~dataAgreementContext": {
        "messageType": "string",
        "message": {
          "@type": "string",
          "@id": "string",
          "from": "string",
          "to": "string",
          "createdTime": "string",
          "body": {
            "context": [
              "string"
            ],
            "templateId": "string",
            "templateVersion": 0,
            "dataControllerName": "string",
            "dataControllerUrl": "string",
            "purpose": "string",
            "purposeDescription": "string",
            "lawfulBasis": "string",
            "methodOfUse": "string",
            "dataPolicy": {
              "dataRetentionPeriod": 0,
              "policyUrl": "string",
              "jurisdiction": "string",
              "industrySector": "string",
              "geographicRestriction": "string",
              "storageLocation": "string",
              "thirdPartyDataSharing": true
            },
            "personalData": [
              {
                "AttributeId": "string",
                "AttributeName": "string",
                "AttributeDescription": "string",
                "AttributeCategory": "string",
                "AttributeSensitive": true
              }
            ],
            "dpia": {
              "DpiaDate": "string",
              "DpiaSummaryUrl": "string"
            },
            "event": {
              "Did": "string",
              "Id": "string",
              "State": "string",
              "TimeStamp": "string"
            },
            "proofChain": [
              {
                "Id": "string",
                "Type": "string",
                "Created": "string",
                "VerificationMethod": "string",
                "ProofPurpose": "string",
                "ProofValue": "string"
              }
            ],
            "dataSubjectDid": "string"
          }
        }
      },
      "offersAttach": [
        {
          "@id": "string",
          "mimeType": "string",
          "data": {
            "base64": "string"
          }
        }
      ],
      "credentialPreview": {
        "@type": "string",
        "attributes": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      },
      "comment": "string"
    },
    "credentialProposalDict": {
      "@type": "string",
      "@id": "string",
      "credentialProposal": {
        "type": "string",
        "attributes": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      },
      "comment": "string",
      "credDefId": "string"
    },
    "credentialRequest": {
      "proverDid": "string",
      "credDefId": "string",
      "blindedMs": {
        "u": "string",
        "ur": {},
        "hiddenAttributes": [
          "string"
        ],
        "committedAttributes": {}
      },
      "blindedMsCorrectnessProof": {
        "c": "string",
        "vDashCap": "string",
        "mCaps": {},
        "rCaps": {}
      },
      "nonce": "string"
    },
    "credentialRequestMetadata": {},
    "dataAgreement": {
      "context": [
        "string"
      ],
      "templateId": "string",
      "templateVersion": 0,
      "dataControllerName": "string",
      "dataControllerUrl": "string",
      "purpose": "string",
      "purposeDescription": "string",
      "lawfulBasis": "string",
      "methodOfUse": "string",
      "dataPolicy": {
        "dataRetentionPeriod": 0,
        "policyUrl": "string",
        "jurisdiction": "string",
        "industrySector": "string",
        "geographicRestriction": "string",
        "storageLocation": "string",
        "thirdPartyDataSharing": true
      },
      "personalData": [
        {
          "AttributeId": "string",
          "AttributeName": "string",
          "AttributeDescription": "string",
          "AttributeCategory": "string",
          "AttributeSensitive": true
        }
      ],
      "dpia": {
        "DpiaDate": "string",
        "DpiaSummaryUrl": "string"
      },
      "event": {
        "Did": "string",
        "Id": "string",
        "State": "string",
        "TimeStamp": "string"
      },
      "proofChain": [
        {
          "Id": "string",
          "Type": "string",
          "Created": "string",
          "VerificationMethod": "string",
          "ProofPurpose": "string",
          "ProofValue": "string"
        }
      ],
      "dataSubjectDid": "string"
    },
    "dataAgreementId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "dataAgreementProblemReport": {},
    "dataAgreementStatus": "offer",
    "dataAgreementTemplateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "errorMsg": "credential definition identifier is not set in proposal",
    "initiator": "self",
    "parentThreadId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "rawCredential": {},
    "revocRegId": "string",
    "revocationId": "string",
    "role": "issuer",
    "schemaId": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0",
    "state": "credential_acked",
    "threadId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trace": true,
    "updatedAt": "2024-02-28 07:03:35Z"
  }
}

Loading...