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 um regra de analise de de um fluxo por exemplo, de onboarding.

Tabela de preços para essa chamada

Consultas Realizadas no MêsValor por consulta
1 - 10000R$ 0,160
10001 - 50000R$ 0,153
50001 - 100000R$ 0,144
100001 - 500000R$ 0,138
500001 - 1000000R$ 0,131
1000001 - 5000000R$ 133,000.00 (preço fixo)
5000001 e acimaEntre em contato

Paramêtros obrigatórios

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

CampoDescrição do campoValores Possíveis do Campo
Loginstring informando o login usado para autenticar, deve ser o mesmo login que está cadastrado no token usado na request.qualquer texto
parametersUm dicionário chave-valor, o qual deve seguir a estrutura CPF ou CNPJ : 'numero do documento'qualquer texto

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

{	'Login':'XXXXXXXXXXX', 'parameters':{'CPF': '12345678901'}',}

Paramêtros opcionais

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

CampoDescrição do campoValores Possíveis do Campo
GroupO nome do grupo de configuração que deve ser usado na requisiçãoqualquer texto

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

{	'Parameters': ''Login':'XXXXXXXXXXX', 'parameters':{'CPF': '12345678901',[Group=qualquer texto]}',}
Language
Authorization
Header
Click Try It! to start a request and see the response here!