API Documentation

Integrate digital footprint checks into your application. Search emails, phones, usernames, and more via REST API.

Get Your API KeyView Endpoints

Base URL: https://api.digitalfootprintcheck.com

Auth header: Authorization: Basic key-YOUR_API_KEY

Rate limit: 5,000 requests per hour

Content type: application/json

Getting an API Key

  1. Subscribe to a Pro or Business plan
  2. Go to Account > API Keys in your dashboard
  3. Click New API Key and select the scopes you need
  4. Copy your key (starts with key-)

Example: Create a Search

cURL
curl -X POST https://api.digitalfootprintcheck.com/api/search \
  -H "Authorization: Basic key-YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"identity":"example@gmail.com"}'
JavaScript
const res = await fetch('https://api.digitalfootprintcheck.com/api/search', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic key-YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ identity: 'example@gmail.com' })
});
const data = await res.json();
console.log(data.data.searchId);
Python
import requests

res = requests.post(
    'https://api.digitalfootprintcheck.com/api/search',
    headers={
        'Authorization': 'Basic key-YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={'identity': 'example@gmail.com'}
)
data = res.json()
print(data['data']['searchId'])

API Endpoints

POST/api/search

Initiate a search. Returns a searchId immediately. Poll GET /api/search/:id until complete is true. Consumes 1 credit.

Request Body

FieldTypeDescription
identitystringEmail, phone, username, or full name

Response (201)

{
  "data": {
    "searchId": "a1b2c3d4-...",
    "identity": "user@example.com",
    "complete": false,
    "paid": true
  }
}
GET/api/search/:id

Poll for results. Searches typically complete in 15-60 seconds. Poll every 3 seconds.

Response when complete (200)

{
  "data": {
    "searchId": "a1b2c3d4-...",
    "identity": "user@example.com",
    "complete": true,
    "report": { "employment": [...], ... }
  }
}

Polling example (JavaScript)

async function pollUntilComplete(searchId) {
  while (true) {
    const res = await fetch(
      'https://api.digitalfootprintcheck.com/api/search/' + searchId,
      { headers: { Authorization: 'Basic key-YOUR_KEY' } }
    );
    const data = (await res.json()).data;
    if (data.complete) return data;
    await new Promise(r => setTimeout(r, 3000));
  }
}
GET/api/search

List all searches for your account, newest first.

GET/api/account

Get account details: plan, credits remaining, subscription status.

GET/api/user

Get user profile information.

GET/api/key

List all API keys (masked). Use GET /api/key/:id to reveal a full key.

Error Codes

StatusMeaning
401Invalid or missing API key
402Insufficient credits - upgrade your plan
403API key lacks required scope
429Rate limit exceeded - wait and retry
500Server error - contact support if persistent

Ready to build?

Subscribe to a Pro or Business plan, create an API key, and start integrating in minutes.

View PlansManage API Keys