Documentação Técnica

Descrição

A API tem a função de montar um score a partir de um setup de configurações definidos em nosso portal, de forma que a partir dessas pontuações seja possível definir uma regra de análise de um fluxo, por exemplo, de onboarding.

Tabela de preços para essa chamada

Consultas Realizadas no Mês Valor por consulta
1 - 10.000 R$ 0,160
10.001 - 50.000 R$ 0,153
50.001 - 100.000 R$ 0,144
100.001 - 500.000 R$ 0,138
500.001 - 1.000.000 R$ 0,131
1.000.001 - 5.000.000 R$ 133.000,00 (preço fixo)
5.000.001 e acima Entre em contato

Parâmetros obrigatórios

Essa consulta contém parâmetros obrigatórios para o sucesso da consulta. A tabela abaixo detalha os campos necessários.

Campo Descrição do campo Valores Possíveis do Campo
parameters Um dicionário chave-valor, o qual deve seguir a estrutura CPF ou CNPJ : 'número do documento' Qualquer texto

Abaixo está um exemplo de como realizar a chamada com parâmetros obrigatórios:

{
  "parameters": {"CPF": "12345678901"}
}

Parâmetros opcionais

Essa chamada permite a passagem de parâmetros opcionais para apoiar o processo de consulta. A tabela abaixo detalha os campos opcionais.

Campo Descrição do campo Valores Possíveis do Campo
Login Login do usuário Qualquer texto
Group O nome do grupo de configuração que deve ser usado na requisição Qualquer texto

Abaixo está um exemplo de como utilizar um dos parâmetros opcionais:

{
  "Login": "seu login",
  "Group": "nome do grupo de configuração",
  "parameters": {"CPF": "12345678901"}
}
Language
Credentials
Header
Click Try It! to start a request and see the response here!