Radar do Crédito Documentação da API Entrar

Documentação da API

Consulte crédito de CPF e CNPJ pelo seu sistema. Resposta em JSON, envelope estável, ambiente de testes que não cobra.

Primeiros passos

Do zero à primeira consulta. A empresa é cadastrada pelo parceiro que gerencia a sua conta; o resto - teste, chave e ativação - é com você.

  1. 1

    Crie sua conta

    Acesse a plataforma e cadastre-se com o e-mail que recebeu o convite do parceiro, e uma senha. Você recebe um código de verificação por e-mail - confirme antes de continuar.

    Criar conta
  2. 2

    Entre na empresa e assine o termo

    Quem cadastra a empresa é o parceiro: confirmado o e-mail, o convite dele é aceito e a empresa aparece na sua conta. Assine eletronicamente o termo de uso dos dados. É o que autoriza suas consultas e declara a finalidade - exigência do bureau e da LGPD. Feito uma vez.

  3. 3

    Gere a chave de API

    No menu lateral, abra "API Keys" e clique em criar. Dê um nome que identifique onde a chave vai ser usada (ex.: "ERP produção") - se um dia precisar revogar, você saberá qual é.

    A chave aparece UMA vez. Copie e guarde num cofre no mesmo instante: guardamos apenas o hash e não há como recuperá-la depois. Perdeu, gere outra e revogue a antiga.

  4. 4

    Teste sem gastar crédito

    Sua conta começa em ambiente de testes: as consultas devolvem dados simulados, no mesmo formato da resposta real, e não debitam nada. Integre inteiro antes do primeiro centavo.

  5. 5

    Compre créditos e ative a produção

    Compre um pacote avulso (sem mensalidade) ou assine um plano, e troque para produção na plataforma. A partir daí as consultas são reais e debitam do saldo.

Autenticação

Toda chamada leva a sua chave no header. Ela identifica a empresa e é de onde o crédito sai.

Chave de consulta

ok_live_…

Header: X-API-Key

Consulta CPF e CNPJ, debitando do saldo da sua empresa.

Você gera sozinho, na plataforma, em API Keys.

Chave é segredo: guarde em cofre ou variável de ambiente, nunca no código do aplicativo nem no front-end. Vazou, revogue e gere outra - leva segundos e não derruba as demais.

Endereços

APIhttps://api.radardocredito.com.br
Plataformahttps://app.radardocredito.com.br

Ambiente de testes

Toda conta nova nasce em homologação. As consultas devolvem dados simulados no mesmo formato da resposta real e não debitam crédito - dá para integrar do começo ao fim sem gastar nada.

O campo creditos.cobrado diz o que aconteceu: false em homologação, true quando a consulta foi real e o crédito saiu.

A troca para produção é feita na plataforma, na barra lateral. Depois disso, toda consulta é real.

POST /api/radar/v1/consulta-pf X-API-Key

Consultar CPF

Score, restritivos e cadastro positivo de uma pessoa física.

Corpo

CampoObrigatórioTipoObservação
cpfsimstringCom ou sem máscara.
solicitantenãostringCNPJ da sua empresa. Sem ele, usamos o cadastrado.
Requisição
curl -X POST 'https://api.radardocredito.com.br/api/radar/v1/consulta-pf' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: SUA_CHAVE' \
  --data '{"cpf":"123.456.789-09"}'
Ver o contrato completo da resposta

Esta é a resposta inteira, com todos os campos. O formato não muda: campo que a consulta não trouxer vem null, e nunca some do JSON. Programe contra este contrato e sua integração continua valendo mesmo quando melhorarmos a fonte por trás.

