Pular para o conteúdo

API

Coloque o dado
dentro do seu fluxo

Uma rota para todo o catálogo, autenticação por token e resposta normalizada em JSON. Da primeira chamada até produção, sem reunião no meio.

Começar em 5 minutos Ver a referência
primeira chamada 
curl -X POST https://api.radardata.com.br/api/v2/kyc-estendido \
  -H "Authorization: Bearer $RADARDATA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"documento":"52998224725"}'

Primeiros passos

Três passos
até a primeira resposta

  1. Crie a conta e gere um token

    No painel, em Tokens, você cria a chave, escolhe o ambiente (produção ou teste) e os escopos. O valor aparece uma vez só.

    export RADARDATA_TOKEN="cole_aqui_o_token_gerado_no_painel"

  2. Chame a consulta

    Todas as consultas usam a mesma rota e o mesmo corpo. O que muda é o identificador no fim do caminho.

    curl -X POST https://api.radardata.com.br/api/v2/kyc-estendido \
  -H "Authorization: Bearer $RADARDATA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"documento":"52998224725"}'

  3. Leia a resposta

    Sucesso vem em data e meta. Em meta chegam o identificador da consulta, o preço debitado e o saldo que sobrou.

    {
  "data": {
    "_id": "52998224725",
    "name": "FULANO DE TAL SANDBOX",
    "document": "52998224725",
    "age": 34,
    "isAdult": true,
    "isAlive": true,
    "cpfStatus": "REGULAR",
    "birthDate": "1990-01-01T00:00:00Z"
  },
  "meta": {
    "consulta_id": "0199c8f2-6b1e-7c3a-9d4f-2a5b8e7c1d90",
    "saldo": 48750,
    "preco": 11,
    "sandbox": false
  }
}

O que vem junto

Pensada para
quem integra

Token com escopo

Cada token faz só o que o escopo permite: consultas, verificação, análises ou apenas leitura. Token que vaza não alcança o resto.

Ambiente de teste

Token de teste devolve dado simulado no mesmo formato da resposta real e não gasta saldo.

Idempotência

Mande o cabeçalho Idempotency-Key e repita sem medo depois de um timeout: a mesma consulta não é cobrada duas vezes.

Teto de gasto e IP permitido

Limite quanto um token pode gastar e de quais endereços ele pode chamar. Validade opcional por token.

Erro que explica

Código HTTP coerente e um campo code estável. Você trata por código, não por texto de mensagem.

Catálogo e saldo por API

Liste as consultas disponíveis e o seu saldo por rota própria, e baixe a especificação OpenAPI da sua conta.

Rotas

Poucas rotas,
fáceis de lembrar

  • POST /api/v2/{slug} Executa uma consulta do catálogo.
  • GET /api/v2/servicos Lista as consultas liberadas e o preço de cada uma.
  • GET /api/v2/saldo Devolve o saldo da conta.
  • GET /api/v2/openapi.json A especificação OpenAPI da sua conta.
  • POST /api/v2/verify/sessions Abre uma sessão de verificação de identidade.

Tratamento de erro

Falha também
é contrato

O código HTTP e o campo code são estáveis. Você trata por código, não por texto. Consulta que falha não debita saldo.

Ver todos os erros 
// 422: documento inválido
{ "error": { "code": "documento_invalido", "message": "CPF inválido." } }

// 401: token ausente, inválido ou expirado
{ "error": { "code": "token_invalido",
             "message": "Token de API inválido ou expirado." } }

// 403: o token não tem o escopo da operação
{ "error": { "code": "escopo_insuficiente", "message": "..." } }

// 402: saldo insuficiente
{ "error": { "code": "sem_saldo",
             "message": "Saldo insuficiente para esta consulta." } }

Gere seu token
e faça a primeira chamada

A conta é gratuita e o ambiente de teste não gasta saldo.

Criar conta Ler a documentação