website logo
English version
⌘K
🚀Quickstart
🌎Documentação de API
📑Produtos
🔗Atualização de conexão
🖍️Categorização API
🏦Instituições disponíveis
⚠️Código de retorno
🖇️Integração de SDK e API
💓Controle de versão
Docs powered by archbee 
5min

Código de retorno

Aqui está uma lista de códigos de retornos para facilitar soluções de problemas. Erros na API de atualização automática podem ser encontradas lá.

Códigos de retorno comuns



Código

Mensagem

Descrição

Instrução sugerida

200

OK





201

The crawler has completed the scheduled work, but some data still needs user's extra authorization, which is beyond klavi's control.

Autorização extra necessária



202

The crawler has completed the scheduled work, but some transaction details failed to be downloaded. It is related to the availability of data source itself, which is beyond klavi's control.

Falta uma transação parcial



400

Signature failed

A assinatura falhou



401

User not found

[Apenas em modo GET] Usuário não existe na nossa base



402

User credential error

Quando o usuário tenta conectar a conta bancária com dados de login errados (ex: senha digitada errada)

Instruir a inserção correta da senha ou MFA

403

Bank service error

O banco está fora do ar

Pedir para o usuário conectar novamente mais tarde

404

Unexpected error

Erro inesperado

Abrir um ticket com time da Klavi

405

Account info is null

A conexão foi feita com sucesso mas a conta não tem dados



406

Wrong password input too many times, try again tomorrow

Nosso sistema não permite que usuários tentem acessar a conta com a senha errada muitas vezes, para evitar bloqueio pelo banco. Recomendamos tentar novamente no próximo dia

Pedir para o usuário conectar após 1 dia (24h)

407

Account or password activation problem

Conta inativa, senha inativa, senha temporária ou senha vencida

Pedir para o usuário resolver a sua pendência diante do Banco

408

Account or password blocked

A conta ou senha está bloqueada

Pedir para o usuário renovar a sua senha de internet banking

409

Account type error

O usuário usou credenciais de um tipo de conta errado (ex, usou login de PJ em ambiente de PF)

Pedir para o usuário conectar uma conta compatível a conexão

410

Input format error

O formato credencial de Entrada do utilizador está incorrecto Ou EM Falta



411

TraceId is null or not found

TraceId da tarefa é nulo ou não foi encontrado



412

Token is not required

Token não é necessário



413

Duplicated login

Ops! Verificamos que uma sessão está ativa. Faça logout do seu internet banking e tente novamente

Pedir para o usuário encerrar as atuais sessões ativas

414

Security measurement from bank

Por medida de segurança do seu banco, a conexão não está disponível

Pedir para o usuário conectar após 1 dia (24h)

415

Institution registration not finished

Por medida de segurança do seu banco aguarde 30 minutos para realizar a conexão.

Pedir para o usuário conectar após 30 min

429

Too Many Requests

Demasiados pedidos de API em um curto período



500

Internal Server Error

Erro interno do servidor



501

Invalid access

[Apenas em modo GET] Partner Token ou Partner Code faltando



502

Partner code not activated

[Apenas em modo GET] Partner Code desabilitado ou não ativado



503

Partner credential error

[Apenas em modo GET] Partner Code ou Token errados



504

Permission required for the data type

[Apenas em modo GET] Favor solicitar permissão para coleta dos dados



505

Request parameter missing or invalid

[Apenas em modo GET] Solicitação com parâmetros faltando ou inválidos



Códigos de retorno de atualização automática



Código

Mensagem

Descrição

200

OK



600

Invalid route

Rota inválida para acesso

601

Auto update unauthorized

Não autorizado pelo usuário

602

Request body invalid

Parâmetros no corpo da solicitação faltando ou inválidos (ex; connectionKey ou allowAutoUpdate)

701

Invalid access

Partner Code ou Partner Token faltando

702

Partner code not activated

Partner Code desabilitado ou não ativado

703

Partner code or token invalid

Partner Code ou Partner Token erradas ou inválidas

704

No access permission

Partners have no access permission to this service

No access permission

Os parceiros não têm permissão de acesso a este serviço

708

Data format verification failed

O formato dos dados de solicitação é incorreto

Códigos de retorno de Boleto_PJ

Código

Mensagem

Descrição

705

CNPJ not found

O número CNPJ solicitado não foi encontrado

706

The latest data updated to ${September 2022}

Em geral, os dados são atualizados mensalmente, sendo que os dados do mês anterior só podem ser atualizados no dia 15 de cada mês.



UP NEXT
Integração de SDK e API
Docs powered by archbee 
TABLE OF CONTENTS
Códigos de retorno comuns
Códigos de retorno de atualização automática
Códigos de retorno de Boleto_PJ