Regras de cobranças por cenários de consulta
Preços públicos e padronizados para todos os clientes.
Em alguns cenários, a consulta pode ser cobrada mesmo quando o retorno não contém os dados solicitados. Isso ocorre quando a resposta da API ainda representa uma informação válida sobre a consulta realizada. A tabela abaixo resume os principais cenários em que a cobrança pode ou não ocorrer durante o processamento das requisições na Plataforma de Dados:
| Cenário | Cobrança | Observação |
|---|---|---|
| Documento inválido | Sim | A API retorna que o documento informado é inválido |
| Menor de idade | Sim | Retorna informação de que o documento pertence a um menor |
| Timeout inferior a 5 minutos | Sim | A consulta permanece em processamento pela plataforma |
| Timeout da fonte externa | Não | Retorna erro DATASET IS TOO SLOW |
| Consulta sem retorno de dados | Sim | A ausência de dados também constitui resposta válida |
| Erro 504 | Não | A requisição não chega a ser processada pela plataforma |
Adicionalmente, oferecemos observações adicionais sobre alguns dos cenários apresentados na tabela:
-
Documento inválido: a consulta é cobrada normalmente, pois a resposta da API informa que o documento fornecido é inválido. Nesses casos, o retorno vem associado ao código
-114 — INVALID DOC PARAMETER. -
Menor de idade: a consulta também é cobrada, pois o retorno indicando que o indivíduo é menor constitui uma informação válida da consulta. Nesses casos, é cobrado apenas o valor referente ao dataset Dados Cadastrais Básicos. Para mais detalhes sobre o comportamento da API, consulte Dados de menores de idade.
-
Timeout da fonte externa: quando ocorre o erro
DATASET IS TOO SLOW, isso indica lentidão ou indisponibilidade da fonte externa consultada. Nesses casos, a consulta não é cobrada. -
Consulta sem retorno de dados: podem ser cobradas normalmente, pois a ausência de dados também representa um resultado válido da consulta. Essa regra pode variar conforme o dataset; consulte sempre a documentação específica do dataset utilizado.
-
Erro 504: está relacionado à infraestrutura de rede entre o sistema do cliente e a API da Plataforma de Dados. Nessas situações, a requisição não chega a ser processada pela plataforma e, portanto, a consulta não é cobrada.

Updated about 6 hours ago
