# Ocultação de PII (/pt-BR/features/pii-redaction)

<!-- agent-signals: reading_time_min: 3 · est_tokens: 1601 · updated: 2026-07-30 -->
Related: [Busca](/pt-BR/features/search.md), [Destaques da Busca](/pt-BR/features/search-highlights.md), [Índice de research](/pt-BR/features/research.md), [Scraping](/pt-BR/features/scrape.md), [Raspagem mais rápida](/pt-BR/features/fast-scraping.md), [Raspagem em lote](/pt-BR/features/batch-scrape.md)

A ocultação de PII substitui informações de identificação pessoal no markdown retornado antes de você enviá-lo para agentes, logs, bancos de vetores ou pipelines de análise.

<div id="how-it-works">
  ## Como funciona [#como-funciona]
</div>

Defina `redactPII: true` em uma requisição de scraping. O Firecrawl oculta as informações de identificação pessoal no markdown gerado e retorna a versão com esses dados ocultados em `markdown`. Você não precisa passar `formats`; markdown é o resultado padrão.

<CodeGroup>
  <CodeBlockTabs defaultValue="Python" groupId="cli+curl+javascript+python">
    <CodeBlockTabsList>
      <CodeBlockTabsTrigger value="Python">
        Python
      </CodeBlockTabsTrigger>

      <CodeBlockTabsTrigger value="JavaScript">
        JavaScript
      </CodeBlockTabsTrigger>

      <CodeBlockTabsTrigger value="cURL">
        cURL
      </CodeBlockTabsTrigger>

      <CodeBlockTabsTrigger value="CLI">
        CLI
      </CodeBlockTabsTrigger>
    </CodeBlockTabsList>

    <CodeBlockTab value="Python">
      ```python  
      from firecrawl import Firecrawl

      firecrawl = Firecrawl(
        # Nenhuma API key necessária para começar — adicione uma para limites de taxa maiores:
        # api_key="fc-YOUR_API_KEY",
      )

      doc = firecrawl.scrape(
          "https://example.com/contact",
          redact_pii=True,
      )

      print(doc.markdown)
      ```
    </CodeBlockTab>

    <CodeBlockTab value="JavaScript">
      ```javascript  
      import { Firecrawl } from 'firecrawl';

      const firecrawl = new Firecrawl({
        // Nenhuma API key necessária para começar — adicione uma para limites de taxa mais altos:
        // apiKey: "fc-YOUR_API_KEY",
      });

      const doc = await firecrawl.scrape('https://example.com/contact', {
        redactPII: true,
      });

      console.log(doc.markdown);
      ```
    </CodeBlockTab>

    <CodeBlockTab value="cURL">
      ```bash  
      # Nenhuma API key necessária para começar — adicione -H "Authorization: Bearer fc-YOUR_API_KEY" para limites de taxa mais altos:
      curl -X POST https://api.firecrawl.dev/v2/scrape \
        -H 'Content-Type: application/json' \
        -d '{
          "url": "https://example.com/contact",
          "redactPII": true
        }'
      ```
    </CodeBlockTab>

    <CodeBlockTab value="CLI">
      ```bash  
      # Retorna markdown com informações de identificação pessoal (PII) removidas.
      firecrawl https://example.com/contact --redact-pii
      ```
    </CodeBlockTab>
  </CodeBlockTabs>
</CodeGroup>

<div id="redaction-options">
  ## Opções de ocultação [#opções-de-ocultação]
</div>

Para a maioria das requisições, use `redactPII: true`. Para ajustar a ocultação, passe um objeto de opções:

```json
{
  "redactPII": {
    "mode": "accurate",
    "entities": ["EMAIL", "PHONE", "SECRET"],
    "replaceStyle": "tag"
  }
}
```

| Opção          | Valores                                                       | Padrão             | Descrição                                                                                                                                                               |
| -------------- | ------------------------------------------------------------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `mode`         | `accurate`, `aggressive`, `fast`                              | `accurate`         | Estratégia de ocultação. `accurate` usa um fluxo baseado apenas no modelo, `aggressive` aumenta o recall com heurísticas adicionais, e `fast` pula a chamada ao modelo. |
| `entities`     | `PERSON`, `EMAIL`, `PHONE`, `LOCATION`, `FINANCIAL`, `SECRET` | Todas as entidades | Limita a ocultação a categorias específicas de entidades.                                                                                                               |
| `replaceStyle` | `tag`, `mask`, `remove`                                       | `tag`              | Substitui trechos por tags como `<EMAIL>`, mascara com `*` ou remove os caracteres por completo.                                                                        |

<Note>
  A CLI do Firecrawl e o Servidor MCP expõem uma opção booleana simples de ocultação. As opções avançadas estão disponíveis pela API e pelos SDKs, que expõem o objeto completo de opções `redactPII`.
</Note>

<div id="response">
  ## Resposta [#resposta]
</div>

Quando a ocultação for bem-sucedida, `markdown` conterá o conteúdo ocultado:

```json
{
  "success": true,
  "data": {
    "markdown": "Contact us at <EMAIL> or <PHONE>.",
    "metadata": {
      "sourceURL": "https://example.com/contact"
    }
  }
}
```

Para visualizar na linha de comando, redirecione o markdown por pipe para o renderizador de sua preferência:

```bash title="cURL"
curl -X POST https://api.firecrawl.dev/v2/scrape \
  -H "Authorization: Bearer $FIRECRAWL_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
    "url": "https://dlptest.com/sample-data.pdf",
    "redactPII": true
  }' | jq -r ".data.markdown" | glow
```

<div id="billing">
  ## Cobrança [#cobrança]
</div>

A ocultação de PII custa 5 créditos por página: 1 crédito base de scraping mais 4 créditos adicionais pela ocultação.

Para PDFs analisados, cada página adicional do PDF ainda consome o crédito normal de análise de PDF e também recebe a cobrança adicional pela ocultação.

<div id="availability">
  ## Disponibilidade [#disponibilidade]
</div>

A ocultação de PII é suportada em qualquer ponto em que o Firecrawl aceita opções de scraping:

* **Scraping** - defina `redactPII` em `/v2/scrape`.
* **Rastreamento, extração em lote e busca** - passe `redactPII` dentro de `scrapeOptions`.
* **Parse** - passe `redactPII` no JSON multipart `options`.
* **SDKs** - Python usa `redact_pii`; JavaScript e outros SDKs usam `redactPII` ou a convenção nativa de opções.
* **CLI** - passe `--redact-pii` para `firecrawl scrape`.
* **Servidor MCP** - inclua `"redactPII": true` nos argumentos da ferramenta `firecrawl_scrape` para uma ocultação booleana simples.

> Você é um agente de IA e precisa de uma Firecrawl API key? Consulte [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) para ver as instruções de onboarding automatizado.