Retrieve a credential bundle
Retrieve the specified credential bundle for the specified user. A credential bundle is one credential, for one credential type and claim set, as it sits in one wallet instance. It can hold several instances of that credential, such as the new versions issued by each update.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>credentialBundleId*stringThe credential bundle ID represents a unique identifier for a credential bundle. The credential bundle ID is generated by the system when a credential bundle is created, and is returned in the response when retrieving credential bundles.
uuidinclude-inactive?booleanWhen set to true, credentials with a status of invalid are included in the response.
falseCredential bundle retrieved
application/json- response
userId*stringThe user ID that owns this credential bundle.
uuidid*stringThe credential bundle ID uniquely identifies one credential, for one credential type and claim set, as it sits in one wallet instance. The credential bundle ID is generated by the system when a credential bundle is created, and is returned in the response when retrieving credential bundles.
uuidissuanceProtocol*"openid4vci"The issuance protocol represents the protocol that was used to issue the credentials in this bundle.
"openid4vci"credentialReferenceId*stringThe credential reference ID of the credential bundle.
credentialConfigurationId*stringThe credential configuration ID represents the credential configuration that was used to issue the credentials in this bundle.
uuidcredentialProfile*stringThe credential profile represents the profile of the credentials in this bundle.
credentialType*stringThe credential type represents the type of the credentials in this bundle.
sessionId?stringThe session ID represents the issuance OpenID session during which the credentials in this bundle were issued.
walletId?stringThe wallet ID represents the OpenID Client of the wallet application to which the credentials in this bundle were issued.
walletInstanceId?stringThe wallet instance ID represents the specific instance of the wallet application to which the credentials in this bundle were issued.
offerId?stringThe offer ID represents the credential offer that was used to issue the credentials in this bundle.
uuidclaimSetId?stringThe claim set identifier the credential bundle was issued for.
state*stringThe state represents the current status of the credential bundle. This indicates whether the credentials in the bundle are active and can be used, or whether the bundle has been unlinked and its credentials can no longer be used.
"active""unlinked"credentials?array<>The list of credentials that are part of this credential bundle.
curl -X GET 'https://example.vii.au01.mattr.global/v1/users/credential-bundles/e123f4a5-6b7c-8901-2345-67890abcdef2'{ "id": "e123f4a5-6b7c-8901-2345-67890abcdef2", "userId": "41458e5a-9092-40b7-9a26-d4eb43c5792f", "issuanceProtocol": "openid4vci", "credentialReferenceId": "a248d6c9-3f5e-4b2a-9c1e-2f3b4c5d6e7f", "credentialConfigurationId": "b123c4d5-6e7f-8901-2345-67890abcdef1", "credentialProfile": "mobile", "credentialType": "org.iso.18013.5.1.mDL", "sessionId": "c987d6e5-4b3a-210f-9e8d-7c6b5a4f3e2d", "walletId": "com.example.wallet", "walletInstanceId": "d654c3b2-1a0f-9e8d-7c6b5a4f3e2d", "offerId": "f567e8d9-0a1b-2345-6789-0abcdef12345", "state": "active", "credentials": [ { "credentialId": "552b35fe-a3ed-4c33-8c3c-64810c712323", "devicePublicKey": { "kty": "EC", "crv": "P-256", "x": "11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo" }, "namespaces": { "org.iso.18013.5.1": { "given_name": { "digestID": 0, "digest": "8GWbUyIRA2xATs5ILEa0fVZF1QQt4JL5gG2aCtVsazU" }, "family_name": { "digestID": 1, "digest": "R4jk/m0wX9KhENp7DVPr9AM7Hz+CJoEJNKJRQo92FCI" } } }, "msoHash": "OsPO++ARsvvJYswmuzN8E3rxN+jAkbWbxhqVIOfM1Go", "issuedDate": "2025-06-28T12:34:56.000Z", "validFrom": "2025-06-30T12:00:00.000Z", "validUntil": "2025-07-30T12:00:00.000Z", "status": "valid" } ]}How would you rate this page?
Search credential bundles POST
Search across every credential bundle issued from your tenant, optionally filtered by claim set identifier and/or state. Unlike the other credential bundle endpoints, this search is not scoped to a single user or credential reference. When `state` is omitted, only `active` bundles are returned. Claim set identifiers are offered as an **open beta preview** feature and are not generally available yet. They are available on all tenants, and their behavior may change in a way that breaks existing integrations before they become generally available.
Unlink a credential bundle POST
Unlink the specified credential bundle. Unlinking sets the bundle's state to `unlinked`, revokes the credentials it holds, and invalidates the refresh token issued for the bundle's issuance session. Use this to withdraw the credentials issued to a specific device or wallet instance. An unlinked bundle cannot be targeted for a [credential update](/docs/issuance/update/overview). Unlinking is permanent and cannot be reversed. To put a credential back in the holder's wallet, issue a new one. Credential update is offered as an **open beta preview** feature and is not generally available yet. It is available on all tenants, and its behavior may change in a way that breaks existing integrations before it becomes generally available.