Cobrança de exceções
Este documento irá auxiliá-lo(a) a entender como funciona a cobrança para algumas exceções no retorno da consulta.
Documento Inválido
As consultas de documentos inválidos são cobradas normalmente, porque estamos avisando ao cliente que o documento é inválido, o que é uma informação relevante. O retorno vem associado ao código -114, "INVALID DOC PARAMETER".
Atenção: caso sua requisição para a API seja feita com múltiplos datasets, a cobrança se estenderá a todos os datasets requisitados na chamada.
Menor de Idade
As consultas a documentos de menores de idade seguem os padrões impostos pela LGPD e por como essa lei trata dispositivos específicos da Lei da Criança e do Adolescente. Para mais informações, clique aqui.
Essas consultas são cobradas normalmente pois estamos avisando ao cliente que o indivíduo é menor, o que é uma informação relevante.
O retorno virá associado a um código, conforme tabela abaixo:
| Código | Mensagem | Caso |
|---|---|---|
| -201 | “THIS CPF BELONGS TO A 12 YEAR OLD OR LESS. REQUEST CAN'T BE PROCESSED FOR LEGAL REASONS.” | Acontece nos casos onde o CPF pertence a um indivíduo de até 13 anos incompletos. |
| -202 | “DATE OF BIRTH DOESN'T MATCH CPF. CORRECT DATE OF BIRTH IS NEEDED TO PROCESS REQUEST.” | Acontece nos casos onde o CPF pertence a um indivíduo entre 13 e 18 anos incompletos, indicando a necessidade do envio de uma data de nascimento válida junto ao CPF para possibilitar o retorno da informação. |
Para ambos os retornos especificados acima, será cobrado somente o valor da validação de data de nascimento, que acompanha o valor do dataset de Dados Cadastrais Básicos.
Timeout
Trabalhamos internamente com um timeout de 5 minutos por consulta. A razão para esse timeout é o tempo que consultas a fontes externas, especialmente nos datasets on-demand, podem levar. Mesmo que você faça a requisição com um timeout menor do seu lado, nós ainda vamos manter a requisição ativa por até 5 minutos, e tentar retornar os resultados. A maior parte dos timeouts são encontrados por nossos clientes quando são feitas requisições aos datasets on-demand, pois esses datasets dependem da disponibilidade e velocidade da fonte sendo consultada para retornar.
Quando ocorre um timeout do lado da API da Plataforma de Dados, é retornado um erro "DATASET IS TOO SLOW", que indica um problema na fonte de onde o dado está sendo consultado. Consultas que apresentam essa mensagem de erro não são cobradas.
Como mantemos as requisições ativas e tentamos retornar os resultados obtidos, todas as consultas com tempo de execução inferior a 5 minutos são cobradas, mesmo que você tenha esperado um tempo menor e abandonado o processo do seu lado.
Consultas com retorno sem dados
É importante lembrar que o fato de uma informação não ser retornada não significa um erro de consulta. Por exemplo, uma consulta do dataset de Processos Judiciais que não retorna nenhum resultado é um indicativo de que não existem processos no nome daquele indivíduo, o que é uma informação relevante, e, portanto, será cobrada. Isso pode variar de um dataset para outro. Consulte a página específica do dataset que deseja consumir para maiores informações.
504
O erro 504 é um erro da infraestrutura de rede que conecta o seu sistema com a nossa API. Esse erro pode representar um problema do nosso lado (algum tipo de sobrecarga ou indisponibilidade do serviço), ou algum problema de configuração na sua rede interna que esteja impedindo o acesso à nossa API. Consultas que retornam esse erro nem chegaram a ser recebidas pelo serviço de execução das consultas e, portanto, não serão cobradas.
Esse erro praticamente não ocorre. Se você estiver recebendo erros desse tipo e não tiver certeza sobre o que está acontecendo, entre em contato conosco e te ajudaremos a entender o problema.
Updated over 1 year ago