Resposta completa
{6 campos}
"versao": "1.0",
"consulta": {5 campos},
"tipo": "pf",
"documento": "<CPF_CONSULTADO>",
"solicitante": "<CNPJ_DA_SUA_EMPRESA>",
"ambiente": "producao",
"consultadoEm": "2026-08-27T12:00:00.000Z"
},
"resultado": {9 campos},
"score": {7 campos},
"valor": 512,
"classificacao": "C",
"classificacaoNumerica": 3,
"probabilidadeInadimplencia": "7,20",
"plano": null,
"descricao": null,
"texto": "É provável que 93% das pessoas com esse mesmo comportamento paguem suas contas nos próximos 6 meses."
},
"restritivos": {5 campos},
"possuiRestritivos": true,
"totalOcorrencias": 3,
"valorTotalBRL": 1830.5,
"categorias": {4 campos},
"acoesJudiciais": {5 campos},
"total": 1,
"valorTotalBRL": 1200,
"primeira": "2024-02-01T00:00:00Z",
"ultima": "2024-02-01T00:00:00Z",
"mensagem": null
},
"protestos": {5 campos},
"total": 0,
"valorTotalBRL": 0,
"primeira": null,
"ultima": null,
"mensagem": "Nada Consta"
},
"debitos": {5 campos},
"total": 2,
"valorTotalBRL": 630.5,
"primeira": "2023-11-10T00:00:00Z",
"ultima": "2024-05-02T00:00:00Z",
"mensagem": null
},
"protestosSP": {5 campos}
"total": 0,
"valorTotalBRL": 0,
"primeira": null,
"ultima": null,
"mensagem": null
}
},
"detalhes": [1 item]
{10 campos}
"origem": "debito",
"tipo": "FINANCEIRA",
"descricao": "Financeira",
"contrato": "C-123",
"dataRegistro": "2024-05-02T00:00:00Z",
"valorBRL": 430.5,
"situacao": "ATIVO",
"informante": "Banco Exemplo",
"cidade": "Sao Paulo",
"uf": "SP"
}
]
},
"cadastroPositivo": {2 campos},
"consultado": true,
"detalhe": {3 campos}
"notaFaturaEmAtraso": "B",
"notaContratosRecentes": "A",
"statusConsumidor": "Consumidor Participante do Cadastro Positivo com Informação"
}
},
"identificacao": {23 campos},
"nome": "Fulano de Tal",
"documento": "<CPF_CONSULTADO>",
"nascimento": "1980-05-10T00:00:00Z",
"mae": "Mae de Tal",
"sexo": "M",
"estadoCivil": "SOLTEIRO",
"obito": "N",
"situacaoReceita": "REGULAR",
"regiao": "SP-SAO PAULO",
"atualizacao": "2026-07-30",
"razaoSocial": null,
"nomeFantasia": null,
"situacaoCadastral": null,
"dataSituacaoCadastral": null,
"dataFundacao": null,
"naturezaJuridica": null,
"codigoNaturezaJuridica": null,
"cnae": null,
"atividade": null,
"nire": null,
"ufNire": null,
"inscricaoEstadual": null,
"ufInscricaoEstadual": null
},
"endereco": {8 campos},
"telefones": [1 item],
"(11) 99999-0000"
],
"logradouro": "Rua Exemplo",
"numero": "10",
"complemento": null,
"bairro": "Centro",
"cidade": "Sao Paulo",
"uf": "SP",
"cep": "1310100"
},
"decisao": null,
"participacoes": null,
"consultas": {5 campos},
"total": 2,
"periodoInicial": null,
"periodoFinal": null,
"porMes": [2 itens],
{2 campos},
"mesAno": "082026",
"quantidade": 1
},
{2 campos}
"mesAno": "072026",
"quantidade": 1
}
],
"consulentes": []
},
"modelosAdicionais": [1 item]
{7 campos}
"modelo": "1A",
"natureza": "Renda Presumida Positiva",
"valor": 0,
"classificacao": null,
"classificacaoNumerica": null,
"probabilidade": "0,00",
"texto": "De R$ 3.001 até R$ 5.000"
}
]
},
"creditos": {2 campos},
"custoBRL": 1.84,
"cobrado": true
},
"arquivo": {3 campos},
"url": "https://api.radardocredito.com.br/api/radar/v1/relatorio/<ID>.pdf?exp=<EXP>&sig=<SIG>",
"formato": "pdf",
"expiraEm": "2026-08-30T12:00:00.000Z"
},
"metadata": {1 campo}
"data": {12 campos}
"NumeroResp": "007520456-8",
"Score": 512,
"Classifica": {2 campos},
"Numerico": 3,
"Alfabetico": "C"
},
"Provavel": "00720",
"Texto": "É provável que 93% das pessoas com esse mesmo comportamento paguem suas contas nos próximos 6 meses.",
"Identity": {10 campos},
"Nome": "FULANO DE TAL",
"CPF": "<CPF_CONSULTADO>",
"Nascimento": "1980-05-10T00:00:00Z",
"Mae": "MAE DE TAL",
"Sexo": "M",
"Civil": "SOLTEIRO",
"Obito": "N",
"SituacaoReceita": "REGULAR",
"Regiao": "SP-SAO PAULO",
"Atualizacao": "2026-07-30T00:00:00Z"
},
"Address": {7 campos},
"Logradouro": "RUA EXEMPLO",
"Numero": "10",
"Bairro": "CENTRO",
"Cidade": "SAO PAULO",
"UF": "SP",
"CEP": 1310100,
"Telefones": [1 item]
{2 campos}
"DDD": 11,
"Numero": 999990000
}
]
},
"Restritivos": {6 campos},
"AcoesJudiciais": {5 campos},
"Total": 1,
"ValorTotalBRL": 1200,
"Primeira": "2024-02-01T00:00:00Z",
"Ultima": "2024-02-01T00:00:00Z",
"Mensagem": ""
},
"Protestos": {5 campos},
"Total": 0,
"ValorTotalBRL": 0,
"Primeira": "0001-01-01T00:00:00Z",
"Ultima": "0001-01-01T00:00:00Z",
"Mensagem": "NADA CONSTA"
},
"DebitosResumo": {5 campos},
"Total": 2,
"ValorTotalBRL": 630.5,
"Primeira": "2023-11-10T00:00:00Z",
"Ultima": "2024-05-02T00:00:00Z",
"Mensagem": ""
},
"ProtestosSP": {5 campos},
"Total": 0,
"ValorTotalBRL": 0,
"Primeira": "0001-01-01T00:00:00Z",
"Ultima": "0001-01-01T00:00:00Z",
"Mensagem": ""
},
"DebitosDetalhe": [1 item],
{9 campos}
"Tipo": "FINANCEIRA",
"Descricao": "FINANCEIRA",
"Contrato": "C-123",
"DataReg": "2024-05-02T00:00:00Z",
"ValorBRL": 430.5,
"Situacao": "ATIVO",
"Informante": "BANCO EXEMPLO",
"Cidade": "SAO PAULO",
"UF": "SP"
}
],
"ProtestosDetalhe": []
},
"PositivoConsultado": true,
"Positivo": {3 campos},
"NotaFaturaEmAtraso": "B",
"NotaContratosRecentes": "A",
"StatusConsumidor": "CONSUMIDOR PARTICIPANTE DO CADASTRO POSITIVO COM INFORMAÇÃO"
},
"Modelos": [2 itens],
{10 campos},
"Tipo": "1",
"Score": 512,
"Modelo": "0A",
"ClassNumerica": 3,
"ClassAlfa": "C",
"Probabilidade": "00720",
"Texto": "É provável que 93% ...",
"Natureza": "POSITIVO PF",
"CodigoNatureza": "115",
"Valor": 0
},
{10 campos}
"Tipo": "1",
"Score": 6,
"Modelo": "1A",
"ClassNumerica": 0,
"ClassAlfa": "",
"Probabilidade": "00000",
"Texto": "De R$ 3.001 até R$ 5.000",
"Natureza": "RENDA PRESUMIDA POSITIVA",
"CodigoNatureza": "116",
"Valor": 0
}
],
"ResumoConsultas90": {2 campos}
"Total": 2,
"Meses": [2 itens]
{3 campos},
"Ano": 2026,
"Mes": 8,
"Total": 1
},
{3 campos}
"Ano": 2026,
"Mes": 7,
"Total": 1
}
]
}
}
}
}
CampoTipoO que é
versaostringVersão do contrato. Muda só se o formato mudar - e aí a versão antiga continua respondendo.
consultaobjetoO que foi perguntado: tipo, documento, solicitante, ambiente e quando.
resultadoobjetoO que veio. Nove blocos, sempre presentes: score, restritivos, cadastroPositivo, identificacao, endereco, decisao, participacoes, consultas (volumetria de consultas ao documento) e modelosAdicionais (outros modelos de score, ex.: renda presumida). Bloco sem dado vem null inteiro; modelosAdicionais vem lista vazia.
creditosobjetocustoBRL = quanto essa consulta custou. cobrado = false em ambiente de testes, quando nada é debitado.
arquivoobjeto ou nullRelatório em PDF: link assinado que expira em 3 dias. null quando a geração falhou - a consulta em si continua válida.
metadataobjetoResposta bruta da consulta, para auditoria e uso avançado - traz campos que o resultado não resume (modelos de score, painel do cadastro positivo, consultas anteriores, resumo de 90 dias). É o ÚNICO campo cujo formato pode mudar sem aviso: não programe contra ele.

