# Portuguese NIF and EU VAT validator (VIES) – bulk (`mocha_hackleberry/pt-nif-vat-validator`) Actor

Validate Portuguese NIF check digits offline and check EU VAT numbers against the official VIES service, in bulk.

- **URL**: https://apify.com/mocha_hackleberry/pt-nif-vat-validator.md
- **Developed by:** [Tomás Duro](https://apify.com/mocha_hackleberry) (community)
- **Categories:** Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$4.00 / 1,000 validated numbers

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Portuguese NIF and EU VAT validator (VIES) – bulk

Validates Portuguese NIF numbers (check digit and taxpayer type) offline and, optionally, checks EU VAT numbers with the official VIES service. Validador em lote de NIF português e de números de IVA da UE.

**Pay per result.** You are charged for each result returned. Set a spending limit in the run options to cap the cost.

### Input

- `numeros`: list of NIF / VAT numbers (with or without country prefix).
- `consultarVies`: also query VIES (default true).
- `incluirDadosEmpresa`: add company name/address when VIES returns them (default false).

### Output

One item per input: `formato_valido`, `tipo_nif`, `vies_estado` (valido / invalido / formato_invalido / indisponivel), `vies_valido`.

### Data source

European Commission VIES REST service (public) and the NIF check-digit rule (offline).

### Notes and limits

- VIES can be temporarily unavailable for some member states: the result then says `indisponivel`.
- Requests are throttled to be gentle with the public service.
- No personal data is collected or returned (no partners, e-mails or phone numbers).
- This Actor was created with AI assistance and is checked automatically every day. It is **not** an official service
  of the data providers and carries no guarantee; always confirm critical information at the source.

***

### Português

Validates Portuguese NIF numbers (check digit and taxpayer type) offline and, optionally, checks EU VAT numbers with the official VIES service. Validador em lote de NIF português e de números de IVA da UE.

Cobrança **por resultado**; define um limite de custo nas opções da execução. Não devolve dados pessoais. Foi criado com
apoio de IA e é testado automaticamente todos os dias; não é um serviço oficial das entidades que fornecem os dados.

# Actor input Schema

## `numeros` (type: `array`):

Numbers like 501964843 or PT501964843 or DE123456789

## `paisPorDefeito` (type: `string`):

Used when a number has no country prefix

## `consultarVies` (type: `boolean`):

Also ask the official EU VIES service

## `incluirDadosEmpresa` (type: `boolean`):

Off by default (a sole trader's name is personal data). You are responsible for how you use it.

## `maxItems` (type: `integer`):

Safety cap (max 1000)

## Actor input object example

```json
{
  "numeros": [
    "PT501964843",
    "123456788"
  ],
  "paisPorDefeito": "PT",
  "consultarVies": true,
  "incluirDadosEmpresa": false,
  "maxItems": 100
}
```

# Actor output Schema

## `results` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "numeros": [
        "PT501964843",
        "123456788"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("mocha_hackleberry/pt-nif-vat-validator").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "numeros": [
        "PT501964843",
        "123456788",
    ] }

# Run the Actor and wait for it to finish
run = client.actor("mocha_hackleberry/pt-nif-vat-validator").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "numeros": [
    "PT501964843",
    "123456788"
  ]
}' |
apify call mocha_hackleberry/pt-nif-vat-validator --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,mocha_hackleberry/pt-nif-vat-validator"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/Gb9cAGmlzHQfh3V0T/builds/bpUbUs0wXUA9NUVMd/openapi.json
