API documentation for your platform.
ChainPass gives platforms verified access, user confirmation, agreements, custom requirements, and credential management through one API—or through our client dashboard.
Your platform receives the answers it needs. It never receives the identity data behind them.
The current API source supports the client dashboard and platform integrations.
Verify, authorize, administer and prove.
Confirm that a V.A.I. is active, compliant, and attached to the user presenting it.
Confirm access, agreements, declarations, transactions, and other platform actions through a live facial scan.
Let ChainPass handle onboarding, platform requirements, verification services, and credential updates.
Maintain immutable agreement versions and verification records that cannot be rewritten after the fact.
Data returned to your platform.
Routine responses follow your platform’s configured result format. VAIRIFY receives pass/fail and colour, never a percentage. The separately consented manual flow may serve a verified photograph for comparison; it is not a general photograph retrieval API.
ChainPass separates verification from identity ownership. Your platform receives what it needs to make a decision—and nothing beneath it.
Review endpoints by capability.
Current routes are grouped below. All listed central handlers are packaged in the API gateway. Required schema, document approvals and genuine acceptance remain separate deployment blockers.
Request an access decision for your user.
Platforms submit the V.A.I. and current live capture. Existing credential, platform, requirement, terms and production-face guards remain in force.
Compare your user’s live image with the verified photo.
Live capture only. The retired photo-match route is not a separate comparison service.
Create agreements and retrieve verification records.
POST /v1/registry administers exact immutable documents and agreements through register, fetch, live, retire, open, display, search, status, declaration and signed_document actions. User answers and signing remain controlled by ChainPass; the platform record action is refused.
Configure and check your platform’s requirements.
Read configuration first, then submit the expected snapshot with a replacement selection. Writes are atomic, platform scoped and audited. Missing approved documents, inactive services and conflicting geographic policies are refused.
Retrieve V.A.I. credential status.
Credential lookup preserves the private inactive-reason boundary and the governed courtesy-origin exception. Courtesy choice records intent only; activation remains in the enrollment flow. The level endpoint remains reserved.
Retrieve your platform’s activity and manage its configuration.
Read only your own traffic, capacity, commissions and allowlisted settings. Key changes retain dashboard/master authority. Health reports declared facial subsystem state with live_probe:false.
Enrollment requests and server-to-server handoff.
A signed single-use enrollment token opens the governed session. Completing the enrollment flow and its platform requirements still controls handoff.
Recovery and verification fallback.
Recovery actions retain their platform or member capability authority. Manual verification requires the existing consent flow. Re-baseline requests currently open trial sessions; live provider retakes remain separate.
Retired and reserved routes
/v1/photo-match is retired; use live verification. The historical /v1/agreements routes and /v1/proofs are replaced by the scoped registry. The /v1/credentials/{vai}/level route is reserved. These routes are excluded from the active index.
Enrollment requests and server-to-server handoff.
The platform opens a secure ChainPass enrollment session. ChainPass administers verification, agreements, and platform requirements, then completes a server-to-server handoff.
The designed handoff contains the V.A.I., the one-time session key, completion status, and the affirmed terms reference. It never contains the user’s legal name, government ID, or verified photograph.
After the handoff succeeds, ChainPass deletes its copy of the session key. It cannot be retrieved through an endpoint or resent later.
ChainPass returns the minimum handoff record the platform needs. ChainPass identity data never crosses the boundary.
ChainPass offers an optional vault module that platforms deploy within their own infrastructure. It protects session keys in a separate encrypted store without placing them beside V.A.I. numbers in the platform’s primary system.
View Vault ArchitectureComplete endpoint reference.
Search or filter the complete ChainPass API. Platform operations require the managed schema, approved documents, and live acceptance. The optional vault requires a separate receiving-platform installation.
API integration and documentation access.
Use the ChainPass API or our client dashboard to add verified access, user confirmation, agreements, and custom platform requirements without taking custody of users’ government ID.
There are no integration or platform fees. The V.A.I. holder pays.