plano e descricao vêm null: eram o nome comercial do modelo de score de quem calcula, e isso não vai para o cliente. O que descreve o resultado - valor, classificacao, probabilidadeInadimplencia e texto - continua vindo.

O resultado é o mesmo para CPF e CNPJ. Um CNPJ não devolve nome da mãe, e uma pessoa física normalmente não devolve participações societárias - nesses casos o bloco vem null, nunca ausente.

POST /api/radar/v1/consulta-pj X-API-Key

Consultar CNPJ

Score, restritivos, sócios e participações de uma pessoa jurídica.

Corpo

CampoObrigatórioTipoObservação
cnpjsimstringCom ou sem máscara.
solicitantenãostringCNPJ da sua empresa.
Requisição
curl -X POST 'https://api.radardocredito.com.br/api/radar/v1/consulta-pj' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: SUA_CHAVE' \
  --data '{"cnpj":"12.345.678/0001-90"}'
Ver o contrato completo da resposta

Esta é a resposta inteira, com todos os campos. O formato não muda: campo que a consulta não trouxer vem null, e nunca some do JSON. Programe contra este contrato e sua integração continua valendo mesmo quando melhorarmos a fonte por trás.

Resposta completa
{6 campos}
"versao": "1.0",
"consulta": {5 campos},
"tipo": "pf",
"documento": "<CPF_CONSULTADO>",
"solicitante": "<CNPJ_DA_SUA_EMPRESA>",
"ambiente": "producao",
"consultadoEm": "2026-08-27T12:00:00.000Z"
},
"resultado": {9 campos},
"score": {7 campos},
"valor": 512,
"classificacao": "C",
"classificacaoNumerica": 3,
"probabilidadeInadimplencia": "7,20",
"plano": null,
"descricao": null,
"texto": "É provável que 93% das pessoas com esse mesmo comportamento paguem suas contas nos próximos 6 meses."
},
"restritivos": {5 campos},
"possuiRestritivos": true,
"totalOcorrencias": 3,
"valorTotalBRL": 1830.5,
"categorias": {4 campos},
"acoesJudiciais": {5 campos},
"total": 1,
"valorTotalBRL": 1200,
"primeira": "2024-02-01T00:00:00Z",
"ultima": "2024-02-01T00:00:00Z",
"mensagem": null
},
"protestos": {5 campos},
"total": 0,
"valorTotalBRL": 0,
"primeira": null,
"ultima": null,
"mensagem": "Nada Consta"
},
"debitos": {5 campos},
"total": 2,
"valorTotalBRL": 630.5,
"primeira": "2023-11-10T00:00:00Z",
"ultima": "2024-05-02T00:00:00Z",
"mensagem": null
},
"protestosSP": {5 campos}
"total": 0,
"valorTotalBRL": 0,
"primeira": null,
"ultima": null,
"mensagem": null
}
},
"detalhes": [1 item]
{10 campos}
"origem": "debito",
"tipo": "FINANCEIRA",
"descricao": "Financeira",
"contrato": "C-123",
"dataRegistro": "2024-05-02T00:00:00Z",
"valorBRL": 430.5,
"situacao": "ATIVO",
"informante": "Banco Exemplo",
"cidade": "Sao Paulo",
"uf": "SP"
}
]
},
"cadastroPositivo": {2 campos},
"consultado": true,
"detalhe": {3 campos}
"notaFaturaEmAtraso": "B",
"notaContratosRecentes": "A",
"statusConsumidor": "Consumidor Participante do Cadastro Positivo com Informação"
}
},
"identificacao": {23 campos},
"nome": "Fulano de Tal",
"documento": "<CPF_CONSULTADO>",
"nascimento": "1980-05-10T00:00:00Z",
"mae": "Mae de Tal",
"sexo": "M",
"estadoCivil": "SOLTEIRO",
"obito": "N",
"situacaoReceita": "REGULAR",
"regiao": "SP-SAO PAULO",
"atualizacao": "2026-07-30",
"razaoSocial": null,
"nomeFantasia": null,
"situacaoCadastral": null,
"dataSituacaoCadastral": null,
"dataFundacao": null,
"naturezaJuridica": null,
"codigoNaturezaJuridica": null,
"cnae": null,
"atividade": null,
"nire": null,
"ufNire": null,
"inscricaoEstadual": null,
"ufInscricaoEstadual": null
},
"endereco": {8 campos},
"telefones": [1 item],
"(11) 99999-0000"
],
"logradouro": "Rua Exemplo",
"numero": "10",
"complemento": null,
"bairro": "Centro",
"cidade": "Sao Paulo",
"uf": "SP",
"cep": "1310100"
},
"decisao": null,
"participacoes": null,
"consultas": {5 campos},
"total": 2,
"periodoInicial": null,
"periodoFinal": null,
"porMes": [2 itens],
{2 campos},
"mesAno": "082026",
"quantidade": 1
},
{2 campos}
"mesAno": "072026",
"quantidade": 1
}
],
"consulentes": []
},
"modelosAdicionais": [1 item]
{7 campos}
"modelo": "1A",
"natureza": "Renda Presumida Positiva",
"valor": 0,
"classificacao": null,
"classificacaoNumerica": null,
"probabilidade": "0,00",
"texto": "De R$ 3.001 até R$ 5.000"
}
]
},
"creditos": {2 campos},
"custoBRL": 1.84,
"cobrado": true
},
"arquivo": {3 campos},
"url": "https://api.radardocredito.com.br/api/radar/v1/relatorio/<ID>.pdf?exp=<EXP>&sig=<SIG>",
"formato": "pdf",
"expiraEm": "2026-08-30T12:00:00.000Z"
},
"metadata": {1 campo}
"data": {12 campos}
"NumeroResp": "007520456-8",
"Score": 512,
"Classifica": {2 campos},
"Numerico": 3,
"Alfabetico": "C"
},
"Provavel": "00720",
"Texto": "É provável que 93% das pessoas com esse mesmo comportamento paguem suas contas nos próximos 6 meses.",
"Identity": {10 campos},
"Nome": "FULANO DE TAL",
"CPF": "<CPF_CONSULTADO>",
"Nascimento": "1980-05-10T00:00:00Z",
"Mae": "MAE DE TAL",
"Sexo": "M",
"Civil": "SOLTEIRO",
"Obito": "N",
"SituacaoReceita": "REGULAR",
"Regiao": "SP-SAO PAULO",
"Atualizacao": "2026-07-30T00:00:00Z"
},
"Address": {7 campos},
"Logradouro": "RUA EXEMPLO",
"Numero": "10",
"Bairro": "CENTRO",
"Cidade": "SAO PAULO",
"UF": "SP",
"CEP": 1310100,
"Telefones": [1 item]
{2 campos}
"DDD": 11,
"Numero": 999990000
}
]
},
"Restritivos": {6 campos},
"AcoesJudiciais": {5 campos},
"Total": 1,
"ValorTotalBRL": 1200,
"Primeira": "2024-02-01T00:00:00Z",
"Ultima": "2024-02-01T00:00:00Z",
"Mensagem": ""
},
"Protestos": {5 campos},
"Total": 0,
"ValorTotalBRL": 0,
"Primeira": "0001-01-01T00:00:00Z",
"Ultima": "0001-01-01T00:00:00Z",
"Mensagem": "NADA CONSTA"
},
"DebitosResumo": {5 campos},
"Total": 2,
"ValorTotalBRL": 630.5,
"Primeira": "2023-11-10T00:00:00Z",
"Ultima": "2024-05-02T00:00:00Z",
"Mensagem": ""
},
"ProtestosSP": {5 campos},
"Total": 0,
"ValorTotalBRL": 0,
"Primeira": "0001-01-01T00:00:00Z",
"Ultima": "0001-01-01T00:00:00Z",
"Mensagem": ""
},
"DebitosDetalhe": [1 item],
{9 campos}
"Tipo": "FINANCEIRA",
"Descricao": "FINANCEIRA",
"Contrato": "C-123",
"DataReg": "2024-05-02T00:00:00Z",
"ValorBRL": 430.5,
"Situacao": "ATIVO",
"Informante": "BANCO EXEMPLO",
"Cidade": "SAO PAULO",
"UF": "SP"
}
],
"ProtestosDetalhe": []
},
"PositivoConsultado": true,
"Positivo": {3 campos},
"NotaFaturaEmAtraso": "B",
"NotaContratosRecentes": "A",
"StatusConsumidor": "CONSUMIDOR PARTICIPANTE DO CADASTRO POSITIVO COM INFORMAÇÃO"
},
"Modelos": [2 itens],
{10 campos},
"Tipo": "1",
"Score": 512,
"Modelo": "0A",
"ClassNumerica": 3,
"ClassAlfa": "C",
"Probabilidade": "00720",
"Texto": "É provável que 93% ...",
"Natureza": "POSITIVO PF",
"CodigoNatureza": "115",
"Valor": 0
},
{10 campos}
"Tipo": "1",
"Score": 6,
"Modelo": "1A",
"ClassNumerica": 0,
"ClassAlfa": "",
"Probabilidade": "00000",
"Texto": "De R$ 3.001 até R$ 5.000",
"Natureza": "RENDA PRESUMIDA POSITIVA",
"CodigoNatureza": "116",
"Valor": 0
}
],
"ResumoConsultas90": {2 campos}
"Total": 2,
"Meses": [2 itens]
{3 campos},
"Ano": 2026,
"Mes": 8,
"Total": 1
},
{3 campos}
"Ano": 2026,
"Mes": 7,
"Total": 1
}
]
}
}
}
}
CampoTipoO que é
versaostringVersão do contrato. Muda só se o formato mudar - e aí a versão antiga continua respondendo.
consultaobjetoO que foi perguntado: tipo, documento, solicitante, ambiente e quando.
resultadoobjetoO que veio. Nove blocos, sempre presentes: score, restritivos, cadastroPositivo, identificacao, endereco, decisao, participacoes, consultas (volumetria de consultas ao documento) e modelosAdicionais (outros modelos de score, ex.: renda presumida). Bloco sem dado vem null inteiro; modelosAdicionais vem lista vazia.
creditosobjetocustoBRL = quanto essa consulta custou. cobrado = false em ambiente de testes, quando nada é debitado.
arquivoobjeto ou nullRelatório em PDF: link assinado que expira em 3 dias. null quando a geração falhou - a consulta em si continua válida.
metadataobjetoResposta bruta da consulta, para auditoria e uso avançado - traz campos que o resultado não resume (modelos de score, painel do cadastro positivo, consultas anteriores, resumo de 90 dias). É o ÚNICO campo cujo formato pode mudar sem aviso: não programe contra ele.

