Developer · API Quickstart

Send Your First Lookup in Under 15 Minutes

This guide walks you through getting your API key, sending your first enrichment request, and parsing the structured JSON response — in any language that supports HTTP.

No SDK required — standard HTTP POST requests
Bearer token authentication — one key for all lookup types
Async pipeline — submit, receive job ID, poll when ready
Consistent JSON response schema across all identifier types

Get API Key Full API Docs

Step 1

Get Your API Key

Sign up at the API portal. Once approved, you'll receive a Bearer token. Keep it server-side — never expose it in frontend JavaScript or client-side code.

AUTHBearer token — server-side only

// Store in environment variable — never hardcode
Authorization: Bearer YOUR_API_KEY_HERE
// Example: os.environ.get("CLEARCHECK_API_KEY")

Step 2

Submit a Lookup Request

Send a POST request to the combined endpoint. Set lookup_type to phone, email, name, or image.

POST/api/developer/combined_phoneJSON

POST https://api.clearcheck-data.com/api/developer/combined_phone
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

{
  "lookup_type": "phone",
  "value": "+14155552671",
  "lookup_id": 42
}

// Immediate response — job ID only
{
  "id": 8821043,
  "status": "progress"
}

Step 3

Poll for the Result

Use the job ID to query the monitor endpoint. When status is completed, the full enrichment data is ready.

GET/api/request-monitor/api-usage/{job_id}JSON

GET /api/request-monitor/api-usage/8821043
Authorization: Bearer YOUR_API_KEY

// Completed response
{
  "status": "completed",
  "data": {
    "type": "phone_lookup",
    "confidence": 0.94,
    "signals": {
      "carrier": "Example Carrier",
      "line_type": "mobile",
      "country": "US",
      "risk_score": 0.12,
      "linked_profiles": ["example_network"]
    }
  }
}

Quick Reference

Lookup Types & Endpoints

Lookup Type	Endpoint	Input
Phone	`/api/developer/combined_phone`	E.164 phone number — +14155552671
Email	`/api/developer/combined_email`	Email address — user@example.com
Name	`/api/developer/combined_name`	Full name — First Last
Image / Face	`/api/developer/face_search`	Image URL or base64-encoded photo

Full API Reference Async Pipeline Tutorial

API documentation is currently hosted on our existing documentation portal and will be migrated to the ClearCheck Data portal soon.

Frequently Asked Questions

No. The API uses standard HTTP POST and GET requests. Any language or tool that supports HTTP — Python, Node.js, PHP, cURL, Postman — works without any SDK.

Submit a POST request and receive a job ID. After a short wait (or when your system has capacity), GET the monitor endpoint with the job ID. When status is "completed", parse the data field.

Wait a moment and retry the GET request. Most lookups complete in under 1 second, but complex enrichment may take a few seconds. Implement simple polling with a short delay.

Rate limits depend on your plan. Refer to your account portal for current limits. The async pipeline is designed to support high-volume submissions without blocking.