API Documentation

1. Authentication

Every request requires an API key. Get yours from My Account after registering.

Pass the key as a query parameter apikey or as an HTTP header X-Api-Key.

2. Base URL & Format

• All requests use GET
• All responses are JSON with Content-Type: application/json
• Device identifiers (serial/IMEI) are case-insensitive

3. Endpoints

4. Pricing

Credits are deducted per successful check. Failed checks are not charged.

5. Response Format

Every response contains these top-level fields:

Summary Object — Key Fields

6. Error Codes

Error responses always include "ok": false and an "error" message:

// Example error response
{
    "ok": false,
    "error": "Insufficient balance ($2.30). Please top up.",
    "code": 402,
    "balance": 2.30,
    "cost": 0.55
}

7. Rate Limits

• 10 requests per minute per user account
• Applies to all endpoints (including failed checks)
• Returns 429 with Retry-After: 60 header when exceeded

8. Code Examples

# Full GSX Check
curl "https://ifreechecker.com/check?endpoint=full&id=FCMZR23CN70W&apikey=ifc_YOUR_KEY"

# Case History only
curl "https://ifreechecker.com/check?endpoint=case_history&id=FCMZR23CN70W&apikey=ifc_YOUR_KEY"

# Using header for API key
curl -H "X-Api-Key: ifc_YOUR_KEY" \
     "https://ifreechecker.com/check?endpoint=full&id=353911106779789"

<?php

$apiKey   = 'ifc_YOUR_KEY';
$serial   = 'FCMZR23CN70W';
$endpoint = 'full'; // full | case_history | repair_history | device_blacklist

$url = 'https://ifreechecker.com/check?' . http_build_query([
    'endpoint' => $endpoint,
    'id'       => $serial,
    'apikey'   => $apiKey,
]);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT        => 60,
    CURLOPT_SSL_VERIFYPEER => true,
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$data = json_decode($response, true);

if ($data['ok']) {
    $s = $data['summary'];
    echo "Model: "    . $s['model']    . "\n";
    echo "FMI: "      . $s['fmi']      . "\n";
    echo "Warranty: " . $s['warranty'] . "\n";
} else {
    echo "Error: " . $data['error'] . "\n";
}

const API_KEY  = 'ifc_YOUR_KEY';
const serial   = 'FCMZR23CN70W';
const endpoint = 'full'; // full | case_history | repair_history | device_blacklist

const params = new URLSearchParams({
    endpoint,
    id: serial,
    apikey: API_KEY,
});

const url = `https://ifreechecker.com/check?${params}`;

const res  = await fetch(url);
const data = await res.json();

if (data.ok) {
    const s = data.summary;
    console.log(`Model: ${s.model}`);
    console.log(`FMI: ${s.fmi}`);
    console.log(`Warranty: ${s.warranty}`);
    console.log(`Days left: ${s.daysRemaining}`);
} else {
    console.error('Error:', data.error);
}

import requests

API_KEY  = "ifc_YOUR_KEY"
serial   = "FCMZR23CN70W"
endpoint = "full"  # full | case_history | repair_history | device_blacklist

resp = requests.get("https://ifreechecker.com/check", params={
    "endpoint": endpoint,
    "id":       serial,
    "apikey":   API_KEY,
})

data = resp.json()

if data["ok"]:
    s = data["summary"]
    print(f"Model: {s['model']}")
    print(f"FMI: {s['fmi']}")
    print(f"Warranty: {s['warranty']}")
else:
    print(f"Error: {data['error']}")

9. DHRU Fusion / DHRU Panel Integration

Your credentials for DHRU

When you create an account, you get access to API keys. That key is the only credential you need for DHRU:

• Log in → My Account → API Keys
• Copy your API key (e.g. ifc_xxxxxxxxxxxx). You can create multiple keys with labels (e.g. Production, DHRU).
• In DHRU Fusion, use this key as API Access Key (apiaccesskey). No separate username or password is required — the API key alone authenticates you.

9.1 DHRU Fusion API (recommended)

iFreeChecker exposes a DHRU Fusion–compatible API at /dhru. DHRU can synchronize services, place orders, and fetch results (HTML report) using the same actions as other DHRU suppliers.

Actions supported:

Service IDs (for placeimeiorder and synced list):

Parameters can be sent as GET or POST (form or JSON). For placeimeiorder, parameters can be XML (e.g. <IMEI>...</IMEI><ID>1</ID>) or base64-encoded JSON. For getimeiorder, parameters should contain the order ID (numeric) or serial/IMEI to fetch the latest result.

The CODE field in getimeiorder is a simple HTML report (device model, IMEI, serial, warranty, purchase date, and status pills for Technical Support, Repairs Coverage, Replaced by Apple, Find My iPhone, iCloud, US Block, SIM-Lock) suitable for display in DHRU or emails.

9.2 URL-based integration (alternative)

If you prefer a simple URL-per-request setup instead of the DHRU Fusion API:

• Go to Admin Panel → Supplier → Add Supplier
• Type: Other / URL Based
• Name: iFreeChecker

Set the API URL to:

Create a service in DHRU for each endpoint:

Response: JSON with ok = true on success; error on failure. Ensure your account has sufficient balance.