plano e descricao vêm null: eram o nome comercial do modelo de score de quem calcula, e isso não vai para o cliente. O que descreve o resultado - valor, classificacao, probabilidadeInadimplencia e texto - continua vindo.

O resultado é o mesmo para CPF e CNPJ. Um CNPJ não devolve nome da mãe, e uma pessoa física normalmente não devolve participações societárias - nesses casos o bloco vem null, nunca ausente.

GET /api/radar/v1/custo X-API-Key

Custo por consulta

Quanto cada consulta debita para a SUA empresa - já considerando qualquer condição comercial negociada.

Requisição
curl 'https://api.radardocredito.com.br/api/radar/v1/custo' -H 'X-API-Key: SUA_CHAVE'
Resposta
{
  "cobra": true,
  "pf": { "creditos": 4.77 },
  "pj": { "creditos": 14.00 }
}

Créditos são fracionários: 1 crédito = R$ 1,00, com duas casas. Uma consulta de R$ 1,84 debita 1,84 - não arredonda para cima. cobra: false significa ambiente de testes.

GET /api/radar/v1/ambiente X-API-Key

Ambiente atual

Diz se a sua conta está em testes ou em produção.

Requisição
curl 'https://api.radardocredito.com.br/api/radar/v1/ambiente' -H 'X-API-Key: SUA_CHAVE'

