# Credits



Each API call consumes credits from your account balance. The table below lists every endpoint and its cost.

<Callout type="info">
  You are only charged for successful requests (status code `200`). Failed requests do not consume credits.
</Callout>

| Endpoint                                    | Method | Path                      | Credits |
| ------------------------------------------- | ------ | ------------------------- | ------- |
| [Domain Validation](/intelligence-domain)   | `GET`  | `/v1/intelligence/domain` | 2       |
| [Email Qualification](/intelligence-emailq) | `GET`  | `/v1/intelligence/emailq` | 5       |
| [Email Validation](/intelligence-email)     | `GET`  | `/v1/intelligence/email`  | 3       |
| [Exchange Rates](/vat-rates)                | `GET`  | `/v1/vat/rates`           | 1       |
| [IBAN Validation](/vat-iban)                | `GET`  | `/v1/vat/iban`            | 1       |
| [IP Reputation](/intelligence-ip)           | `GET`  | `/v1/intelligence/ip`     | 2       |
| [Phone Validation](/intelligence-phone)     | `GET`  | `/v1/intelligence/phone`  | 1       |
| [VAT Validation](/vat)                      | `GET`  | `/v1/vat`                 | 1       |


# Introduction



Get started with the Veille API in minutes. Make HTTP requests to our endpoints and receive structured JSON responses.

Quick Start [#quick-start]

<Steps>
  <Step>
    Get your API key [#get-your-api-key]

    Sign up on your [dashboard](https://app.veille.io) and copy your API key from the **Settings** page.
  </Step>

  <Step>
    Make your first request [#make-your-first-request]

    Include your key in the `x-api-key` header and call any endpoint:

    ```bash
    curl "https://api.veille.io/usage" \
      -H "x-api-key: YOUR_API_KEY"
    ```
  </Step>

  <Step>
    Handle the response [#handle-the-response]

    Every successful request returns a JSON object with structured data. See individual endpoint pages for response schemas and examples.
  </Step>
</Steps>

Authentication [#authentication]

All API requests must include an `x-api-key` header. You can find your key in your [dashboard settings](https://app.veille.io/settings).

```bash
curl -H "x-api-key: xxxx" https://api.veille.io/v1/usage
```

<Callout type="warn">
  Keep your API key secret. Do not expose it in client-side code or public repositories.
</Callout>

Status Codes [#status-codes]

Billing applies to successful requests: `200` for synchronous calls, `201` for asynchronous jobs, and `404` when the resource is not found (unless specified otherwise in the API documentation).

| Code  | Billed | Status              | Action                                                                                |
| ----- | ------ | ------------------- | ------------------------------------------------------------------------------------- |
| `200` | Yes    | Successful API Call | No action required.                                                                   |
| `201` | Yes    | Job Created         | No action required.                                                                   |
| `202` | No     | Accepted (Async)    | The request was accepted and is being processed. Use the job ID to check the status.  |
| `400` | No     | Bad Request         | Verify your parameters and their types. Check the documentation for more information. |
| `401` | No     | Invalid API Key     | Check your API key (`x-api-key` header or `x_api_key` query string).                  |
| `401` | No     | Inactive API Key    | Activate your API key in the API Keys section of your account settings.               |
| `401` | No     | Expired API Key     | Update your API key or generate a new one.                                            |
| `401` | No     | Rate Limit Exceeded | Consider upgrading your current plan or contact our sales team.                       |
| `402` | No     | Payment Required    | Settle any outstanding invoices to continue using the API.                            |
| `403` | No     | Forbidden           | Verify your permissions. Contact us if you believe this is a mistake.                 |
| `404` | Yes    | Not Found           | Result not found for this request. Some APIs do not bill 404.                         |
| `500` | No     | Internal Error      | Retry the action or contact our support team.                                         |

See the [Credits](/credits) page for a full breakdown of credit costs per endpoint.

Endpoints [#endpoints]

Browse all available endpoints in the sidebar, or jump directly:

<Cards>
  <Card title="Domain Validation" href="/intelligence-domain" />

  <Card title="Email Qualification" href="/intelligence-emailq" />

  <Card title="Email Validation" href="/intelligence-email" />

  <Card title="Exchange Rates" href="/vat-rates" />

  <Card title="IBAN Validation" href="/vat-iban" />

  <Card title="IP Reputation" href="/intelligence-ip" />

  <Card title="Phone Validation" href="/intelligence-phone" />

  <Card title="VAT Validation" href="/vat" />
</Cards>


# Domain Validation



{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Check any domain instantly. Detects disposable email providers, public webmail, relay services, and education domains. Returns DNS health with MX provider detection, domain history, and optional SSL/TLS certificate transparency.

**Credit cost:** 2 credits per request

<APIPage document={"/repo/apps/docs/specs/openapi.json"} operations={[{"path":"/v1/intelligence/domain","method":"get"}]} />


# Email Validation



{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Validate any email address in a single call. Detects disposable and temporary inboxes, identifies role accounts, public webmail, relay services, and returns a 0-100 risk score. For deep deliverability verification (SMTP check, catch-all detection), use the Email Qualification endpoint.

**Credit cost:** 3 credits per request

<APIPage document={"/repo/apps/docs/specs/openapi.json"} operations={[{"path":"/v1/intelligence/email","method":"get"}]} />


# Email Qualification



{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Deep email deliverability verification. Performs full Email Validation plus SMTP inbox check, catch-all detection, and returns a qualification verdict (valid, invalid, risky, disposable, unknown).

**Credit cost:** 5 credits per request

<APIPage document={"/repo/apps/docs/specs/openapi.json"} operations={[{"path":"/v1/intelligence/emailq","method":"get"}]} />


# IP Reputation



{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Assess the reputation of any IP address. Detects VPNs, proxies, Tor exit nodes, datacenter hosting, abusive traffic, and bots. Returns geolocation, network owner, and a 0-100 threat score.

**Credit cost:** 2 credits per request

<APIPage document={"/repo/apps/docs/specs/openapi.json"} operations={[{"path":"/v1/intelligence/ip","method":"get"}]} />


# Phone Validation



{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Validate any phone number in E.164 format. Detects disposable and virtual numbers, identifies carrier and line type (mobile/fixed/VoIP), returns country and timezone, and computes a 0-100 risk score.

**Status:** Experimental

**Credit cost:** 1 credit per request

<APIPage document={"/repo/apps/docs/specs/openapi.json"} operations={[{"path":"/v1/intelligence/phone","method":"get"}]} />


# IBAN Validation



{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Validate any IBAN and retrieve associated bank details. Returns the BIC/SWIFT code, bank name, country, BBAN structural breakdown, and SEPA zone membership.

**Credit cost:** 1 credit per request

<APIPage document={"/repo/apps/docs/specs/openapi.json"} operations={[{"path":"/v1/vat/iban","method":"get"}]} />


# Exchange Rates



{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Get current ECB exchange rates for any supported base currency. Optionally filter to specific target currencies. Updated daily from the European Central Bank.

**Credit cost:** 1 credit per request

<APIPage document={"/repo/apps/docs/specs/openapi.json"} operations={[{"path":"/v1/vat/rates","method":"get"}]} />


# VAT Validation



{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Validate a European VAT number against the VIES database. Returns company name, registered address, and validity status for any EU member state.

**Credit cost:** 1 credit per request

<APIPage document={"/repo/apps/docs/specs/openapi.json"} operations={[{"path":"/v1/vat","method":"get"}]} />