Read Docs Get API Access

Developer Guide

ClearCheck Data API Quickstart (15 minutes)

From zero to your first successful data enrichment lookup. Create an API key, submit a request, and retrieve results.

Get API KeyFull API Docs

What you’ll do

1Create an API key
2Fetch lookup IDs
3Submit a lookup
4Retrieve results
5Check credits
Note: Most lookups are async. First response returns status: "progress" + numeric id. Poll api-usage/{id} to get completed data.

Step-by-Step Guide

1

Prerequisites

You need an IRBIS account and API key:

2

Fetch your available lookup IDs

Every endpoint requires a lookupId matching your subscription. Fetch once and cache.

EndpointGET https://irbis.espysys.com/api/request-monitor/lookupid-list?key=YOUR_API_KEYcURLcurl -X GET \
'https://irbis.espysys.com/api/request-monitor/lookupid-list?key=YOUR_API_KEY' \
-H 'accept: application/json'

Pick the lookupId for your target: combined_phone, combined_email, or combined_name.

3

Make your first API call — Phone Lookup

EndpointPOST https://irbis.espysys.com/api/developer/combined_phonecURLcurl -X POST \
'https://irbis.espysys.com/api/developer/combined_phone' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"key": "YOUR_API_KEY",
"value": "+79017007397",
"lookupId": YOUR_LOOKUPID
}'Response{
"requestId": "5d60f1b7-e614-4524-bce6-174a81a2fd90",
"id": 1486,
"status": "progress",
"message": "Results will be available soon, Use API to retrieve Data"
}

Save the numeric id — you need it in step 5.

4

Email and Name lookups

Same pattern, different endpoint and matching lookupId.

Emailcurl -X POST 'https://irbis.espysys.com/api/developer/combined_email' \
-H 'Content-Type: application/json' \
-d '{"key":"YOUR_API_KEY","value":"[email protected]","lookupId":YOUR_LOOKUPID}'Namecurl -X POST 'https://irbis.espysys.com/api/developer/combined_name' \
-H 'Content-Type: application/json' \
-d '{"key":"YOUR_API_KEY","value":"John Smith","lookupId":YOUR_LOOKUPID}'

5

Retrieve results — api-usage/{id}

EndpointGET https://irbis.espysys.com/api/request-monitor/api-usage/{id}?key=YOUR_API_KEYcURLcurl -X GET \
'https://irbis.espysys.com/api/request-monitor/api-usage/1486?key=YOUR_API_KEY' \
-H 'accept: application/json'

Backoff: 2s → 5s → 10s between polls. Mark failed after 12–18 attempts.

6

Check your credits balance

curl -X GET \
'https://irbis.espysys.com/api/request-monitor/credit-stat?key=YOUR_API_KEY' \
-H 'accept: application/json'

Returns balance, credits, expiration date, and account status.

7

Important limits and common errors

“Insufficient enrichment timeout”

A 30-second minimum interval is enforced between searches for the same identifier. Use a queue with cooldown in production.

Wrong lookupId

Re-fetch lookupid-list to verify your active IDs match your subscription.

Still “progress” after polling?

Expected for first few polls. Continue with backoff. Mark failed after 12–18 attempts.

You’re ready to build

Get your API key and send your first enrichment request today.

Get API KeyRead API Docs

FAQ

What is a lookupId?

A numeric ID mapping to a specific enrichment endpoint on your subscription. Call GET /api/request-monitor/lookupid-list to see yours.

Why does my first response say “progress”?

Most lookups are async. IRBIS returns an id immediately and processes in the background. Poll api-usage/{id} with backoff until results are ready.

Why am I getting “Insufficient enrichment timeout”?

A 30-second cooldown between searches for the same identifier is enforced. Add a delay or queue in your integration.

Is it safe to use my API key in frontend code?

No. Always call from your backend server. Never expose keys in browser JavaScript or public repositories.

How do I know which endpoints my plan supports?

Fetch GET /api/request-monitor/lookupid-list — only active subscription endpoints appear. Contact support to upgrade.