Skip to main content

Sharing a Credential

Sharing a credential transmits it to a wallet holder for acceptance.

Issue the credential

Pass the credential's UUID to the share endpoint:

POST /api/credential/v1/{id}/share

This generates a protocol-specific URL, which is typically encoded as a QR code in the frontend. The holder scans it, the wallet parses the URL according to the issuance protocol, and then fetches and presents the credential to the holder for review.

Transaction codes

If the credential schema includes transaction code settings, the share endpoint also returns a generated transaction code. Deliver this to the holder through a secure out-of-band channel (such as SMS or email to a verified contact) — the holder must submit it during the issuance flow to complete the exchange.

After acceptance

Once the holder accepts the credential, manage its validity through suspension and revocation (if enabled in the schema). See Managing Credential Status.