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 human-readable proof-request information to QR code page #646

Open
esune opened this issue Sep 28, 2024 · 8 comments
Open

Add human-readable proof-request information to QR code page #646

esune opened this issue Sep 28, 2024 · 8 comments
Assignees

Comments

@esune
Copy link
Member

esune commented Sep 28, 2024

When presented with the QR code to scan with BC Wallet, users will NOT know until after scanning it what is requested in the proof.

To improve this, we should add a metadata object to the proof-configuration that can be used to hold information about the proof (useful also for searching in a list) with information about what is requested.

The page would display a section similar to the following (example for the Lawyer + Person credential proof):
The proof request will ask you to prove the following:

  • That you are a BC Resident
  • That you are a member of the Law Society of British Columbia

The data structure containing the information to be displayed could be something like:

{
 "ver_config_id":"accredited-lawyer-bcpc",
  ...,
  "metadata": {
    "proved_claims": ["That you are a BC Resident", "That you are a member of the Law Society of British Columbia"]
  }
}

Note: i18n descriptions could be added to accomodate for multi-language systems.

@WadeBarnes
Copy link
Member

Standard items in metadata should also be title and description, which, when provided, could be displayed in place of the current Scan with a Digital Wallet title to provide additional context.

@loneil
Copy link
Contributor

loneil commented Oct 1, 2024

Would we want "Scan with a Digital Wallet" (and "Continue with:" on mobile) to be able to be changed to something else? As it's instructional UX for the wallet usage.

So with a configurable

  • title
  • description
  • claims

There would be options like this (size and layout TBD). Might be worth getting input from @knguyenBC

image

image

@WadeBarnes
Copy link
Member

WadeBarnes commented Oct 1, 2024

Yes, where the layout and content default to what we see on the screen currently.

In the absence of metadata content:

  • Title defaults to "Scan with Digital Wallet".
  • Description default to "".
  • Claims defaults to "".

+1 for getting @knguyenBC's input

@knguyenBC
Copy link

Can the metadata be configured for every use case or is it configured for every proof request? i.e. in the courthouse example above, the description is specific to courthouse materials but if another use case uses the same proof, could the description change?

Even though we have that screen for when people scan with a normal camera, I think it's important to call out "scan with a digital wallet" to catch them a earlier (a reward for people who read). So I agree with the screens @loneil has suggested. The issue is who is defining the Title, description, and claims.

@WadeBarnes
Copy link
Member

Current thought is the meta-data would be defined on the proof request. But yes that needs to be considered when registering the proof request; how generic is it's use.

@esune
Copy link
Member Author

esune commented Oct 1, 2024

The metadata will be for each proof-request configuration. Any user of VC-AuthN can decide to use any of the configured proof-requests, so the title/description should be as generic as possible (for that proof-request).

That is the reason why I was suggesting we start with the list of claims, as this can be used to fill a parametrized statement that will always be applicable regardless of the proof-request in use.

@knguyenBC
Copy link

I think for now, the list of claims and title is fine. No need for a description as that should be defined by the verifier on their own webpage. I'm not sure where the title will come from though. Is that a new spec (written and approved by who?) or is that taken from the ver_config_id? (Also written and approved by who?)

@esune
Copy link
Member Author

esune commented Oct 1, 2024

I think for now, the list of claims and title is fine. No need for a description as that should be defined by the verifier on their own webpage. I'm not sure where the title will come from though. Is that a new spec (written and approved by who?) or is that taken from the ver_config_id? (Also written and approved by who?)

We (Digital Trust Team) review all proof-requests that are made available in the system so it's going to be us determining the correct title for proof-configurations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Assigned
Development

No branches or pull requests

5 participants