📄️ Issue credential
Issues a Verifiable Credential to a holder using the OpenID for Verifiable Credentials Issuance (OID4VCI) protocol. Supports two issuance modes: **InTime** (credential issued immediately via the Credential Endpoint) and **Deferred** (credential issued later via the Deferred Credential Endpoint by calling the [Issue deferred credential](/docs/openid4vc-api/config-update-digital-wallet-open-id-credential-history) API). Supports W3C VC (JWT), IETF SD-JWT VC, and ISO 18013-5 mDoc/mDL credential formats.
📄️ Issue deferred credential
Updates a credential exchange record. Used to issue a credential via the OID4VCI Deferred Credential Endpoint by providing the credential claims for a pending issuance.
📄️ Read issuance history
Retrieves a credential exchange record by ID, including the issuance status, credential offer details, and holder information. The issuer reads the stored record and does not contact the issuance backend. A record that you deleted from the issuance history is still available through this operation.
📄️ Delete issuance history
Deletes a credential exchange record from the issuance history. The issuer marks the record as deleted and no longer returns it in the issuance history list. The issuer tells the issuance backend in the background, so the response does not show the result of that step.
📄️ Update credential revocation status
Updates the revocation status of an issued credential using the IETF Token Status List.
📄️ List issuance history
Lists credential exchange records with pagination and optional status filtering. Each record represents a single OID4VCI credential issuance lifecycle. The issuer sorts the records by `updatedAt` and leaves out the records that you deleted. The response also holds aggregate issuance counts for the whole organisation. The parameters `status`, `accepted`, `inProgress` and `denied` all filter on the same status field. Use only one of them in a request: if you send more than one, the issuer keeps only the last one in the order `status`, `accepted`, `inProgress`, `denied`.
📄️ Create credential definition
Creates a new credential definition for OpenID for Verifiable Credential Issuance (OID4VCI) 1.0. Each entry of the `credentialDefinitions` array holds one credential configuration, with its credential format, claims and issuance settings. The issuer publishes every entry in the OID4VCI Credential Issuer Metadata and uses it as the template for the credentials it issues. Upload the card artwork with the update logo image and update cover image operations after this operation returns.
📄️ Read credential definition
Retrieves a credential definition by its ID, with the credential configurations that it holds in `credentialDefinitions`. Each configuration holds the credential format, the claims and the issuance settings.
📄️ Update credential definition
Updates an existing credential definition. The changes apply to future credential issuances that use this definition. This operation replaces the whole `credentialDefinitions` array, so always send every credential configuration that the issuer must keep. Set `credentialDefinitions[].id` to the identifier of an existing configuration to change it, and omit the field to add a new one. The issuer always discards `display.logo.uri` and `display.backgroundImage.uri` from the request body and keeps the stored images; use the update logo image and update cover image operations to change the artwork. `version`, `trustAnchor`, `kid`, `supportRevocation` and `revocationMethod` are immutable after creation, and this operation does not accept them.
📄️ Delete credential definition
Deletes a credential definition and removes its credential configurations from the OID4VCI Credential Issuer Metadata. The issuer also deletes every credential issuance history record of this credential definition. Credentials that the issuer already gave to a holder stay valid; revoke them first if you must withdraw them.
📄️ List credential definition
Lists all credential definitions configured for OID4VCI credential issuance, with the newest change first. Each entry also holds the issuance counts of the credential definition, and the response holds the aggregate issuance counts of the organisation. `search` matches the label and the credential definition ID. `sortOrder` sorts on the last modification time. `vct`, `doctype` and `type` match the value at the top level of a record and in its credential configurations.
📄️ Preview credential definition from URI
Fetches a credential schema document from a URI so that you can inspect it before you create a credential definition from it. The service downloads the document at `credentialDefinitionUri` and returns it unchanged in `credentialDefinition`. For OpenID4VCI 1.0, the document is a claim path pointer document: its `claims` array holds one entry per claim, each with a `path` array. Send one request per URI.
📄️ Read credential definition cover image
Retrieves the cover image of an OID4VCI credential definition. This operation needs no authentication, because wallets read the image from the URL that the issuer publishes in the OID4VCI Credential Issuer Metadata. Anybody who knows the credential definition ID can read the image.
📄️ Update credential definition cover image
Uploads or updates the cover image of an OID4VCI credential definition. This operation is the only way to upload your own cover image, because the create and update credential definition operations ignore `display.backgroundImage.uri`. The server stores the image, then sets `display.backgroundImage.uri` of the credential definition and of every credential configuration that it holds to the URL of the new image. Use this operation after you create the credential definition.
📄️ Read credential definition logo image
Retrieves the logo image of an OID4VCI credential definition. This operation needs no authentication, because wallets read the image from the URL that the issuer publishes in the OID4VCI Credential Issuer Metadata. Anybody who knows the credential definition ID can read the image.
📄️ Update credential definition logo image
Uploads or updates the logo image of an OID4VCI credential definition. This operation is the only way to upload your own logo, because the create and update credential definition operations ignore `display.logo.uri`. The server stores the image, then sets `display.logo.uri` of the credential definition and of every credential configuration that it holds to the URL of the new image. Use this operation after you create the credential definition.
📄️ Create global configuration
Creates the global configuration of the OID4VCI issuer. The configuration gives the default branding, the default validity, and the Credential Issuer Metadata settings that all credential definitions of the organisation use.
📄️ Read global configuration
Reads the global configuration of the OID4VCI issuer. Give the value of `globalConfigurationId` in the path. The organisation must have a deployed digital wallet.
📄️ Update global configuration
Updates the global configuration of the OID4VCI issuer.
📄️ Delete global configuration
Deletes a global configuration for the OID4VCI issuer.
📄️ List global configuration
Lists the global configurations of the OID4VCI issuer. The service sorts them by `updatedAt`, newest first. An organisation holds one issuer global configuration, so the array holds zero or one record.
📄️ Validate transaction data
Validates the transaction data that a holder approved during an OID4VCI credential issuance.
📄️ Read transaction data
Reads one transaction data record by its `transactionDataId`.
📄️ List transaction data
Lists the transaction data records of the organisation. The server sorts them by the last modification time, and puts the newest record first.
📄️ List credential definition templates
Lists the pre-defined credential schema templates that you can use to create a credential definition. The platform returns only the latest version of each schema. A claim path pointer schema has one entry for each credential format, so the same `name` and `version` can appear more than once. When the platform cannot read the schema repository, it returns an empty `templates` array and no `pagination` object.
📄️ List scope
Lists the OAuth 2.0 scopes available for OID4VCI credential issuance, as published in the Credential Issuer Metadata. Use a value from this list in `credentialDefinitions[].scope` of a create or update credential definition request, when `authorizationRequestType` is `scope_based`.