Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.leads-siren.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

The Enrichment Service API provides endpoints for searching French companies and executives, enriching data records, looking up individuals, and downloading enriched results. All endpoints live under the /enrichment-service prefix.

​
Base URL

https://search.lespagesrouges.com/enrichment-service

​
Authentication

All secured endpoints require an API key sent in the x-api-key header: 
curl -H "x-api-key: YOUR_API_KEY" \
  https://search.lespagesrouges.com/enrichment-service/test
Invalid or missing keys return 401 Unauthorized.

​
Credits

Most API operations consume credits from your account balance. The credit cost varies by endpoint:
EndpointCredit Cost
Search CompaniesFixed per request
Search Executives1 credit per company/SIREN queried
Enrich1/SIREN + 5/email + 90/phone (email & phone skipped with skip_contact_search)
Enrich Single1/SIREN + 5/email + 90/phone (email & phone skipped with skip_contact_search)
All endpoints that return executive data support role_types (filter by role) and status_filter ("current", "former", or "all"). If your account has insufficient credits, the API returns a 402 Payment Required error with details about your current balance and the required amount.

​
Request Format

All POST endpoints expect a JSON body with a data key: 
{
  "data": {
    "filters": { ... },
    "page": 1
  }
}

​
Error Handling

The API uses standard HTTP status codes:
CodeMeaning
200Success
400Bad request — missing or invalid parameters
401Unauthorized — invalid or missing API key
402Payment required — insufficient credits
403Forbidden — invalid file path
404Not found — resource or file does not exist
500Internal server error
Error responses include a detail field: 
{
  "detail": "Insufficient credits (have 0, need 5)"
}