Unlink a credential bundle
/v1/users/credential-bundles/{credentialBundleId}/unlinkUnlink 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. 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.
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.
uuidResponse Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/users/credential-bundles/e123f4a5-6b7c-8901-2345-67890abcdef2/unlink"{ "userId": "41458e5a-9092-40b7-9a26-d4eb43c5792f", "id": "e123f4a5-6b7c-8901-2345-67890abcdef2", "issuanceProtocol": "openid4vci", "credentialReferenceId": "a248d6c9-3f5e-4b2a-9c1e-2f3b4c5d6e7f", "credentialConfigurationId": "707e920a-f342-443b-ae24-6946b7b5033e", "credentialProfile": "mobile", "credentialType": "org.iso.18013.5.1.mDL", "state": "unlinked"}How would you rate this page?
Retrieve a credential bundle GET
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.
Unlink a credential reference POST
Unlink every credential bundle held against the specified credential reference. Each bundle has its state set to `unlinked`, the credentials it holds are revoked, and the refresh token issued for its session is invalidated. Use this to withdraw a credential from every device the user holds it on, rather than one device at a time. The response lists the bundles that were unlinked. Bundles that were already unlinked are left alone and are not returned, so a reference with nothing left to unlink returns an empty list. 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).