Integration Overview

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

What your integration includes

When your business integrates CAIRL, users verify their identity through CAIRL's hosted verification flow. Your integration receives verified claims through an OAuth consent boundary. No raw personal data is delivered to your systems.

Sections

• Getting Started — Set up your first integration in minutes.
• 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.
• OAuth and OIDC Guide — Map hosted verification into OAuth authorization and OIDC-style claims retrieval.
• Verification Sessions — API reference for hosted verification session lifecycle.
• Webhooks — Delivery, retries, event names, and payload handling.
• Claims — Verified claim names, consent behavior, and userinfo response shape.
• 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 platform.
• Brand Usage — Trademark rules and logo usage when referencing CAIRL.
• Asset Policy — Asset availability and distribution restrictions.

How verification works

1. Your platform 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 platform.
4. Your platform exchanges the authorization code, then reads verified claims from /api/oauth/userinfo.

Your systems receive the verification result. The personal data that produced it stays on CAIRL's side of the boundary.