proof-vc-web
Web Components for Proof Digital Credentials.
A JavaScript/TypeScript library of web components that lets you add a digital credential verification button to any website with a single HTML tag and one setup call.
This repository is a set of web components that help developers add digital credential verification to their websites and apps. A digital credential is a piece of verified information about a person, similar to a digital ID card or certificate, issued by a trusted source and stored on a user's device. The components in this library let a website ask a user to present one of those credentials to prove their identity or meet an eligibility requirement.
In practice, you install the package, call a setup function once with your account details and a callback address, then place a single HTML tag wherever you want the verification button to appear. When a visitor clicks it, the library handles the communication with Proof's credential service to confirm that the user holds the required credential.
The library works with plain HTML pages as well as React and other JavaScript frameworks. It ships built-in TypeScript type definitions so code editors can provide autocomplete and flag mistakes while you write. The verification button comes in multiple sizes and color themes to match your site's design.
A feature called Transaction Templates lets you attach structured details, such as ticket prices, item quantities, and a transaction description, to a verification request. This is useful for tying an identity check to a specific purchase or access scenario.
The README covers installation and basic usage. More detailed guides about how digital credentials work and the underlying verification API are available on Proof's developer documentation site.
Where it fits
- Add an age or identity verification button to a plain HTML page with a single tag and one setup function call.
- Gate access to a React app feature behind a digital credential check without building your own verification flow.
- Tie an identity check to a specific purchase by attaching ticket prices and item details via Transaction Templates.
- Match the verification button's size and color theme to your site's design using the built-in styling options.