OpenAge API overview
The OpenAge API is OpenAge's core service for privacy-preserving, reusable age verification. It provides developers with secure, compliant age verification capabilities that adapt automatically to local regulations across 200+ jurisdictions. With it, you can enable applications to verify user ages without collecting or storing sensitive personal information.
Key features
- Privacy-First Design: Users can't be identified or followed across services
- Reusable Credentials: AgeKeys work across multiple services
- Global Compliance: Automatically adapts to local regulations
- Multiple Verification Methods: ID scanning, facial age estimation, credit card verification, and more
- Real-time Processing: Fast verification with immediate results
API endpoints
The OpenAge API provides two main endpoints for age verification:
Perform age verification
POST /api/v1/age-verification/perform
Initiates the age verification process and returns a verification session.
- View Perform Age Verification Endpoint - Complete reference for the verification endpoint
Get verification status
GET /api/v1/age-verification/get-status
Retrieves the current status and results of a verification session.
- View Get Status Endpoint - Complete reference for the status endpoint
Webhooks
Configure webhooks to receive real-time notifications about verification events:
- Set up webhooks in the Compliance Studio
- Handle webhook events in your application
- Verify webhook signatures for security
Best practices
- Follow security recommendations
- Use the prelaunch checklist before going live
- Implement proper error handling
- Test thoroughly in the test environment
Support & resources
- Documentation: Complete guides and API references
- Compliance Studio: Web interface for managing your integration
- API Reference: Interactive documentation for all endpoints
- Best Practices: Security and implementation guidelines
Next steps
Ready to get started? Follow these steps:
- Set up your Compliance Studio account
- Get your API keys
- Try the quick start guide
- Explore the API endpoints
The best way to get started with development is using the OpenAge Explorer, an open source tool for testing age verification flows. OpenAge Explorer lets you run through complete verification flows while monitoring all traffic, including DOM events, webhooks, and API calls in real time.
For detailed implementation guidance, see the Age verification guide.