SDKs
@zk-credit-passport packages
Four published packages covering the full range, from shared types to bundle issuance and verification.
@zk-credit-passport/verifier-sdkGitHubTyped HTTP client with named errors for verification flows on the server or at the edge.
npm i @zk-credit-passport/verifier-sdk@zk-credit-passport/holder-sdkGitHubEnd-to-end issue, bundle, verify, and revoke loop for holder wallets.
npm i @zk-credit-passport/holder-sdk@zk-credit-passport/coreGitHubCrypto primitives: holder signature, ZKPassport binding, bundle hashing.
npm i @zk-credit-passport/core@zk-credit-passport/shared-typesGitHubTypes shared between holder, verifier, issuer, and the revocation registry.
npm i @zk-credit-passport/shared-types
HTTP API
Verification and anchoring endpoints
When the SDKs are not an option, the HTTP endpoints expose the same flows. Every endpoint accepts JSON and returns typed envelopes.
- POST
/api/proofs/createGenerate a private proof from the signals the holder approved. - POST
/api/proofs/verifyVerify a received bundle and apply the verifier policy. - POST
/api/verifications/receiptRecord the verifiable receipt and return the final trail. - POST
/api/revocationsSubmit a revocation request to the issuer registry. - GET
/api/devnet/readinessSigner, RPC, and Solana devnet anchoring readiness.
Examples
Next.js apps wired to the SDKs
Two locally runnable apps that close the end-to-end loop. Each card shows the app final screen, the command to boot it locally, and a link to the source.
@zk-credit-passport/example-next-landlord-appVerifier portal — bundle-to-decision
Next.js app that consumes the verifier-sdk, accepts a proof bundle, applies the policy, and anchors the receipt on Solana devnet. The final screen exposes receipt id, anchor status, signature, and receipt PDA for institutional review.
npm --workspace @zk-credit-passport/example-next-landlord-app run dev
@zk-credit-passport/example-holder-wallet-appHolder wallet — end-to-end journey
Next.js app that exercises the holder-sdk across four steps: Good Payer passport issuance, selective-disclosure bundle, verification with devnet anchoring, and optional revoke. Each step appears timed in the journey timeline.
npm --workspace @zk-credit-passport/example-holder-wallet-app run dev
Status
Repository signals
- Network
- Solana devnet
- Circuits
- Noir + Barretenberg
- License
- MIT
- Published packages
- 4 @ 0.1.0
- Example market
- Brazil → U.S.