Skip to main content
1

Get an API Key

Create a free API key with a single request — no account or credit card needed.
curl -X POST https://api.limitguard.ai/v1/keys/create \
  -H "Content-Type: application/json" \
  -d '{"email": "you@example.com", "tier": "free"}'
Response
{
  "api_key": "lg_live_xxxxxxxxxxxxxxxxxxxx",
  "key_id": "key_abc123",
  "tier": "free",
  "monthly_limit": 500
}
Save the api_key immediately — it is shown once only. The plaintext key is never stored server-side.
2

Try Sandbox Mode (Free)

Test the API without using real data sources or quota by adding the sandbox header:
curl -X POST https://api.limitguard.ai/v1/entity/check \
  -H "X-API-Key: lg_live_xxxxxxxxxxxxxxxxxxxx" \
  -H "X-LimitGuard-Mode: sandbox" \
  -H "Content-Type: application/json" \
  -d '{
    "entity_name": "Acme Corp BV",
    "country": "NL",
    "kvk_number": "12345678"
  }'
Sandbox returns deterministic mock data — same input always gives the same output. No real data sources are called and no quota is consumed.
3

Make a Live Entity Check

Remove the sandbox header for real results against 8 data sources:
curl -X POST https://api.limitguard.ai/v1/entity/check \
  -H "X-API-Key: lg_live_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "entity_name": "Acme Corp BV",
    "country": "NL",
    "kvk_number": "12345678"
  }'
Response
{
  "trust_score": 87,
  "trust_level": "high",
  "cluster": "established_eu_sme",
  "recommendation": "proceed",
  "confidence": 0.94,
  "top_factors": [
    {"source": "kvk", "signal": "Active registration, 8+ years", "impact": "positive", "weight": 0.35},
    {"source": "vat", "signal": "VIES verified EU VAT", "impact": "positive", "weight": 0.20},
    {"source": "sanctions", "signal": "No sanctions match", "impact": "positive", "weight": 0.25}
  ],
  "sources_checked": ["kvk", "sanctions", "country_risk", "domain", "vat"],
  "processing_time_ms": 342
}
4

Try a Quick Risk Score

For fast risk-only assessment (2 sources, cheaper):
curl -X POST https://api.limitguard.ai/v1/risk/score \
  -H "X-API-Key: lg_live_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"entity_name": "Acme Corp BV", "country": "NL"}'

Response Quality Tiers

Control cost vs. freshness with the X-Response-Quality header:
TierHeader ValueCost (entity/check)Description
Cachedcached$0.01Serve from Redis cache if available
Freshfresh$0.05Always run full fan-out (default)
Enhancedenhanced$0.15Full fan-out + premium sources
curl -X POST https://api.limitguard.ai/v1/entity/check \
  -H "X-API-Key: lg_live_xxxxxxxxxxxxxxxxxxxx" \
  -H "X-Response-Quality: cached" \
  -H "Content-Type: application/json" \
  -d '{"entity_name": "Acme Corp BV", "country": "NL"}'

Next Steps