Skip to main content
Verify a user or agent once. Check that result on your server. The SDK keeps headers and paths for api.proofable.me correct.

Browser vs server

One check needs no gate. Send the person to Hosted Verify and read the returned proof ID. Reach for defineGate + gateCheck when the decision needs several checks, a price, or a schedule. Keep npk_* and other secrets out of browser bundles. If the browser needs a call the SDK does not expose there, proxy through your backend. API overview.

Install

Upgrading from an earlier package? The migration guide has the rename map and the one-path upgrade.

Hosted URL (browser default)

getHostedCheckoutUrl takes one recipe per URL: intent: 'login', a published gateId, or direct verifiers / preset. Gates in the SDK lists the shared options. For agents, getHostedAgentCreateUrl runs agent identity and owner approval in the right order. Agents in the SDK.

Client configuration

Other options: apiKey (server key, sent as Authorization: Bearer), appId, billingWallet, appLinkQHash, paymentSignature, extraHeaders, identityChainId (the signing chain, Base by default; onchain anchoring stays a per-proof opt-in), and enableLogging. Keep apiKey and any secret server-side only.

App attribution (appId)

appId is a public attribution ID for server and app flows such as verifyFromApp. Inline gateCheck, gateCheck({ gateId }), and published listing checkout work without it.

Verification options

Pass these under options on client.verify(...): client.verify() always creates a new proof. Reuse is set by the strategy prop on VerifyGate (reuse-or-create default, fresh, reuse). Verification patterns covers privacy and widget options.

Optional: client.verify() (signs in the browser)

Use only when you intentionally keep signing in your page (wallet extension or injected provider):

Advanced: manual signing (full control)

When you assemble verifierIds / data yourself, then sign the standardized string. The example below is EVM. For non-EVM, pass the provider explicitly and include chain as a CAIP-2 value. See CAIP-380 Portable Proof.
For typical UX, use Hosted Verify so wallet selection and secondary signing stay on Proofable. Direct mode is for integrations that already control the secondary wallet and provider.

Gate checks from your servers

gateCheck uses public and unlisted proofs by default. Private proofs count when that user is signed in. For strict live checks, create a fresh proof and wait for verified status.
defineGate() normalizes requirements locally and makes no request. result.proofs lists matching proof references and result.missing lists checks that still need verification. Publish a listing with a gateId only when you need managed checkout and fulfillment. gateCheck versus checkGate, private-proof checks, and checkout calls are in Gates in the SDK.

Polling

pollProofStatus() retries transient errors and backs off on 429.

Advanced: private proof operations

Catalog and health

List the live verifier ids or fetch the full catalog with metadata and access levels.

Public proofs by wallet

React widgets

Widgets overview.
Last modified on October 25, 2026