Para parceiros

Se você revende consulta - ERP, sistema de crediário, plataforma de locação -, dá para criar a conta do seu cliente pela API, sem passar por nós.

Chave de parceiro

pk_live_…

Header: X-Partner-Key

Cria contas de clientes seus - empresa, usuário e chave de consulta.

Liberada por nós. Fale com o seu contato comercial.

A chave de parceiro cria empresas. Guarde-a com o mesmo cuidado de uma senha de administrador e nunca a coloque numa integração de consulta.

POST /api/radar/v1/onboarding X-Partner-Key

Cadastrar um cliente (parceiros)

Cria a conta do seu cliente - usuário, empresa e chave de consulta - em uma chamada. Para quem revende consulta: ERP, sistema de crediário, plataforma de locação.

Corpo

CampoObrigatórioTipoObservação
empresa.cnpjsimstringValidado na Receita Federal.
empresa.nomenãostringSem ele, usamos a razão social oficial.
responsavel.nomesimstringQuem responde pela empresa.
responsavel.emailsimstringDo CLIENTE, não seu - é para lá que vai a verificação.
responsavel.telefonenãostringFormato E.164, ex.: +5535997265571.
responsavel.senhasimstringEscolhida pelo cliente. Mínimo 4; recomendamos 8+.
Requisição
curl -X POST 'https://api.radardocredito.com.br/api/radar/v1/onboarding' \
  -H 'Content-Type: application/json' \
  -H 'X-Partner-Key: SUA_CHAVE_DE_PARCEIRO' \
  --data '{
    "empresa": { "cnpj": "19.444.380/0001-81" },
    "responsavel": {
      "nome": "Maria Souza",
      "email": "maria@cliente.com.br",
      "senha": "a-senha-que-o-cliente-escolheu"
    }
  }'
