Cobrativa

Cobrativa API

Consultas por API integradas ao seu negócio

Receba dados de consultas em JSON no seu CRM, ERP ou aplicativo. Automatize verificações e acompanhe as chamadas pelo painel.

Criar contaVer documentação
api.cobrativa.com.br
POST/v1/consultas/{slug}

Requisição

{
  "cpf": "12345678909"
}
AutenticaçãoBearer
AmbienteHomologação
FormatoJSON

Resposta

200 OK
{
  "id": "request-id",
  "status": "sucesso",
  "ambiente": "homologacao",
  "produto": {
    "versao": "1"
  },
  "cobranca": {
    "valor": 0,
    "moeda": "BRL"
  },
  "dados": { "resultado": "..." }
}
Exemplo de requisição e resposta em homologação.
  • Uma única API JSON
  • Homologação sem custo
  • Produção com saldo pré-pago
  • Respostas síncronas e assíncronas

Casos de uso

Consultas para
o seu sistema

Use os dados retornados pela API nas tarefas que sua empresa já realiza ou nos produtos que está desenvolvendo. Você define como exibir e combinar as informações.

  • CRMs e ERPs

    Com a API, sua equipe pode consultar dados no próprio CRM ou ERP, sem alternar entre painéis ou repetir cadastros.

  • Validação de cadastros

    Sua aplicação pode conferir CPF, CNPJ e outros dados automaticamente durante o cadastro, o onboarding, as análises e as atualizações.

  • Análise e decisão

    Alimente regras internas e esteiras de crédito com os resultados das consultas. Use-os também em alertas e revisões manuais.

  • Relatórios com sua marca

    Os dados da API podem compor telas, documentos e relatórios com a identidade visual da sua empresa.

  • Revenda e white label

    Ofereça consultas na sua própria solução com a estrutura de resposta da Cobrativa, sem expor as integrações internas.

  • Consultas recorrentes

    Programe consultas recorrentes e lotes controlados. Automatize tarefas que hoje dependem de trabalho manual.

Como funciona

Veja como funciona
em 4 passos

Comece com os testes em homologação. Depois, configure o acesso ao ambiente de produção.

  1. Etapa 01

    Crie sua conta

    Cadastre-se no painel e consulte o catálogo de produtos disponíveis para integrar.

  2. Etapa 02

    Gere a chave de homologação

    Use sua chave de homologação para testar autenticação, validações e respostas. Os exemplos são estáveis e não consomem saldo.

  3. Etapa 03

    Conecte seu sistema

    Envie as consultas em JSON por HTTPS. A estrutura das respostas é a mesma nos testes e em produção.

  4. Etapa 04

    Ative a produção

    Adicione saldo e solicite sua chave de produção. O painel mostra as chamadas realizadas e seus custos.

Demonstração

Conheça a API
na prática

Veja o painel, as consultas disponíveis e os exemplos de requisições e respostas. Use os capítulos para escolher o assunto que deseja assistir.

Respostas em JSON

Veja como os dados
são retornados

A API retorna status, ambiente, produto, cobrança e links de acompanhamento nos mesmos campos. O resultado específico de cada consulta fica no campo dados.

response.jsonapplication/json
{
  "id": "request-id",
  "status": "sucesso",
  "ambiente": "producao",
  "produto": {
    "codigo": 3001,
    "slug": "consulta-escolhida",
    "nome": "Consulta escolhida",
    "versao": "1"
  },
  "cobranca": {
    "valor": 9.90,
    "moeda": "BRL"
  },
  "processado_em": "2026-09-16T14:30:00.000Z",
  "dados": { "resultado": "..." },
  "_links": {
    "resultado": "/v1/resultados/request-id"
  }
}

  • Estrutura padronizada

    Encontre os metadados da consulta sempre nos mesmos campos.

  • Idempotency-Key

    Reenvie uma requisição sem duplicar a operação lógica.

  • Produto e versão

    Identifique o produto consultado e a versão usada na resposta.

  • Dados do produto

    Leia o resultado específico da consulta no campo dados.

Ver documentação

Operação controlada

Mais controle sobre suas consultas

Use chaves separadas para testes e produção. O painel reúne o histórico de consultas e o consumo de saldo.

  • Chaves separadas

    Use uma chave para homologação e outra para produção. Assim, os testes ficam separados das consultas reais.

  • Idempotência

    Repita a mesma operação lógica sem gerar outra consulta nem uma cobrança duplicada.

  • Consumo de saldo

    O valor fica reservado durante o processamento. O débito ocorre no sucesso; em falhas técnicas, a reserva é liberada.

  • Síncrono e assíncrono

    Receba resultados imediatos ou acompanhe consultas que levam mais tempo, com a mesma estrutura de resposta.

  • Histórico de consultas

    Confira no painel as consultas feitas em homologação e produção.

  • Status dos serviços

    Consulte a disponibilidade dos produtos na página pública de status antes de investigar uma falha.

Testes e cobrança

Teste sem custo. Pague pelas consultas em produção.

Valide as chamadas em homologação. A cobrança ocorre nas consultas concluídas com sucesso em produção.

Sem custo

Homologação

Teste antes de usar saldo

O ambiente de homologação usa exemplos estáveis. Confira os campos, os códigos HTTP e o histórico das chamadas sem consumir saldo de produção.

Pré-pago

Produção

Saldo pré-pago por consulta

Adicione saldo à conta para fazer consultas em produção. Cada produto tem seu preço, informado no catálogo disponível para sua conta.

Dúvidas frequentes

Dúvidas sobre a API?

Entenda os detalhes dos testes e do uso em produção.

Precisa de ajuda?

Fale com a equipe pelo WhatsApp.

Falar com a equipeVer documentação

Não. Em homologação, as consultas usam exemplos estáveis e não consomem saldo. Você pode testar a autenticação, a validação dos campos, o limite de requisições e a idempotência, além de conferir o histórico.

Comece pela homologação

Pronto para integrar a Cobrativa?

Crie sua conta para gerar a chave de homologação. A documentação explica como enviar a primeira consulta.

Criar contaVer documentação