Back to Home
📚 Developer Documentation

ClearPass Integration Guide

Everything you need to integrate identity verification into your application. Choose from multiple integration methods to fit your needs.

Deep Link Integration

Redirect users to your branded verification page

Generic Scanner

Use our hosted document scanner page

Data Retrieval API

Get verification results via REST API

NPM SDK

Embed verification directly in your app

Deep Link Integration

Redirect users to a customized and branded verification page hosted by ClearPass.

How it works

  1. Generate a verification session with your API key
  2. Redirect the user to the ClearPass verification URL
  3. User completes verification on our branded page
  4. User is redirected back to your success/failure URL
  5. Retrieve verification results via webhook or API

Step 1: Create Verification Session

POST /api/v1/sessions
curl -X POST https://api.clearpass.app/v1/sessions \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"user_id": "user_123",
"success_url": "https://yourapp.com/success",
"cancel_url": "https://yourapp.com/cancel",
"branding": {
"logo_url": "https://yourapp.com/logo.png",
"primary_color": "#3B82F6",
"company_name": "Your Company"
}
}'

Step 2: Redirect User

// Response from session creation
{
"session_id": "sess_abc123",
"verification_url": "https://verify.clearpass.app/sess_abc123"
}

// Redirect user to verification_url
window.location.href = verification_url;

✨ Customization Options

  • • Custom logo and company branding
  • • Primary color theming
  • • Custom success/cancel redirect URLs
  • • Webhook notifications for real-time updates

Ready to integrate?

Get your API keys and start building with ClearPass today.

Get API Keys