Send verification request

POST 
/digital-wallet/verification/send

Send a presentation request in reference to a data agreement

Request

application/json

Body

connectionId stringrequired
dataAgreementId stringrequired

Responses

200

Response Headers

application/json

Schema

Schema

verificationHistory object

id string

Identifier for the presentation exchange response

autoPresent boolean

Indicates whether auto-presentation is enabled

connectionId string

Connection identifier

createdAt string

Timestamp indicating when the presentation exchange was created

errorMsg string

Error message associated with the presentation exchange

initiator string

Initiator of the presentation exchange

presentationExchangeId string

Identifier for the presentation exchange

presentationProposalDict object

Presentation proposal dictionary

presentationRequest object

Presentation request information

name string

Name of the presentation request

version string

Version of the presentation request

requestedAttributes object

Map of requested attributes

property name* object

name string

Name of the requested attribute

restrictions object[]

List of restrictions for the requested attribute

Array [

schemaId string

Schema identifier

credDefId string

Credential definition identifier

]

requestedPredicates object

Map of requested predicates

nonce string

Nonce

presentationRequestDict object

Presentation request dictionary

@type string

Type of the presentation request dictionary response

@id string

Identifier for the presentation request dictionary response

~dataAgreementContext object

Data agreement context information

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

requestPresentations~attach object[]

List of request presentations attachments

Array [

@id string

Identifier for the offer attachment response

mimeType string

MIME type of the attachment

data object

Data associated with the attachment

base64 stringrequired

Base64-encoded data

]

Comment string

Comment associated with the presentation request dictionary response

presentation object

Presentation information

requestedProof object

Requested proof information

predicates object

Map of predicates in the requested proof

selfAttestedAttrs object

Map of self-attested attributes in the requested proof

property name* string

unrevealedAttrs object

Map of unrevealed attributes in the requested proof

revealedAttrs object

Map of revealed attributes in the requested proof

identifiers undefined[]

List of identifiers

proof object

Proof information

proofs undefined[]

List of proofs

aggregatedProof object

Aggregated proof information

cList undefined[]

List of CList elements in the aggregated proof

cHash string

CHash in the aggregated proof

role string

Role in the presentation exchange

state string

State of the presentation exchange

threadId string

Thread identifier

trace boolean

Indicates whether tracing is enabled

updatedAt string

Timestamp indicating when the presentation exchange was last updated

verified boolean

Indicates whether the presentation is verified

dataAgreementId string

Data agreement identifier

dataAgreement object

Data agreement information

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

dataAgreementTemplateId string

Data agreement template identifier

dataAgreementStatus string

Status of the data agreement

dataAgreementProblemReport string

Problem report associated with the data agreement

Example (from schema)

{
  "verificationHistory": {
    "id": "string",
    "autoPresent": true,
    "connectionId": "string",
    "createdAt": "string",
    "errorMsg": "string",
    "initiator": "string",
    "presentationExchangeId": "string",
    "presentationProposalDict": {},
    "presentationRequest": {
      "name": "string",
      "version": "string",
      "requestedAttributes": {},
      "requestedPredicates": {},
      "nonce": "string"
    },
    "presentationRequestDict": {
      "@type": "string",
      "@id": "string",
      "~dataAgreementContext": {
        "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"
      },
      "requestPresentations~attach": [
        {
          "@id": "string",
          "mimeType": "string",
          "data": {
            "base64": "string"
          }
        }
      ],
      "Comment": "string"
    },
    "presentation": {
      "requestedProof": {
        "predicates": {},
        "selfAttestedAttrs": {},
        "unrevealedAttrs": {},
        "revealedAttrs": {}
      },
      "identifiers": [
        null
      ],
      "proof": {
        "proofs": [
          null
        ],
        "aggregatedProof": {
          "cList": [
            null
          ],
          "cHash": "string"
        }
      }
    },
    "role": "string",
    "state": "string",
    "threadId": "string",
    "trace": true,
    "updatedAt": "string",
    "verified": true,
    "dataAgreementId": "string",
    "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"
    },
    "dataAgreementTemplateId": "string",
    "dataAgreementStatus": "string",
    "dataAgreementProblemReport": "string"
  }
}

Loading...