Resposta
{
  "apiKey": "ok_live_a1b2c3d4e5f6...",
  "empresa": {
    "id": "9c1e8f3a-...",
    "cnpj": "19444380000181",
    "razaoSocial": "CONEXAO INOVE TELECOMUNICACOES LTDA",
    "ambiente": "homologacao"
  },
  "usuario": { "id": "3c4f5808-...", "email": "maria@cliente.com.br", "emailVerificado": false },
  "proximosPassos": { "acessarPlataforma": "https://app.radardocredito.com.br" }
}

A senha é do cliente final - peça a ela no seu fluxo. Ela trafega uma vez, não é guardada nem devolvida por nós, e você não deve armazená-la.

O e-mail tem de ser o do cliente: é para lá que vão o código de verificação e a recuperação de senha.

A apiKey devolvida aparece uma vez. Entregue ao cliente ou guarde em cofre no mesmo instante.

Se algo falhar no meio, repita a mesma chamada: é idempotente por CNPJ e nunca cria empresa duplicada.

POST /api/radar/v1/parceiro/clientes/{empresaId}/chaves X-Partner-Key

Emitir chave para um cliente

Gera uma chave de consulta nova para um cliente que você já cadastrou. Use para rotacionar uma chave suspeita, separar uma integração por ambiente ou repor a que o cliente perdeu.

Corpo

CampoObrigatórioTipoObservação
empresaIdsimstringNa URL. É o empresa.id devolvido no cadastro.
nomenãostringOnde a chave vai ser usada (ex.: "ERP produção"). Sem ele, fica identificada como emitida por parceiro.
Requisição
curl -X POST 'https://api.radardocredito.com.br/api/radar/v1/parceiro/clientes/9c1e8f3a-.../chaves'   -H 'Content-Type: application/json'   -H 'X-Partner-Key: SUA_CHAVE_DE_PARCEIRO'   --data '{ "nome": "ERP produção" }'
Resposta
{
  "apiKey": "ok_live_a1b2c3d4e5f6...",
  "id": "7f2c...",
  "nome": "ERP produção",
  "criadaEm": "2026-08-19T21:40:00.000Z"
}

A apiKey aparece uma vez - guardamos só o hash. Entregue ao cliente no mesmo instante.

Chaves não se substituem sozinhas: a antiga continua valendo até você revogar. Rotação é emitir a nova, trocar na integração e só então revogar a velha.

Só funciona para empresas que você cadastrou. Empresa de outro parceiro responde igual a empresa inexistente.

GET /api/radar/v1/parceiro/clientes/{empresaId}/chaves X-Partner-Key

Listar as chaves de um cliente

Quais chaves esse cliente tem, quando foram criadas, quando foram usadas pela última vez e quais já estão revogadas.

Requisição
curl 'https://api.radardocredito.com.br/api/radar/v1/parceiro/clientes/9c1e8f3a-.../chaves'   -H 'X-Partner-Key: SUA_CHAVE_DE_PARCEIRO'
Resposta
{
  "chaves": [
    {
      "id": "7f2c...",
      "nome": "ERP produção",
      "prefixo": "ok_live_a1b",
      "criadaEm": "2026-08-19T21:40:00.000Z",
      "ultimoUso": "2026-08-19T22:03:11.000Z",
      "revogadaEm": null
    }
  ]
}

A listagem devolve o prefixo, nunca a chave inteira - o segredo só existe no instante em que foi emitido.

ultimoUso em null com dias de criada é sinal de integração que nunca subiu.

DELETE /api/radar/v1/parceiro/clientes/{empresaId}/chaves/{chaveId} X-Partner-Key

Revogar a chave de um cliente

Desliga a chave na hora. Consultas com ela passam a ser recusadas; as outras chaves do cliente seguem valendo.

Requisição
curl -X DELETE 'https://api.radardocredito.com.br/api/radar/v1/parceiro/clientes/9c1e8f3a-.../chaves/7f2c...'   -H 'X-Partner-Key: SUA_CHAVE_DE_PARCEIRO'
Resposta
HTTP/1.1 204 No Content

É imediato e não tem volta: revogou, some. Para voltar a operar, emita outra.

Suspeitou de vazamento? Revogue primeiro e emita depois - chave vazada em uso custa crédito do seu cliente.

POST /api/radar/v1/parceiro/clientes X-Partner-Key

Criar conta dedicada para um cliente

