Retrieve a credential reference
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.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>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.
uuidCredential reference retrieved
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.
curl -X GET 'https://example.vii.au01.mattr.global/v1/users/credential-references/a248d6c9-3f5e-4b2a-9c1e-2f3b4c5d6e7f'{ "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 all credential references GET
Retrieve all credential references associated with the specified user. 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.