Send verification request (v3)

POST 
/v3/config/digital-wallet/openid/sdjwt/verification/send

This endpoint is used to send verification request based on OID4VP specification.

Request

application/json

Body

requestByReference booleanrequired

If true, then the authorization request must be resolved by a URI and the URI is specified in request_uri query parameter in openid4vp:// wallet invocation link.

presentationDefinitionId stringrequired

Identifier for the presentation definition ID

transactionData object
property name* any

Responses

200

Response Headers

application/json

Schema

Schema

verificationHistory object

presentationExchangeId stringrequired

Identifier for the presentation definition

vpTokenQrCode stringrequired

Authorisation request defined as per OID4VP draft 20 specification.

presentationSubmission objectrequired

For further reference, please visit: https://identity.foundation/presentation-exchange/#presentation-submission

presentation_submission objectrequired

For further reference, please visit: https://identity.foundation/presentation-exchange/#presentation-submission

definition_id stringrequired

For further reference, please visit: https://identity.foundation/presentation-exchange/#presentation-submission

descriptor_map object[]required

For further reference, please visit: https://identity.foundation/presentation-exchange/#presentation-submission

Array [

format stringrequired

For further reference, please visit: https://identity.foundation/presentation-exchange/#presentation-submission

id stringrequired

For further reference, please visit: https://identity.foundation/presentation-exchange/#presentation-submission

path stringrequired

For further reference, please visit: https://identity.foundation/presentation-exchange/#presentation-submission

path_nested objectrequired

For further reference, please visit: https://identity.foundation/presentation-exchange/#presentation-submission

format stringrequired

For further reference, please visit: https://identity.foundation/presentation-exchange/#presentation-submission

id stringrequired

For further reference, please visit: https://identity.foundation/presentation-exchange/#presentation-submission

path stringrequired

For further reference, please visit: https://identity.foundation/presentation-exchange/#presentation-submission

]

id stringrequired

status stringrequired

Possible values: [request_sent, request_received, presentation_acked]

It support 3 presentation request statuses: 1. request_sent: Indicates the presentation request has been sent to the holder. 2. request_received: Indicates the presentation request has been received/scanned by the holder. 3. presentation_acked: Indicates the presentation submission from holder is received by the verifier.

verified booleanrequired

Validate signatures as well as the presentation submission against the presentation definition.

createdAt numberrequired

Timestamp when the record was created.

updatedAt numberrequired

Timestamp when the record was updated.

presentationDefinitionId stringrequired

Identifier for the presentation definition

holder objectrequired

Contains the metadata describing a holder. For e.g. Name, location, logo e.t.c

name stringrequired

Identifier of the holder. For .e.g. DID or Name obtained from client metadata if available.

walletUnitAttestation string

Specifies the wallet unit attestation credential.

walletUnitAttestationPoP string

Specifies the wallet unit attestation pop credential.

walletUnitAttestationVerified boolean

Specifies the wallet unit attestation credential is verified.

presentation object[]

The credential being presented to the verifier

vpTokenResponse string[]required

The verifiable credential jwt being presented to the verifier

transactionData object

property name* any

transactionDataBase64 string

The base 64 encoded value of the transaction data.

Example (from schema)

{
  "verificationHistory": {
    "presentationExchangeId": "string",
    "vpTokenQrCode": "string",
    "presentationSubmission": {
      "presentation_submission": {
        "definition_id": "string",
        "descriptor_map": [
          {
            "format": "string",
            "id": "string",
            "path": "string",
            "path_nested": {
              "format": "string",
              "id": "string",
              "path": "string"
            }
          }
        ],
        "id": "string"
      }
    },
    "status": "request_sent",
    "verified": true,
    "createdAt": 0,
    "updatedAt": 0,
    "presentationDefinitionId": "string",
    "holder": {
      "name": "string"
    },
    "walletUnitAttestation": "string",
    "walletUnitAttestationPoP": "string",
    "walletUnitAttestationVerified": true,
    "presentation": [
      {}
    ],
    "vpTokenResponse": [
      "string"
    ],
    "transactionData": {},
    "transactionDataBase64": "string"
  }
}

Loading...