Visão Geral

📖 Visão Geral

A API Sinky Consulta é responsável por orquestrar chamadas a diferentes dados e retornar os resultados consolidados em uma única chamada, de forma padronizada e eficiente.Ela permite consultar informações de CPF e CNPJ em múltiplos provedores e subprodutos através de um único endpoint. Isso simplifica a integração e garante consistência nos retornos.

Parâmetros de Consulta

A tabela abaixo detalha os campos aceitos na consulta:

Nome VariávelTipoObrigatórioDescrição
documentstringSimDocumento válido do tipo CPF ou CNPJ a ser consultado.
provedoresAdicionaisarray<string>NãoLista de slugs dos a serem consultados (ex.: serasa).
insumosAdicionaisarray<string>NãoLista de slugs dos insumos adicionados

Birôs de crédito

O Sinky Consulta integra diferentes birôs de crédito. Exemplos:

  • Serasa
  • Quod
  • Boa Vista
  • SPC

Insumos adicionais:

  • Emissão de Certidões
  • Exposição na Mídia
  • Processos
  • Protestos