Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add display metadata to the CredentialResponse #421

Open
leecam opened this issue Nov 26, 2024 · 4 comments
Open

Add display metadata to the CredentialResponse #421

leecam opened this issue Nov 26, 2024 · 4 comments
Milestone

Comments

@leecam
Copy link

leecam commented Nov 26, 2024

When receiving a credential from the Credential Endpoint we'd like an Issuer to be able to provide optional "card art" and a description.

For example an CredentialResponse maybe extended as follows:

{
    "display": [
        {
             "locale": "en-US",
             "name": "Lee's Tribank Card"
             "description": "5423 4343 2334 XXXX"
             "logo": {
                    "uri": "data:image/png;base64,F00==",
                    "alt_text": "credit card image"
             },
        }
    ]
    "credentials": [
    {
      "credential": "LUpixVCWJk0eOt4CXQe1NXK....WZwmhmn9OQp6YxX0a2L"
    }
  ]
}

This allows the wallet to display the credential with personalized cardart and descriptions in a standardized way, regardless of credential format or doctype. See this screenshot for an example of customized logo, title and description.

image

QZHelen added a commit to leecam/CMWallet that referenced this issue Dec 3, 2024
@c2bo
Copy link
Member

c2bo commented Dec 3, 2024

That would mean that display information inside the credential response would overrule the generic display information inside the issuer metadata if I understand correctly?

@javereec
Copy link
Contributor

javereec commented Dec 4, 2024

Good idea. Some thoughts:

  • It very likely that this information would be useful beyond this point (display in wallet, in a presentation flow). Doing it this way would probably mean that this information would be retained (... and passed on?)
  • If this is just for this interaction, I feel there needs to be a link between this and the format specific display metadata (from the issuer metadata).

@nemqe
Copy link
Contributor

nemqe commented Dec 4, 2024

In general not against the idea but have some questions/thoughts:

  • Would we do full override where we do not even look at the structure in the issuer medatada, or would we do partial overlays where we merge the returned structure with the one in the issuer medatada (we only replace the background image but logo should be the default one)
  • Would we deliver the full set of display data with regards to the locale or just parts. If we deliver the 'en-US' locale and the user changes the locale on their device what would be the cardart displayed to the user, and could the user request the cardart for the new locale, or would we always send all locales to the wallet. Even in the case where we send all of the currently known locales how would the user/wallet fetch a new locale that has been added (edge case)
  • Would we need mechanisms to update this personalized cardart in case of mistakes or changes in branding

@timbl-ont
Copy link

Another option is to include attribute values, from the credential, to overlay on top of the card view in the credential display metadata. The background_image could be an SVG with parameterized values, if precise layout was required.

@Sakurann Sakurann added this to the 1.1 milestone Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants