A Base de Consultas é a central de consultas de bureau da HubCred. Por trás dela trabalhamos com vários provedores (Serasa, SCR/Bacen, provedores de KYC e mídia, entre outros), mas você não escolhe o provedor: você escolhe o tipo de consulta (Score, Protestos, Restrições, SCR, KYC, …) e nós resolvemos qual fonte usar e devolvemos o resultado normalizado num contrato estável.
Autentique-se antes de chamar qualquer endpoint (Autenticação). Os campos descritos nas páginas de cada endpoint são o conteúdo de result do envelope padrão da API.

​
Fluxo

1

Descubra os tipos disponíveis

ListarTipos retorna o catálogo de tipos que a sua loja pode consultar (já filtrado pelas funcionalidades contratadas), com o type (identificador) e se aceita CPF e/ou CNPJ.
2

Execute a consulta

Consultar recebe um documento (CPF/CNPJ) e a lista de types, executa cada consulta e devolve os resultados normalizados na mesma resposta, junto com uma reference por resultado.
3

Reobtenha quando precisar

ObterResultado devolve o resultado de uma consulta pela sua reference, sem custo, o resultado já pago fica disponível para releitura. Listar traz o histórico das consultas da sua loja.

​
Modelo de custo

  • Consultar é cobrado, cada tipo dispara uma chamada ao provedor correspondente. A execução é best-effort por tipo: se um tipo falha, os demais seguem, e o que falhou volta em failures (nada é cobrado/persistido para uma consulta que falhou).
  • ObterResultado e Listar são gratuitos, apenas releem o que já foi consultado.

​
A referência (reference)

Cada consulta persistida tem uma reference (inteiro) devolvida por Consultar e por Listar. Use-a em ObterResultado para reobter o resultado normalizado a qualquer momento, sem novo custo. A referência é escopada à sua loja.

​
O campo data

O resultado de cada tipo vem no campo data, cujo formato varia conforme o tipo da consulta (Score tem score/faixas; Protestos tem uma lista de registros; SCR tem o resumo do cliente; KYC tem identidade + PEP + sanções; etc.). O type/typeName de cada resultado indica qual formato esperar, os formatos por tipo estão descritos em Consultar.