Unlink a credential bundle
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. 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.
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.
uuidCredential bundle unlinked
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"curl -X POST 'https://example.vii.au01.mattr.global/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 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.
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 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.