Authentication

The Veridion API uses token-based authentication, requiring you to include your individual API key with each request.

📘

Request header

The API key must be included in a request header named x-api-key.

The API key is used to validate access to the API and enforce usage limits. Here is an example of how to pass your API key for authentication:

curl 'https://data.veridion.com/match/v4/companies' \
  -H "x-api-key: <your_api_key>" \
  -H "Content-type: application/json" \
  -d '{
    "legal_names": ["Sapiens International Corporation N.V."],
    "commercial_names": ["Sapiens"],
    "address_txt": "Holon, Israel"
  }'

If the API key is absent or the rate limits and quotas are exceeded, the API will respond with an error message, for example:

{
    "path": "/match/v4/companies",
    "status": 401,
    "error": "Unauthorized",
    "message": "Missing or invalid authorization key."
}