🚀 AllInDox API Documentation

Welcome to the AllInDox API! This comprehensive guide will help you integrate our powerful search capabilities into your applications.

📑 Table of Contents

  1. 🔌 Endpoints
  2. 🔑 API Key Usage

🔌 Endpoints

🔍 GET /keyInfo

Check your API key status and limits

📝 Details

  • URL: https://api.allindox.fr/keyInfo
  • Authentication: Required
  • Method: GET

📊 Parameters

Parameter Type Required Description
apiKey string ✅ Your unique API key

📤 Response


{
  "expiresAt": 1731234567890,
  "timeRemaining": 86400000,
  "requestsRemaining": 50
}

⚡ Example Request


GET https://api.allindox.fr/keyInfo?apiKey=your-api-key

🔎 GET /search

Powerful multi-criteria search across databases

📝 Details

  • URL: https://api.allindox.fr/search
  • Authentication: Required
  • Method: GET

📊 Parameters

Parameter Type Required Description
apiKey string ✅ Your unique API key
searchValues string ✅ Comma-separated search values
searchTypes string ✅ Comma-separated search types

📤 Response


{
  "commonRecords": [],
  "timeRemaining": 86400000,
  "requestsRemaining": 49,
  "searchTime": 150
}

⚡ Example Request


GET https://api.allindox.fr/search?apiKey=your-api-key&searchValues=value1,value2&searchTypes=type1,type2

🔎 GET /types

Get all type of search that you can do

📝 Details

  • URL: https://api.allindox.fr/types
  • Authentication: Required
  • Method: GET

📤 Response


{
  "requiredFields": [
    "adress",
    "name",
    "first_name",
    "second_first_name",
    "dob",
    "gender",
 	... 
 	]
}

⚡ Example Request


GET https://api.allindox.fr/types?apiKey=your-api-key

🔑 API Key Usage

📈 Key Management

  • • Expiration: Each key has a set validity period
  • • Request Limits: Monitor your usage through the /keyInfo endpoint
  • • Rate Limiting: Ensures fair usage across all users

🛡️ Security Best Practices

  1. 1. Never share your API key
  2. 2. Regularly check key status
  3. 3. Implement proper error handling
  4. 4. Monitor usage patterns

💡 Tips

Cache responses when possible

Batch requests for better performance

Keep track of remaining requests

Plan ahead for key renewal

Test GET /keyInfo

Test GET /search