Custom API Integration
Full Control & Deep Integration
Build exactly what you need with our RESTful API—200+ endpoints for complete control. Perfect for custom workflows, complex business logic, and high-volume operations.
How It Works
- 1Get API key from Cleared portal
- 2Integrate verification triggers into your business logic
- 3Call API to initiate verifications when needed
- 4Customer receives verification request via email/SMS
- 5Poll for status or receive webhook notifications
- 6Retrieve verification results via API
- 7Store verified data in your database
Best For
Custom workflows
Complex business logic
High-volume operations
Specific compliance requirements
Existing infrastructure
Enterprise applications
Technical Implementation
Initiate Verification
JavaScript
// Initiate verification
const response = await axios.post(
'https://cleared.id/api/v1/merchant/identity/verification/initiate',
{
name: 'John Smith',
emailAddress: 'john@example.com',
verificationRequests: [
{ type: 'identity', required: true },
{ type: 'address', required: true }
]
},
{
headers: {
'Authorization': `Bearer ${apiKey}`
}
}
);
// Later, retrieve results
const report = await axios.get(
`https://cleared.id/api/v1/merchant/identity/report/${resultId}`,
{ headers: { 'Authorization': `Bearer ${apiKey}` } }
);
console.log('Status:', report.data.status);