Unlink a credential reference
/v1/users/credential-references/{credentialReferenceId}/unlinkUnlink 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. 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
Authorization
bearerAuth In: header
Path Parameters
The credential reference ID represents a link between a user and a credential profile, and is used to manage credentials for the user. Each credential reference ID is unique to a combination of user, credential type and, when the credential is issued against a claim set, claim set identifier. It stays the same across every device the credential is claimed on and every time the credential is updated, and is returned in the response when retrieving credential references.
uuidResponse Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/users/credential-references/a248d6c9-3f5e-4b2a-9c1e-2f3b4c5d6e7f/unlink"{ "credentialBundles": [ { "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?
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.
Configure an Authentication Provider POST
Configures an Authentication Provider on the tenant. An authentication or identity provider (IdP) is a platform that is typically used to store and manage user accounts on behalf of an organization or a service provider. MATTR VII uses the authentication provider to authenticate end users before issuing them credentials. <Callout> Only one authentication provider can be configured on a tenant. </Callout> The `/.well-known/openid-configuration` endpoint of the Authentication Provider must contain values for the `authorization_endpoint`, `token_endpoint` and `scopes_supported`.