Documentação da API de Recuperação de Caractere IBAN



Especificação de integração da API


1. O que faz a API de Recuperação de Caractere IBAN?


Esta API fornece a funcionalidade única de recuperar até dois caracteres desconhecidos de todo o Número Internacional de Conta Bancária (IBAN). Esta função pode ser utilizada nos casos em que partes do IBAN estão ilegíveis ou quando o input do usuário é validado. O sistema leva em conta o formato e o comprimento específico do país para garantir que uma quantidade mínima de sugestões seja exibida. Todas as permutações possíveis de dígitos e letras de acordo com o esquema de formatação internacional são testadas pelo algoritmo de verificação de dígito do módulo.
Casos de uso:

- Caracteres ilegíveis - Quando os IBANs são digitalizados de papéis é possível que a impressão degradada produza caracteres ilegíveis. Nosso sistema permite que você coloque um ponto de interrogação "?" no lugar dos caracteres desconhecidos. O nosso motor de validação gera todas as possíveis combinações válidas para este IBAN.

- Suposição Aceitável - Se você tem um IBAN inválido, você pode fazer uma suposição aceitável sobre qual posição o erro ocorre ao executar várias tentativas de recuperação com o curinga "?" em posições diferentes.





2. Recursos


A API de Recuperação IBAN permite que você faça o seguinte:




3. Requisições da API de Recuperação


O sistema da API permite automatizar a recuperação do IBAN através de uma simples requisição de HTTP GET ou POST.
Os parâmetros aceitos estão listados na tabela abaixo:

Nome do Campo Comprimento Tipo Descrição
IBAN Max 100 String O IBAN mascarado que você pretende validar. Use "?" (ponto de interrogação) no lugar do caractere desconhecido. Por exemplo: DE79850?0300310018056?
api_key 128 String Sua chave API pessoal.
format 5 String Formato da resposta em XML ou JSON.

*Para obter uma chave API, por favor, entre em contato através do contact@iban.com ou adquira uma assinatura em nossa página de vendas.

EXEMPLO - Recuperar um IBAN
Um exemplo de uso da API de Validação IBAN com um pedido GET pode ser encontrado abaixo:

https://api.iban.com/clients/api/recover-iban.php?api_key=key&format=xml&iban=IBAN

Onde:

Quando uma solicitação HTTP GET ou POST é feita com a chave de API correta, o sistema irá retornar os resultados no formato especificado. Você pode encontrar uma resposta de exemplo na seguinte seção “Estrutura de Resposta API“



4. Resposta da API de Recuperação


Um esquema XSD da resposta da API pode ser encontrado abaixo:


  
    
      
        
          
            
              
              
              
              
              
              
            
          
        
        
          
            
              
            
          
        
        
      
    
  


Uma descrição detalhada dos campos retornados de objetos format_data pode ser vista na tabela abaixo:
Nome do Campo Comprimento Tipo Descrição
country Max 2 String O código ISO de 2 letras do país.
iban_length Max 2 Integer O comprimento exato de todos os IBANs para este país.
format_template Max 2 String Um modelo com o tamanho exato do IBAN mostrando os diferentes caracteres dentro por posições. C = Misto (Alfabeto + 0-9), A = Caractere (Alfabético), N = Dígito (0-9).
bank_code Max 99 String O código de identificação bancário doméstico para este IBAN.
branch_code Max 99 String O identificador da agência doméstica para este IBAN.
account_number Max 99 String O número de conta bancária doméstica para este IBAN.


Uma resposta XML de exemplo da API de uma consulta de validação IBAN seria:



	
		CH
		21
		CCNNNNNNNCCCCCCCCCCCC
		85341
		
		0203475000
	
	
		CH810853410203475000K
		CH860853410203475000R
		CH8908534102034750002
	
	






5. Códigos de status da API de Recuperação


A API de Recuperação IBAN retorna os seguintes códigos de erro.
Código de Status Tipo Descrição
301 Erro de conta Chave API é inválida
302 Erro de conta A assinatura expirou
303 Erro de conta Nenhuma query disponível
304 Erro de conta Você não tem acesso a esta API
401 Erro de Input Campo obrigatório faltando.
402 Erro de Input Muitas wildcards. É permitido no máximo duas wildcards.
403 Erro de Input Poucos wildcards. É necessário pelo menos uma wildcard.