Send verification request

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

Sends an OpenID4VP Authorization Request (V3) with enhanced features including transaction data, data agreements, and PDF signing support.

Request

application/json

Body

requestByReference booleanrequired

When true, the OpenID for Verifiable Presentation (OpenID4VP) Authorization Request is passed by reference using the request_uri parameter. The wallet fetches the full request from the specified URI. Recommended for large Authorization Requests.

presentationDefinitionId stringrequired

Identifier of the presentation definition to use for this verification request.

transactionData object

Transaction data to include in the OpenID4VP Authorization Request. The holder must confirm the transaction data before submitting the presentation.

property name* any

Transaction data to include in the OpenID4VP Authorization Request. The holder must confirm the transaction data before submitting the presentation.

urlPrefix string

URL scheme prefix for the Authorization Request deep link. Default is openid4vp://?. Custom schemes can be used for specific wallet implementations.

individualId string

Identifier of a specific individual to receive the verification request. When provided, the request is sent directly to the individual's device.

mapperId string

Mapper identifier linking the verification request to an external individual record.

dataAgreement object

Data agreement object referencing the terms governing this verification exchange.

signatureStamp boolean

When false, hides the signature stamp in signed PDFs generated from the presentation.

signatureCoordinate number[]

Possible values: >= 4, <= 4

Page coordinates for placing the signature in a signed PDF, specified as [x1, y1, x2, y2] in points.

Responses

200

Verification request created successfully

Response Headers

application/json

Schema

Schema

verificationHistory object
presentationExchangeId stringrequired
Unique identifier for the verification exchange record, tracking the full lifecycle of a single OpenID for Verifiable Presentation (OpenID4VP) verification request.
vpTokenQrCode stringrequired
OpenID4VP Authorization Request URI encoded for QR code display or deep link. The holder's wallet scans or clicks this to initiate the presentation flow.
presentationSubmission objectrequired
Wrapper containing the Presentation Submission object received from the holder's wallet.
presentation_submission objectrequired
DIF Presentation Exchange Submission object mapping the holder's credentials to the verifier's requirements.
definition_id stringrequired
Identifier of the Presentation Definition that this submission fulfills.
descriptor_map object[]required
Array of Descriptor Map entries mapping each requested credential to its location in the Verifiable Presentation.
Array [
format stringrequired
Credential format of the matched credential (e.g. jwt_vc_json, dc+sd-jwt, mso_mdoc).
id stringrequired
Identifier of the Input Descriptor from the Presentation Definition that this entry satisfies.
path stringrequired
JSONPath expression pointing to the Verifiable Credential within the Verifiable Presentation token.
path_nested objectrequired
Nested path descriptor for credentials wrapped in envelope formats (e.g. JWT inside a VP JWT).
format stringrequired
Credential format of the nested credential (e.g. jwt_vc_json, dc+sd-jwt, mso_mdoc).
id stringrequired
Identifier of the Input Descriptor from the Presentation Definition that this nested entry satisfies.
path stringrequired
JSONPath expression pointing to the credential within the nested envelope.
]
id stringrequired
Unique identifier for this Presentation Submission.
status stringrequired
Possible values: [request_sent, request_received, presentation_acked]
Lifecycle status of the verification exchange:
1. request_sent: The OpenID4VP Authorization Request has been created and is waiting for the holder.
2. request_received: The holder's wallet has received/scanned the Authorization Request.
3. presentation_acked: The holder has submitted the Verifiable Presentation and the verifier has processed it.
verified booleanrequired
Result of verifying the Verifiable Presentation: validates cryptographic signatures, credential status, and the Presentation Submission against the Presentation Definition.
createdAt numberrequired
Unix timestamp (in seconds) when this verification record was created.
updatedAt numberrequired
Unix timestamp (in seconds) when this verification record was last modified.
presentationDefinitionId stringrequired
Identifier of the presentation definition used for this verification request.
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
Wallet Unit Attestation credential presented by the holder during the verification flow.
walletUnitAttestationPoP string
Proof of Possession for the holder's Wallet Unit Attestation.
walletUnitAttestationVerified boolean
Indicates whether the holder's Wallet Unit Attestation was successfully verified.
presentation object[]
Array of decoded credential objects presented by the holder.
vpTokenResponse string[]required
Array of Verifiable Presentation JWTs received from the holder.
transactionData object
Transaction data confirmed by the holder during the presentation flow.
property name* any
Transaction data confirmed by the holder during the presentation flow.
transactionDataBase64 string
Base64-encoded transaction data included in the presentation.
presentationValidity object[]
Array of validation results for each credential in the presentation, including signature verification, expiry checks, and revocation status.
walletUnitValidity object[]
Array of validation results for the holder's Wallet Unit Attestation.
clientIdScheme string
Possible values: [redirect_uri, did, verifier_attestation, x509_san_dns]
Client ID scheme used by the verifier in the OpenID4VP Authorization Request.
directPostRedirectUri string
URI the wallet redirects to after posting the Authorization Response.
responseMode string
Possible values: [direct_post, direct_post.jwt]
OpenID4VP response mode used: direct_post or direct_post.jwt.
verifierAttestation string
Verifier Attestation JWT sent to the holder, proving the verifier's authorization.
individualId string
Identifier of the individual the verification request was sent to.
mapperId string
Mapper identifier linking the verification to an external individual record.
dataAgreement object
Data agreement referencing the terms governing this verification.
signatureStamp boolean
When false, the signature stamp is hidden in signed PDFs.
signatureCoordinate number[]
Possible values: >= 4, <= 4
Coordinates for signature placement in signed PDFs as [x1, y1, x2, y2].
files object[]
List of files generated during the verification, including signed and unsigned PDF documents.
Array [
credentialId string
Identifier of the credential associated with this file.
error stringnullable
Error code if signing failed, null otherwise.
errorDescription stringnullable
Detailed error message if signing failed, null otherwise.
signedFile uri
URL of the signed PDF file.
unsignedFile uri
URL of the unsigned PDF file.
]

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",
    "presentationValidity": [
      {}
    ],
    "walletUnitValidity": [
      {}
    ],
    "clientIdScheme": "redirect_uri",
    "directPostRedirectUri": "string",
    "responseMode": "direct_post",
    "verifierAttestation": "string",
    "individualId": "string",
    "mapperId": "string",
    "dataAgreement": {},
    "signatureStamp": true,
    "signatureCoordinate": [
      0
    ],
    "files": [
      {
        "credentialId": "string",
        "error": "string",
        "errorDescription": "string",
        "signedFile": "string",
        "unsignedFile": "string"
      }
    ]
  }
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...