📄️ Receive credential
Processes an OID4VCI Credential Offer and initiates the credential issuance flow. The wallet resolves the issuer's metadata, performs token exchange, and receives the credential.
📄️ Receive deferred credential
Polls the OID4VCI Deferred Credential Endpoint to retrieve a credential that was not immediately available during issuance. The wallet uses the acceptance token of the credential record to make the request. If the issuer is not ready, the wallet returns the credential record with the status `credential_pending`. This operation has no request body.
📄️ Receive credential with user PIN
Submits the transaction code (tx_code) required for the OID4VCI Pre-Authorized Code Flow. The wallet sends the transaction code with the pre-authorized code to the Token Endpoint of the issuer, and then requests the credential.
📄️ Configure auto presentation for the credential
Configures whether a credential should be automatically presented when a matching OpenID4VP Authorization Request is received. The wallet applies the same setting to the related credentials that the same issuance created, but returns only the credential that you gave in the path.
📄️ Read credential revocation status
Checks the current revocation status of a credential by querying the IETF Token Status List. The wallet reads the status list token of the issuer, updates the stored credential record, and returns the record.
📄️ Read credential
Retrieves a credential stored in the holder's wallet by its ID.
📄️ Delete credential
Deletes a credential from the holder's wallet. The wallet marks the credential record as deleted, no longer returns it in the credential list, and no longer uses it for presentations. The wallet tells the issuance backend in the background, so the response does not show the result of that step.
📄️ Exchange code and receive credential
Exchanges an authorization code for an access token and receives the credential in the OID4VCI Authorization Code Flow. Call this endpoint after the authorization server redirects the holder back with a code.
📄️ List credential
Lists all credentials stored in the holder's wallet with pagination support. The wallet sorts the records by the last update time and leaves out the credentials that you deleted. Use the query parameters to filter the list by status, credential type, expiry, or a search term. The wallet replaces a value that it cannot read with the default value and does not refuse the request.
📄️ Receive verification
Processes an OpenID4VP Authorization Request (V3) received from a verifier. The wallet resolves the verifier's requirements and identifies matching credentials. The V3 record adds DCQL, transaction data, trust list and response encryption fields.
📄️ Filter verification
Filters the credentials in the wallet of the holder against the request of the verifier and returns the matches. Call this operation after the receive operation, and use the result to build the request body of the send operation.
📄️ Send verification
Builds the Verifiable Presentation from the credentials that the holder selected and sends it to the verifier.
📄️ Read verification
Retrieves a presentation record (V3) from the wallet of the holder. The V3 record adds DCQL, transaction data, trust list and response encryption fields.
📄️ Delete verification
Deletes a presentation record from the wallet of the holder. The response has no body.
📄️ List verification
Lists the presentation records (V3) in the wallet of the holder. You can filter the records by status and by a search term, and set the sort order. The wallet sorts the records by `updatedAt`.
📄️ Read wallet unit status
Reads the wallet unit status from the holder's point of view. The status follows the Wallet Unit Attestation (WUA) lifecycle and the presence of a Legal Person Identification Data (LPID) credential in the wallet.
📄️ Create credential offer
Creates an OID4VCI Credential Offer that can be presented to a holder via QR code or deep link. OpenID4VCI 1.0 offers are not yet supported on this operation - the service refuses `version_01` with a 400 - so use `draft_13` until the backend adds 1.0 support. The wallet builds a Credential Offer by value with the Authorization Code Flow. The mandatory fields depend on the version of the OID4VCI specification. Version `draft_13` needs `credentialConfigurationIds`. Version `draft_17` needs `scope`, and does not accept `credentialConfigurationIds`. The offer always uses the Authorization Code Flow with an empty `issuer_state`. This operation does not create a Pre-Authorized Code Flow offer and does not add a `tx_code`.
📄️ Read credential issuer metadata
Retrieves the OID4VCI Credential Issuer Metadata for a credential issuer. The wallet reads the `.well-known/openid-credential-issuer` document of the given credential issuer, checks it against the metadata model of the selected version, and returns the checked result. The wallet removes the keys that the model does not define, including `signed_metadata`, and returns the optional keys that the issuer left out with the value `null`. Each entry of `display` gets the default values `Not Discoverable` for `name` and `description` when the issuer gives no value. The wallet does not change the contents of `credential_configurations_supported`.
📄️ Request credential re-issuance
Requests reissuance of an expired or near-expiry credential via the OID4VCI protocol. The wallet uses the stored refresh token of the credential to get a new access token, and then asks the issuer for a new credential. Reissuance is not applicable to a Wallet Unit Attestation. This operation has no request body.
📄️ Accept credential
Accepts a received credential in the holder's wallet. The wallet changes the credential status to `credential_accepted` and sends an OID4VCI notification to the issuer. This operation has no request body.
📄️ Create holder global configuration
Creates a global configuration for the holder wallet. The configuration sets credential encryption support, the credential status refresh interval, and the redirect URL for OID4VCI and OpenID4VP flows.
📄️ Read holder global configuration
Retrieves a holder global configuration by its ID for OID4VCI and OpenID4VP flows.
📄️ Update holder global configuration
Updates a holder global configuration for OID4VCI and OpenID4VP flows. The wallet replaces all settings with the values in the request body, so send every field that you want to keep.
📄️ Delete holder global configuration
Deletes a holder global configuration for OID4VCI and OpenID4VP flows. The wallet keeps no response body.
📄️ List holder global configuration
Lists the holder global configurations for OID4VCI and OpenID4VP flows. The wallet sorts the configurations by last update time, newest first.
📄️ Read notification
Retrieves a wallet notification by its ID. The wallet creates a notification for each OID4VCI credential lifecycle event.
📄️ Update notification
Marks a wallet notification as read. The wallet accepts only the value `read`, because a notification cannot go back to the `unread` state.
📄️ Delete notification
Deletes a wallet notification. When the notification has the type `credential_acked` and the related credential is still in the state `credential_acked`, the wallet also deletes that credential. The wallet keeps no response body.
📄️ List notification
Lists the wallet notifications for OID4VCI credential lifecycle events. You can filter the notifications by read status, by notification type and by a search term.
📄️ Delete all notifications
Deletes all wallet notifications for the organisation. There is no filter and no confirmation parameter. Unlike the delete operation for one notification, this operation keeps the credentials that the notifications refer to. The wallet keeps no response body.
📄️ Stream notifications (SSE)
Streams wallet notifications for OID4VCI credential lifecycle events over Server-Sent Events. The server keeps the connection open and writes one frame for each new notification.