Cria uma conta própria no Radar para cada cliente seu, operada só por você, com uma chave de consulta exclusiva. Você credita o saldo e a conta consome a cada consulta. Não envia e-mail nem cria usuário: ninguém do seu cliente acessa essa conta.

Corpo

CampoObrigatórioTipoObservação
referenciaExternasimstringO id do cliente no SEU sistema. É o que torna a chamada repetível sem duplicar.
nomesimstringNome da empresa, como aparece na conta.
cnpjsimstringCom ou sem máscara. Validado na Receita Federal.
Requisição
curl -X POST 'https://api.radardocredito.com.br/api/radar/v1/parceiro/clientes'   -H 'Content-Type: application/json'   -H 'X-Partner-Key: SUA_CHAVE_DE_PARCEIRO'   --data '{
    "referenciaExterna": "cliente-123",
    "nome": "Padaria Sol",
    "cnpj": "19.444.380/0001-81"
  }'
Resposta
{
  "empresa": {
    "id": "9c1e8f3a-...",
    "referenciaExterna": "cliente-123",
    "cnpj": "19444380000181",
    "ambiente": "producao"
  },
  "chave": {
    "id": "7f2c...",
    "apiKey": "ok_live_a1b2c3d4e5f6...",
    "criadaEm": "2026-11-10T15:00:00.000Z"
  }
}

A primeira chamada responde 201 com a chave, que aparece uma vez. Repetir com a mesma referenciaExterna responde 200 com a mesma empresa e sem chave: para ter outra, emita pela rota de chaves.

A conta é só sua, mesmo que o cliente já tenha conta própria no Radar com o mesmo CNPJ. As duas nunca se misturam e uma não gasta o saldo da outra.

A conta nasce em produção e cobra de verdade. Sem saldo creditado, a consulta responde 403.

A mesma referenciaExterna com outro CNPJ responde 409 referencia_em_uso.

Trocar a chave de parceiro não perde as contas. As contas são suas, não da chave. Peça ao suporte uma segunda chave do mesmo parceiro, troque nas suas integrações e só então peça a revogação da antiga.

GET /api/radar/v1/parceiro/clientes?referenciaExterna={id} X-Partner-Key

Encontrar uma conta dedicada

Devolve a conta pela referência do seu sistema. Use quando perder o id do Radar, por exemplo depois de restaurar um banco, sem criar outra.

Requisição
curl 'https://api.radardocredito.com.br/api/radar/v1/parceiro/clientes?referenciaExterna=cliente-123'   -H 'X-Partner-Key: SUA_CHAVE_DE_PARCEIRO'
Resposta
{
  "empresa": {
    "id": "9c1e8f3a-...",
    "referenciaExterna": "cliente-123",
    "cnpj": "19444380000181",
    "ambiente": "producao"
  }
}

Referência que não é de uma conta sua responde 404 cliente_nao_encontrado.

GET /api/radar/v1/parceiro/clientes/{empresaId}/saldo X-Partner-Key

Saldo de uma conta dedicada

Quantos créditos a conta tem agora, com até 6 casas decimais.

Requisição
curl 'https://api.radardocredito.com.br/api/radar/v1/parceiro/clientes/9c1e8f3a-.../saldo'   -H 'X-Partner-Key: SUA_CHAVE_DE_PARCEIRO'
Resposta
{
  "saldo": 0,
  "atualizadoEm": "2026-11-10T15:00:00.000Z"
}

Leia o saldo antes de creditar: credite só o que falta para cobrir a consulta. Sobra de uma consulta anterior é aproveitada na próxima.

Se a conta estiver em estado inválido a resposta é 503 conta_invalida, e você não deve creditar nem consultar até falar com o suporte.

Depois de criar a conta, confira na resposta da consulta que ambiente é producao e creditos.cobrado é true antes de usar o dado. Se vier simulado, aguarde alguns segundos e repita a consulta: a mudança de ambiente leva até 30 segundos para chegar a todos os servidores.

POST /api/radar/v1/parceiro/clientes/{empresaId}/creditos X-Partner-Key

Creditar uma conta dedicada

Adiciona créditos à conta. Cada consulta debita o valor de /custo; credite esse valor antes de consultar com a chave da conta.

Corpo

CampoObrigatórioTipoObservação
Idempotency-KeysimcabeçalhoAté 200 caracteres. A mesma chave com o mesmo pedido nunca credita duas vezes.
creditossimnúmeroMaior que zero, com até 6 casas decimais. Máximo de 1000 por chamada.
motivosimstringDe 10 a 200 caracteres. Fica registrado.
referencia.consultasimstringO id da consulta no seu sistema.
referencia.tiposimstring"pf" ou "pj".
Requisição
curl -X POST 'https://api.radardocredito.com.br/api/radar/v1/parceiro/clientes/9c1e8f3a-.../creditos'   -H 'Content-Type: application/json'   -H 'X-Partner-Key: SUA_CHAVE_DE_PARCEIRO'   -H 'Idempotency-Key: consulta-987-credito'   --data '{
    "creditos": 2.9,
    "motivo": "consulta_parceiro",
    "referencia": { "consulta": "consulta-987", "tipo": "pf" }
  }'
Resposta
{
  "lancamentoId": "0b7e5c1a-...",
  "saldo": 2.9
}

