Assign a claim set to a credential reference
Assign a claim set identifier to an existing credential reference that was issued without one. Use this to migrate credentials issued before you adopted claim sets, without issuing them again.
The claim set identifier is applied to the credential reference and every credential bundle held against it. The credentialReferenceId and every credentialBundleId stay the same. The grants that authorized the credential bundles are updated with the claim set identifier, so credentials issued or updated under them from then on are issued for that claim set.
A claim set identifier can only be assigned once. The request is rejected with a 409 response if the claim set identifier conflicts with an existing credential reference or credential bundle, for example when the user already holds a credential of the same type issued for that claim set identifier.
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.
Roles
Analytics Events
bearerAuthAuthorizationBearer <JWT>credentialReferenceId*stringThe 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.
uuidThe claim set identifier to assign
application/json- body
claimSetId*stringThe claim set identifier to assign to the credential reference and its credential bundles. Only claimSetId can be set, and any other property is rejected with a 400 response.
1 <= length <= 255Claim set assigned to the credential reference
application/json- response
userId*stringThe user ID that owns this credential reference.
uuidcredentialReferenceId*stringThe 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.
credentialProfile*stringThe credential profile represents the type of credential that is associated with the credential reference. This is typically used to group credentials of the same type together, and can be used by the client to determine which credential to request when multiple credentials are associated with a credential reference.
credentialType*stringThe credential type represents the specific type of credential that is associated with the credential reference. This is typically used to identify the format or standard of the credential.
claimSetId?stringThe claim set identifier the credential reference was issued for, or that was assigned to it after issuance.
curl -X PUT 'https://example.vii.au01.mattr.global/v1/users/credential-references/a248d6c9-3f5e-4b2a-9c1e-2f3b4c5d6e7f' \ -H 'Content-Type: application/json' \ -d '{ "claimSetId": "claim-set-1"}'{ "userId": "41458e5a-9092-40b7-9a26-d4eb43c5792f", "credentialReferenceId": "a248d6c9-3f5e-4b2a-9c1e-2f3b4c5d6e7f", "credentialProfile": "mobile", "credentialType": "org.iso.18013.5.1.mDL", "claimSetId": "claim-set-1"}How would you rate this page?
Retrieve a credential reference GET
Retrieve the specified credential reference. A credential reference is a logical identifier for a credential, independent of any particular wallet or device. When a credential is issued to a user, it may be stored in multiple wallets or on multiple devices. Each stored instance is a separate copy, but all copies represent the same underlying credential. The credential reference stays the same across all of these instances, allowing issuers to consistently identify and interact with the credential regardless of where the user holds it.
Retrieve all credential bundles for a credential reference GET
Retrieve all credential bundles associated with the specified credential reference. 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.