Architecture
1
Issuer mints a credential
The issuing business (e.g., an employer or university) mints an attestation for a specific consumer using the Issuer API. The attestation is signed with the issuer’s key and anchored to the transparency log.
2
Credential is delivered
The credential is delivered to the consumer’s inbox via their email address. If the consumer does not yet have a Truthlocks account, the delivery is held in a pending queue and claimed automatically when they sign up.
3
Consumer receives and accepts
The consumer logs into the verify portal, views the credential in their inbox, and accepts it. Accepted credentials appear in their portfolio.
4
Verifier requests proof
A third-party business (the verifier) requests proof from the consumer — for example, via a shared link, QR code, or direct API call.
5
Consumer shares proof
The consumer approves the request, releasing the cryptographic proof bundle to the verifier. The verifier can independently validate the proof without contacting Truthlocks.
Issuing a credential
Use the deliver endpoint to issue a credential to a consumer’s inbox:- 201 Delivered — the consumer has an account and the credential is in their inbox.
- 202 Pending — the consumer does not have an account yet. The delivery is queued and auto-claimed when they register.
201 — Delivered
202 — Pending
Issuing with the SDK
Consumer experience
Once delivered, the consumer interacts with the credential through the verify portal:- Inbox — view all delivered credentials with issuer name and schema type. Unread items are highlighted.
- Accept — accept a credential to add it to your portfolio.
- Portfolio — manage accepted credentials and control which are public or private.
- Share — generate a shareable link or QR code for a specific credential’s proof bundle.
Verification by the relying party
The verifier receives a proof bundle (either via a shared link or directly from the consumer). They can verify it using the verify endpoint or offline using the proof bundle specification:Use cases
Related
Consumer portal
Managing credentials from the consumer side.
Deliver to inbox
API reference for credential delivery.
Verify endpoint
Verify a proof bundle.
Proof bundle spec
Offline verification specification.

