Integration OverviewCopy Anchor Link

This section covers how to integrate CAIRL into your site, display the CAIRL trust badge, and follow brand usage requirements.

What your integration includesCopy Anchor Link

When your business integrates CAIRL, users verify their identity through CAIRL's hosted verification flow. Through the OAuth claims interface, your integration receives the verified claims you requested and the user consented to share, together with a site-scoped pseudonymous identifier (sub). Source identity documents and biometric material are not returned. The returned claims and identifier remain personal data and must be handled accordingly; the Claims Reference lists each claim and explains sub.

Start hereCopy Anchor Link

• New to CAIRL? Getting Started walks through account setup (about 5 minutes) and the five API calls.
• Site built on a no-code platform? Add CAIRL to a base44 app has copy-paste backend functions and no SDK to install.
• Unfamiliar term? The glossary defines VAE, HVF, facet, scope vs. claim, sub, and the rest.

SectionsCopy Anchor Link

• Getting Started — Set up your account and first integration in minutes.
• Add CAIRL to a base44 app — Sign-in and verification for a no-code site, with complete backend functions.
• API Reference — Public endpoint, OpenAPI, and webhook schema contract.
• Quickstart: Get a Verified User in 10 Minutes — Complete OAuth 2.0 + PKCE integration guide with working code.
• Drop-in Checkbox (in development) — Design preview of the copy-paste age gate. The script is not yet served; integrate today via the OAuth quickstart.
• Authentication — Test and live keys, where to generate them, and how to keep them safe.
• OAuth and OIDC Guide — Map hosted verification into OAuth authorization and OIDC-style claims retrieval.
• Sign in with CAIRL (OpenID Connect) — Standard OpenID Connect sign-in with a pairwise identifier and no profile data, with Clerk and Auth0 walkthroughs.
• Verification Sessions — API reference for hosted verification session lifecycle.
• Webhooks — Delivery, retries, event names, and payload handling.
• Claims — Requestable scopes, the claim names they return, consent behavior, and userinfo response shape.
• Errors — Every error code, where it appears, and how to fix it.
• Shopify App Integration — Add CAIRL to Shopify storefront or checkout flows without collecting identity documents.
• Versioning and Changelog — Track public integration changes and compatibility expectations.
• Badge Integration — Display the CAIRL trust badge on your site.
• Brand Usage — Trademark rules and logo usage when referencing CAIRL.
• Asset Policy — Asset availability and distribution restrictions.
• Glossary — Plain-language definitions of the terms used across these docs.

How verification worksCopy Anchor Link

1. Your site redirects the user to CAIRL's hosted verification flow.
2. The user completes verification (document validation, face matching, liveness detection).
3. The user authorizes sharing a verified claim with your site.
4. Your server exchanges the authorization code, then reads verified claims from /api/oauth/userinfo.

Your systems receive the requested claims and sub, not the source identity documents or biometric material used to verify the user. The claims and sub are still personal data; handle them under applicable privacy, security, retention, and legal obligations, as the Claims Reference describes.