Welcome to Heirloom’s API docs. We hope you stay awhile!

Here is a brief overview of some implementations of your API access:

Credential Issuance API 📩 (docs)

• What does it do?
  • Allows you to automate the issuance of Verifiable Credentials from a pre-existing Credential Set. You can opt for Credentials to be automatically emailed to recipients, or you can opt to embed the issuance deeplink in a location/email of your choosing.
• Prerequisites:
  • Create a Credential Set in Heirloom Creator
  • Fetch Credential Set ID from URL

QuickCheckin SDK 🎟️ (docs)

• What does it do?
  • Allows you to challenge a wallet holder to cryptographically prove that they are in possession of a valid Credential. The challenge can present in various ways, from a QR code at an in-person kiosk to a button on a screen.
• Prerequisites:
  • Create a QuickCheckin Lock in Heirloom Creator
  • Fetch Lock ID from upper right menu

QuickLogin SDK 💻 (docs)

• What does it do?
  • Allows you to challenge a wallet holder to cryptographically prove that they are in possession of a valid Credential. QuickLogin is tailored for online and digital applications, such as a gated website, and takes in a CORS domain during the setup process.
• Prerequisites:
  • Create a QuickLogin Lock in Heirloom Creator
  • Input your CORS domain
  • Fetch Lock ID from Lock Details Page

Need developer support? Don’t hesitate to reach out: [email protected]