Documentation
Integrate CirclesCheck into your application with our REST API. Full API reference and interactive docs are available in the dashboard.
View Full API DocumentationQuick Start
JavaScript
// Quick example: Screen an entity
const response = await fetch('https://api.circlescheck.com/api/v1/screenings', {
method: 'POST',
headers: {
'Authorization': 'Bearer cc_live_your_api_key',
'Content-Type': 'application/json'
},
body: JSON.stringify({
fullName: 'John Smith',
type: 'individual',
dateOfBirth: '1980-05-15',
country: 'US',
screeningType: 'combined'
})
});
const result = await response.json();
console.log(result.matches);API Overview
Authentication
Use API keys with cc_live_ (production) or cc_test_ (sandbox) prefixes. Pass via Authorization: Bearer header.
Endpoints
Screen entities, verify KYC documents, manage customers, handle alerts and cases, and configure webhooks — all via REST.
Webhooks
Receive real-time notifications for screening completions, KYC updates, new alerts, and case changes.