Retrieve a credential bundle
/v1/users/credential-bundles/{credentialBundleId}Retrieve the specified credential bundle for the specified user. A credential bundle represents a group of credentials that were issued together as part of the same issuance session.
Roles
Analytics Events
Authorization
bearerAuth In: header
Path Parameters
The 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.
uuidQuery Parameters
When set to true, credentials with a status of invalid are included in the response.
falseResponse Body
application/json
application/json
application/json
curl -X GET "https://example.com/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 a **closed beta preview** feature and are not generally available yet. They are enabled per tenant, and their behavior may change in a way that breaks existing integrations. If you are interested in trying this feature, please [contact us](mailto:dev-support@mattr.global).
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 a **closed beta preview** feature and is not generally available yet. It is enabled per tenant, and its behavior may change in a way that breaks existing integrations. If you are interested in trying this feature, please [contact us](mailto:dev-support@mattr.global).