201 na concessão nova e 200 na repetição da mesma Idempotency-Key, com o mesmo lancamentoId. A mesma chave com outro pedido, ou usada em outra empresa, responde 422 idempotencia_conflito: a chave vale para a sua chave de parceiro inteira, não por empresa.

Não recebeu resposta, ou veio 503? Repita com a mesma Idempotency-Key. Ela nunca credita em dobro. Gerar uma chave nova pode creditar duas vezes.

Acima do teto por chamada: 422 valor_acima_do_teto. Valor zero, negativo ou com mais de 6 casas: 422 valor_invalido.

409 credito_a_conferir significa que não foi possível confirmar se este crédito já entrou. Confira o extrato antes de repetir com outra chave.

O lancamentoId é o id da linha de concessão no extrato.

GET /api/radar/v1/parceiro/clientes/{empresaId}/extrato X-Partner-Key

Extrato de uma conta dedicada

Cada crédito concedido, cada consulta cobrada e cada estorno, para você conciliar com o seu sistema. Do mais novo para o mais antigo.

Corpo

CampoObrigatórioTipoObservação
denãostringData ou data e hora inicial (ISO 8601).
atenãostringData ou data e hora final (ISO 8601).
paginanãonúmeroA partir de 1.
limitenãonúmeroDe 1 a 200.
Requisição
curl 'https://api.radardocredito.com.br/api/radar/v1/parceiro/clientes/9c1e8f3a-.../extrato?de=2026-11-01&limite=50'   -H 'X-Partner-Key: SUA_CHAVE_DE_PARCEIRO'
Resposta
{
  "itens": [
    {
      "id": "7a4c9e12-...",
      "tipo": "consumo",
      "creditos": 2.9,
      "consultaId": "5d8f2a41-...",
      "referencia": null,
      "ocorridoEm": "2026-11-10T15:00:00.000Z"
    },
    {
      "id": "0b7e5c1a-...",
      "tipo": "concessao",
      "creditos": 2.9,
      "consultaId": null,
      "referencia": { "consulta": "consulta-987", "tipo": "pf" },
      "ocorridoEm": "2026-11-10T14:59:58.000Z"
    }
  ],
  "total": 2,
  "pagina": 1,
  "limite": 50
}

tipo é concessao, consumo ou estorno. O valor é sempre positivo: o tipo diz o sentido.

O consultaId do consumo e do estorno é o mesmo consulta.id que a resposta da consulta devolve. Estorno aponta para a consulta que desfaz.

Uma consulta pode ter consumo sem concessão própria: quando já havia saldo, você não precisa creditar de novo. Isso é normal.

Ajustes manuais feitos pelo suporte não aparecem aqui, e total pode ser maior que a soma de itens por isso. Em caso de divergência com o saldo, fale com o suporte.

Cada cliente criado tem saldo e cobrança próprios: a consulta dele debita do saldo dele, não do seu.

Erros

Todo erro traz um code estável. Programe contra o code - a message é para humanos e pode mudar de texto.

{ "code": "cnpj_invalido", "message": "O dígito verificador do CNPJ não confere." }
HTTPcodeQuando
401parceiro_nao_autorizadoChave de parceiro ausente, inválida ou revogada.
400documento_invalidoCPF ou CNPJ com dígito verificador inválido.
400cnpj_invalidoDígito verificador não fecha - provável erro de digitação.
404cnpj_inexistenteCNPJ não encontrado na base da Receita Federal.
409cnpj_situacao_irregularEmpresa baixada, inapta ou suspensa. A situação vem na mensagem.
409cnpj_ja_cadastradoJá existe conta para esse CNPJ.
409email_ja_verificadoO e-mail já pertence a uma conta ativa.
402INSUFFICIENT_CREDITSSaldo insuficiente. A resposta traz um link de compra.
429-Limite de requisições. Espere antes de tentar de novo.
502provider_errorA fonte não respondeu. O crédito é estornado automaticamente.
503authify_indisponivelCadastro temporariamente fora. Nada foi criado; pode repetir.
404cliente_nao_encontradoA empresa não é uma conta sua (ou não existe).
409referencia_em_usoEssa referência já pertence a outra empresa (outro CNPJ).
400idempotency_key_ausenteFalta o cabeçalho Idempotency-Key, ou passa de 200 caracteres.
422valor_invalidoCrédito zero, negativo ou com mais de 6 casas decimais.
422valor_acima_do_tetoCrédito acima do teto por chamada.
422idempotencia_conflitoEssa Idempotency-Key já foi usada com outro pedido.
422periodo_invalidoA data inicial do extrato é depois da final.
409credito_a_conferirNão foi possível confirmar se o crédito entrou. Confira o extrato.
503creditos_indisponivelSaldo e créditos temporariamente fora. Pode repetir.
503conta_invalidaA conta está em estado inválido. Fale com o suporte.

Limites

OperaçãoLimite
Consulta60 por minuto, por chave
Cadastro de cliente (parceiro)30 por minuto, por chave
Conta dedicada: criar60 por minuto, por origem da chamada
Conta dedicada: saldo e crédito600 por minuto, por origem da chamada
Conta dedicada: extrato120 por minuto, por origem da chamada

Precisa de ajuda?

Fale com a gente no WhatsApp 11 5126 0852 ou pelo 11 5126 0852. Seg a sex, 9h às 18h.