> For the complete documentation index, see [llms.txt](https://docs.compliance.phalcon.blocksec.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/introduction.md).

# Introdução

A Phalcon Compliance REST API permite integrar a verificação de endereços e o monitoramento de transações diretamente em seus aplicativos e fluxos de trabalho. Quer você precise verificar uma única carteira antes de processar um saque ou monitorar continuamente as transações em várias cadeias, a API fornece acesso programático à mesma inteligência de risco disponível no painel do Phalcon Compliance.

## O Que Você Pode Fazer

### Verificação de Endereços

Verifique endereços blockchain contra mecanismos de risco para identificar entidades sancionadas, exposição a fundos ilícitos e outros riscos de conformidade.

| Endpoint                                                                                                             | Descrição                                                              |
| -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| [`POST /address/screen`](/pt-br/api-documentation/address-screening/screen-a-single-address.md)                      | Verifique um único endereço e obtenha resultados de risco              |
| [`POST /addresses/screen`](/pt-br/api-documentation/address-screening/batch-screen-addresses.md)                     | Verifique até 100 endereços em uma solicitação                         |
| [`GET /addresses/details/{chain_id}/{address}`](/pt-br/api-documentation/address-screening/get-an-address-detail.md) | Recupere o detalhamento detalhado de risco para um endereço verificado |
| [`GET /addresses/screen/tasks/{task_id}`](/pt-br/api-documentation/address-screening/get-a-task-result.md)           | Pesquise resultados de tarefas de verificação assíncronas              |
| [`PUT /addresses/{chain_id}/{address}`](/pt-br/api-documentation/address-screening/update-an-address-info.md)        | Atualize rótulos personalizados ou notas em um endereço                |

### Verificação de Transações

Monitore transações individuais ou em lotes para exposição de risco em todas as transferências envolvidas.

| Endpoint                                                                                                                            | Descrição                                                                 |
| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| [`POST /transaction/screen`](/pt-br/api-documentation/transaction-screening/screen-a-single-transaction.md)                         | Verifique uma única transação                                             |
| [`POST /transactions/screen`](/pt-br/api-documentation/transaction-screening/batch-screen-transactions.md)                          | Verifique até 100 transações em uma solicitação                           |
| [`GET /transactions/screen/tasks/{task_id}`](/pt-br/api-documentation/transaction-screening/get-a-task-result.md)                   | Pesquise resultados de tarefas de verificação assíncronas                 |
| [`GET /transactions/details/{transfer_id}`](/pt-br/api-documentation/transaction-screening/get-a-transfer-detail.md)                | Obtenha informações detalhadas de risco para uma transferência específica |
| [`GET /transactions/transfers/{chain_id}/{hash}`](/pt-br/api-documentation/transaction-screening/get-transfers-of-a-transaction.md) | Liste todas as transferências dentro de uma transação                     |

### Gerenciamento de Clientes

Vincule endereços e transações verificados a clientes específicos para rastreamento de conformidade organizado.

| Endpoint                                                                                                            | Descrição                                 |
| ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| [`GET /customers/details/{customer_id}`](/pt-br/api-documentation/customer/get-a-customer-detail.md)                | Obtenha detalhes de um cliente específico |
| [`POST /customers/{customer_id}/addresses`](/pt-br/api-documentation/customer/add-addresses-to-a-customer.md)       | Adicione endereços a um cliente           |
| [`POST /customers/{customer_id}/transactions`](/pt-br/api-documentation/customer/add-transactions-to-a-customer.md) | Adicione transações a um cliente          |

### Gerenciamento de Lista Negra / Lista Branca

Gerencie listas de endereços personalizadas para sinalizar automaticamente ou ignorar endereços durante a verificação.

| Endpoint                                                                                                                | Descrição                         |
| ----------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| [`POST /blacklists/add`](/pt-br/api-documentation/blacklist-whitelist-management/add-addresses-to-blacklist.md)         | Adicione endereços à lista negra  |
| [`POST /blacklists/remove`](/pt-br/api-documentation/blacklist-whitelist-management/remove-addresses-from-blacklist.md) | Remova endereços da lista negra   |
| [`POST /whitelists/add`](/pt-br/api-documentation/blacklist-whitelist-management/add-addresses-to-whitelist.md)         | Adicione endereços à lista branca |
| [`POST /whitelists/remove`](/pt-br/api-documentation/blacklist-whitelist-management/remove-addresses-from-whitelist.md) | Remova endereços da lista branca  |

### Gerenciamento de Conta

Consulte o uso de API e a cota do seu projeto.

| Endpoint                                                                                             | Descrição                                  |
| ---------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| [`GET /account/usage/screening`](/pt-br/api-documentation/account-management/get-screening-usage.md) | Obtenha estatísticas de uso de verificação |

## Início Rápido

**1. Obtenha sua chave de API** — Vá para **System → API** em seu espaço de trabalho do projeto e clique em **Generate Key**.

**2. Faça sua primeira solicitação:**

```bash
curl -X POST {BASE_URL}/address/screen \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR_API_KEY" \
  -d '{
    "chain_id": 1,
    "address": "0x..."
  }'
```

**3. Verifique a resposta** — Se a verificação for concluída em 10 segundos, você obterá resultados diretamente. Caso contrário, você receberá um Task ID para pesquisar via `/task/result`.

## Conceitos-Chave

* **Risk Engines** — Cada verificação é executada em múltiplos mecanismos de risco. Os resultados incluem pontuações de risco e indicadores de risco por mecanismo. Veja [Lista de Risk Indicators](/pt-br/api-documentation/introduction/risk-indicator-list.md) para todos os indicadores possíveis.
* **Tarefas Assíncronas** — Solicitações em lote e verificações lentas retornam um Task ID. Use o endpoint `/task/result` para recuperar resultados quando estiverem prontos.
* **IDs de Cadeia** — Cada blockchain suportado tem um ID de cadeia numérico (por exemplo, Ethereum = `1`, Bitcoin = `-1`). Veja [Cadeias Suportadas](/pt-br/api-documentation/introduction/supported-chains.md) para a lista completa.

## Próximas Etapas

* [Autenticação](/pt-br/api-documentation/introduction/authentication.md) — Como autenticar suas solicitações de API
* [Limites de Taxa](/pt-br/api-documentation/introduction/rate-limits.md) — Limites de taxa padrão por endpoint
* [Cadeias Suportadas](/pt-br/api-documentation/introduction/supported-chains.md) — Cadeias e seus IDs
* [Changelog](/pt-br/api-documentation/introduction/changelog.md) — Atualizações recentes de API