> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cleariflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução

> A API de validação bancária da Cleariflow oferece validação abrangente de International Bank Account Numbers (IBAN) e Business Identifier Codes (BIC) através de uma interface RESTful JSON moderna — com suporte para mais de 50 países.

## Primeiros passos

<Card title="Validação IBAN" icon="credit-card" href="bank-validation/iban">
  O endpoint `iban` valida International Bank Account Numbers com verificação abrangente específica por país, controlo de formato e informações estruturais detalhadas para aplicações financeiras.
</Card>

<Card title="Validação BIC" icon="building" href="bank-validation/bic">
  O endpoint `bic` valida Business Identifier Codes e fornece detalhes de códigos bancários, informações de país e tipos de instituição para operações bancárias internacionais.
</Card>

<Card title="Países suportados" icon="globe" href="bank-validation/countries">
  Lista abrangente de países suportados para validação IBAN e BIC, incluindo códigos de país, informações de moeda e requisitos específicos de formatação.
</Card>

### Arquitetura REST

A API de validação bancária segue os princípios REST, utilizando URLs previsíveis e orientadas a recursos e códigos de estado HTTP padrão para integração fluida e tratamento de erros.

### Segurança HTTPS

Todas as comunicações da API são protegidas com protocolos de encriptação TLS 1.2 ou superior para garantir a integridade e privacidade dos dados.

### Versionamento da API

A API de validação bancária mantém compatibilidade retroativa através de versionamento, operando atualmente na Versão 1 com melhorias futuras planeadas.

### Autenticação

A sua chave API serve como credencial exclusiva para aceder à API de validação bancária. Cada serviço Cleariflow requer uma chave única, garantindo acesso seguro e isolado entre diferentes APIs.

## Códigos de resposta e erro

Quando os pedidos falham, a API devolve respostas de erro JSON estruturadas com códigos e descrições específicos para resolução eficaz de problemas.

| Code | Type                  | Detalhes                                                                                                                                                                  |
| ---- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 200  | OK                    | Tudo funcionou como esperado.                                                                                                                                             |
| 400  | Bad request           | Pedido inválido — parâmetros em falta ou inválidos.                                                                                                                       |
| 401  | Unauthorized          | O pedido não foi aceite — normalmente devido a uma chave API em falta ou incorreta.                                                                                       |
| 422  | Quota reached         | O pedido foi abortado devido a créditos API insuficientes (planos gratuitos).                                                                                             |
| 429  | Too many requests     | O pedido foi abortado porque foi atingido o número de pedidos permitidos por segundo. Isto acontece em planos gratuitos, pois os pedidos estão limitados a 1 por segundo. |
| 500  | Internal server error | O pedido não pôde ser concluído devido a um erro no servidor.                                                                                                             |
| 503  | Service unavailable   | O servidor estava indisponível.                                                                                                                                           |