> 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 API REST do Phalcon Compliance permite integrar a triagem de endereços e o monitoramento de transações diretamente aos seus aplicativos e fluxos de trabalho. Seja para verificar uma carteira individual antes de processar um saque ou monitorar continuamente transações em várias blockchains, a API oferece acesso programático às mesmas informações de risco disponíveis no painel do Phalcon Compliance.

## O que você pode fazer

### Triagem de endereços

Faça a triagem de endereços de blockchain com o mecanismo de risco para identificar entidades sancionadas, exposição a fundos ilícitos e outros riscos de conformidade.

| Endpoint                                                                                                                                                         | Descrição                                                           |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
| [`POST /address/screen`](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/address-screening/screen-a-single-address.md)                      | Fazer a triagem de um único endereço e obter os resultados de risco |
| [`POST /addresses/screen`](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/address-screening/batch-screen-addresses.md)                     | Fazer a triagem de até 100 endereços em uma solicitação             |
| [`GET /addresses/details/{chain_id}/{address}`](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/address-screening/get-an-address-detail.md) | Recuperar uma análise detalhada de risco de um endereço triado      |
| [`GET /addresses/screen/tasks/{task_id}`](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/address-screening/get-a-task-result.md)           | Consultar os resultados de uma tarefa de triagem assíncrona         |
| [`PUT /addresses/{chain_id}/{address}`](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/address-screening/update-an-address-info.md)        | Atualizar rótulos personalizados ou observações de um endereço      |

### Triagem de transações

Monitore a exposição ao risco de uma transação individual ou de um lote de transações, incluindo todas as transferências associadas.

| Endpoint                                                                                                                                                                        | Descrição                                                             |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| [`POST /transaction/screen`](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/transaction-screening/screen-a-single-transaction.md)                         | Fazer a triagem de uma única transação                                |
| [`POST /transactions/screen`](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/transaction-screening/batch-screen-transactions.md)                          | Fazer a triagem de até 100 transações em uma solicitação              |
| [`GET /transactions/screen/tasks/{task_id}`](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/transaction-screening/get-a-task-result.md)                   | Consultar os resultados de uma tarefa de triagem assíncrona           |
| [`GET /transactions/details/{transfer_id}`](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/transaction-screening/get-a-transfer-detail.md)                | Obter informações detalhadas de risco de uma transferência específica |
| [`GET /transactions/transfers/{chain_id}/{hash}`](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/transaction-screening/get-transfers-of-a-transaction.md) | Listar todas as transferências de uma transação                       |

### Gerenciamento de clientes

Vincule endereços e transações triados a clientes específicos para organizar o acompanhamento de conformidade.

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

### Gerenciamento de listas de bloqueio e permissão

Gerencie listas de endereços personalizadas para sinalizar ou ignorar automaticamente endereços durante a triagem.

| Endpoint                                                                                                                                                            | Descrição                                |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- |
| [`POST /blacklists/add`](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/blacklist-whitelist-management/add-addresses-to-blacklist.md)         | Adicionar endereços à lista de bloqueio  |
| [`POST /blacklists/remove`](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/blacklist-whitelist-management/remove-addresses-from-blacklist.md) | Remover endereços da lista de bloqueio   |
| [`POST /whitelists/add`](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/blacklist-whitelist-management/add-addresses-to-whitelist.md)         | Adicionar endereços à lista de permissão |
| [`POST /whitelists/remove`](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/blacklist-whitelist-management/remove-addresses-from-whitelist.md) | Remover endereços da lista de permissão  |

### Gerenciamento da conta

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

| Endpoint                                                                                                                                         | Descrição                            |
| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------ |
| [`GET /account/usage/screening`](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/account-management/get-screening-usage.md) | Obter estatísticas de uso da triagem |

## Início rápido

**1. Obtenha sua chave de API** — No espaço de trabalho do seu projeto, acesse **System → API** e clique em **Generate Key**.

**2. Envie sua primeira solicitação:**

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

**3. Confira a resposta** — Se a triagem for concluída em até 10 segundos, você receberá o resultado diretamente. Caso contrário, receberá um Task ID para consultar em `/addresses/screen/tasks/{task_id}` (ou em `/transactions/screen/tasks/{task_id}` para triagem de transações).

## Conceitos principais

* **Mecanismos de risco** — Cada triagem é executada em vários mecanismos de risco. Os resultados incluem a pontuação de risco e os indicadores de risco de cada mecanismo. Consulte a [Lista de indicadores de risco](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/introduction/risk-indicator-list.md) para ver todos os indicadores possíveis.
* **Tarefas assíncronas** — Solicitações em lote e triagens demoradas retornam um Task ID. Quando os resultados estiverem prontos, recupere-os usando `/addresses/screen/tasks/{task_id}` ou `/transactions/screen/tasks/{task_id}`.
* **Chain ID** — Cada blockchain compatível tem um ID de chain numérico (por exemplo, Ethereum = `1`, Bitcoin = `-1`). Consulte [Blockchains compatíveis](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/introduction/supported-chains.md) para ver a lista completa.

## Próximas etapas

* [Autenticação](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/introduction/authentication.md) — Como autenticar suas solicitações de API
* [Limites de taxa](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/introduction/rate-limits.md) — Limites de taxa padrão para cada endpoint
* [Blockchains compatíveis](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/introduction/supported-chains.md) — Blockchains e seus IDs
* [Registro de alterações](https://docs.compliance.phalcon.blocksec.com/pt-br/api-documentation/introduction/changelog.md) — Atualizações recentes da API
