API HTTP · JSON · v1
Uma integração para todas as consultas Cobrativa
Consulte os produtos Cobrativa por uma API HTTP com autenticação, cobrança e respostas JSON padronizadas para facilitar a integração da sua aplicação.
JSON
Formato único
Requisições e respostas seguem JSON.
Grátis
Homologação
Fixtures estáveis, sem chamada externa.
Atômica
Cobrança segura
Reserva, débito ou liberação automática.
01
Primeiros passos
O fluxo básico tem quatro etapas e pode ser validado por completo sem consumir saldo.
- 1Gere uma chave
Crie uma chave de homologação em Chaves de API.
- 2Escolha o produto
Consulte slug, parâmetros e exemplo nesta referência.
- 3Envie o POST
Use Authorization Bearer e um Idempotency-Key único.
- 4Leia o envelope
A API espera até 20 segundos; trate 200, 202 e os erros HTTP documentados.
02
Ambientes e URLs
Os dois ambientes usam o mesmo corpo e o mesmo envelope. Somente a URL e o prefixo da chave mudam.
Verificando acesso aos ambientes…
03
Autenticação
Envie a chave no cabeçalho HTTP. O servidor identifica sua conta e impede o uso de uma chave no ambiente errado.
http
Authorization: Bearer SUA_CHAVE_COMPLETA_DE_HOMOLOGACAO
Content-Type: application/json
Idempotency-Key: pedido-123Mantenha a chave no servidor
Nunca coloque uma chave de produção em JavaScript entregue ao navegador, aplicativos distribuídos ou repositórios públicos.
04
Realizar uma consulta
Use o slug do produto na URL e envie no corpo somente os parâmetros declarados no catálogo.
Compatível com qualquer tecnologia
A Cobrativa é uma API HTTP com JSON. cURL, JavaScript, PHP, Python, Java, C#, Postman, n8n e outras ferramentas usam os mesmos endpoints. Os códigos abaixo são apenas exemplos de integração.
Verificando acesso aos ambientes…
05
Idempotência e respostas assíncronas
Idempotency-Key
Gere uma chave para cada operação lógica. Se a conexão cair sem resposta HTTP, repita o POST com a mesma chave: a API devolve a execução existente sem cobrar novamente.
Espera híbrida
Por padrão, o POST aguarda até 20 segundos pelo resultado. Use Prefer: wait=N para escolher de 0 a 25 segundos ou Prefer: respond-async para não aguardar.
Quando a API responder HTTP 202
A execução foi aceita, mas ainda não terminou. Não envie outro POST. Aguarde o valor de
Retry-After e faça GET no endereço de _links.resultado com a mesma chave de API. Repita esse GET enquanto ele responder 202.json
{
"id": "request-id",
"status": "processando",
"ambiente": "producao",
"produto": {
"codigo": 3001,
"slug": "ic-cpf-completo",
"versao": "1"
},
"cobranca": {
"estado": "reservada",
"moeda": "BRL"
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}06
Envelope de resposta
O envelope é estável. Apenas dados é específico de cada produto e evolui segundo produto.versao.
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3001,
"slug": "ic-cpf-completo",
"nome": "Busca pelo Documento",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"emails": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"email": "exemplo@empresa.com.br",
"posicao": null
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"email": "exemplo@empresa.com.br",
"posicao": null
}
],
"filiais": [],
"documento": "12345678909",
"enderecos": [
{
"id": "EXEMPLO",
"uf": "SP",
"_id": "EXEMPLO",
"cep": "01001000",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"numero": "EXEMPLO",
"posicao": null,
"logradouro": "AVENIDA EXEMPLO, 100",
"complemento": "EXEMPLO",
"tipoLogradouro": "AVENIDA EXEMPLO, 100"
},
{
"id": "EXEMPLO",
"uf": "SP",
"_id": "EXEMPLO",
"cep": "01001000",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"numero": "EXEMPLO",
"posicao": null,
"logradouro": "AVENIDA EXEMPLO, 100",
"complemento": "EXEMPLO",
"tipoLogradouro": "AVENIDA EXEMPLO, 100"
}
],
"telefones": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"ddd": "EXEMPLO",
"tipo": "EXEMPLO",
"posicao": null,
"telefone": "11999999999"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"ddd": "EXEMPLO",
"tipo": "EXEMPLO",
"posicao": null,
"telefone": "11999999999"
}
],
"rendaPresumida": "12345678000195",
"dadosCadastrais": {
"rg": "EXEMPLO",
"nome": "PESSOA EXEMPLO",
"sexo": "EXEMPLO",
"ufRg": null,
"email": null,
"idade": "EXEMPLO",
"signo": "EXEMPLO",
"cpfMae": null,
"endCep": null,
"endNum": null,
"telDdd": "EXEMPLO",
"telNum": "EXEMPLO",
"nomeMae": "PESSOA EXEMPLO",
"documento": "12345678909",
"endBairro": null,
"endCidade": null,
"endEstado": null,
"faixaIdade": null,
"situacaoCpf": "12345678909",
"endLogradouro": "AVENIDA EXEMPLO, 100",
"tituloEleitor": null,
"dataNascimento": "2026-01-15",
"endComplemento": null,
"dataSituacaoCpf": null,
"endTipoLogradouro": null
},
"participacoesSocietarias": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"nome": "PESSOA EXEMPLO",
"posicao": null,
"dataSaida": null,
"documento": "12345678000195",
"dataEntrada": "2026-01-15",
"participacao": "EXEMPLO",
"qualificacaoSocio": null,
"representanteLegal": null
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"nome": "PESSOA EXEMPLO",
"posicao": null,
"dataSaida": null,
"documento": "12345678000195",
"dataEntrada": "2026-01-15",
"participacao": "EXEMPLO",
"qualificacaoSocio": null,
"representanteLegal": null
}
]
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Sucesso válido
Dados encontrados e “nada consta” são resultados válidos e cobrados em produção.
Falha técnica
Falhas técnicas ou indisponibilidade não debitam o cliente.
07
Produtos e exemplos JSON
Esta lista vem do mesmo catálogo usado pela API. Cada produto contém o corpo de exemplo e o JSON que homologação retorna.
3001Busca pelo Documento
CadastralConsulta cadastral por CPF com identificação, filiação, contatos, renda presumida e vínculos empresariais quando disponíveis.
Contrato v1
3001
Busca pelo Documento
CadastralConsulta cadastral por CPF com identificação, filiação, contatos, renda presumida e vínculos empresariais quando disponíveis.
Parâmetros
cpf *Requisição
json
{
"cpf": "12345678909"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3001,
"slug": "ic-cpf-completo",
"nome": "Busca pelo Documento",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"emails": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"email": "exemplo@empresa.com.br",
"posicao": null
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"email": "exemplo@empresa.com.br",
"posicao": null
}
],
"filiais": [],
"documento": "12345678909",
"enderecos": [
{
"id": "EXEMPLO",
"uf": "SP",
"_id": "EXEMPLO",
"cep": "01001000",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"numero": "EXEMPLO",
"posicao": null,
"logradouro": "AVENIDA EXEMPLO, 100",
"complemento": "EXEMPLO",
"tipoLogradouro": "AVENIDA EXEMPLO, 100"
},
{
"id": "EXEMPLO",
"uf": "SP",
"_id": "EXEMPLO",
"cep": "01001000",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"numero": "EXEMPLO",
"posicao": null,
"logradouro": "AVENIDA EXEMPLO, 100",
"complemento": "EXEMPLO",
"tipoLogradouro": "AVENIDA EXEMPLO, 100"
}
],
"telefones": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"ddd": "EXEMPLO",
"tipo": "EXEMPLO",
"posicao": null,
"telefone": "11999999999"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"ddd": "EXEMPLO",
"tipo": "EXEMPLO",
"posicao": null,
"telefone": "11999999999"
}
],
"rendaPresumida": "12345678000195",
"dadosCadastrais": {
"rg": "EXEMPLO",
"nome": "PESSOA EXEMPLO",
"sexo": "EXEMPLO",
"ufRg": null,
"email": null,
"idade": "EXEMPLO",
"signo": "EXEMPLO",
"cpfMae": null,
"endCep": null,
"endNum": null,
"telDdd": "EXEMPLO",
"telNum": "EXEMPLO",
"nomeMae": "PESSOA EXEMPLO",
"documento": "12345678909",
"endBairro": null,
"endCidade": null,
"endEstado": null,
"faixaIdade": null,
"situacaoCpf": "12345678909",
"endLogradouro": "AVENIDA EXEMPLO, 100",
"tituloEleitor": null,
"dataNascimento": "2026-01-15",
"endComplemento": null,
"dataSituacaoCpf": null,
"endTipoLogradouro": null
},
"participacoesSocietarias": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"nome": "PESSOA EXEMPLO",
"posicao": null,
"dataSaida": null,
"documento": "12345678000195",
"dataEntrada": "2026-01-15",
"participacao": "EXEMPLO",
"qualificacaoSocio": null,
"representanteLegal": null
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"nome": "PESSOA EXEMPLO",
"posicao": null,
"dataSaida": null,
"documento": "12345678000195",
"dataEntrada": "2026-01-15",
"participacao": "EXEMPLO",
"qualificacaoSocio": null,
"representanteLegal": null
}
]
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3002Busca pelo Nome
CadastralLocaliza possíveis pessoas relacionadas ao nome e, quando informado, ao endereço pesquisado.
Contrato v1
3002
Busca pelo Nome
CadastralLocaliza possíveis pessoas relacionadas ao nome e, quando informado, ao endereço pesquisado.
Parâmetros
nome *Requisição
json
{
"nome": "Digite o nome completo"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3002,
"slug": "busca-nome",
"nome": "Busca pelo Nome",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"persons": [
{
"uf": "SP",
"nome": "PESSOA EXEMPLO",
"cidade": "SAO PAULO",
"numero": null,
"documento": "12345678909",
"dataNascimento": 1
},
{
"uf": "SP",
"nome": "PESSOA EXEMPLO",
"cidade": "SAO PAULO",
"numero": null,
"documento": "12345678909",
"dataNascimento": 1
}
]
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3003Busca pelo Telefone
CadastralLocaliza possíveis pessoas relacionadas ao telefone informado, com dados cadastrais básicos quando disponíveis.
Contrato v1
3003
Busca pelo Telefone
CadastralLocaliza possíveis pessoas relacionadas ao telefone informado, com dados cadastrais básicos quando disponíveis.
Parâmetros
telefone *Requisição
json
{
"telefone": "11999999999"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3003,
"slug": "busca-documentos-telefone",
"nome": "Busca pelo Telefone",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"persons": [
{
"uf": "SP",
"nome": "PESSOA EXEMPLO",
"tipo": "EXEMPLO",
"cidade": "SAO PAULO",
"documento": "12345678909",
"dataNascimento": "2026-01-15",
"pessoaRelacionada": null
},
{
"uf": "SP",
"nome": "PESSOA EXEMPLO",
"tipo": "EXEMPLO",
"cidade": "SAO PAULO",
"documento": "12345678909",
"dataNascimento": "2026-01-15",
"pessoaRelacionada": null
}
],
"searchKey": "12345678909",
"searchKeyType": "EXEMPLO"
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3004Busca por CNPJ
CadastralCadastro básico de empresa com identificação, atividade econômica, endereços e telefones localizados.
Contrato v1
3004
Busca por CNPJ
CadastralCadastro básico de empresa com identificação, atividade econômica, endereços e telefones localizados.
Parâmetros
cnpj *Requisição
json
{
"cnpj": "12345678000195"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3004,
"slug": "busca-cnpj",
"nome": "Busca por CNPJ",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"emails": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"email": "exemplo@empresa.com.br",
"posicao": null
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"email": "exemplo@empresa.com.br",
"posicao": null
}
],
"documento": "12345678000195",
"enderecos": [
{
"id": "EXEMPLO",
"uf": "SP",
"_id": "EXEMPLO",
"cep": "01001000",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"numero": "EXEMPLO",
"posicao": null,
"logradouro": "AVENIDA EXEMPLO, 100",
"complemento": null,
"tipoLogradouro": "AVENIDA EXEMPLO, 100"
}
],
"telefones": [
{
"id": "12345678909",
"_id": "12345678909",
"ddd": "EXEMPLO",
"tipo": "EXEMPLO",
"posicao": null,
"telefone": "11999999999"
},
{
"id": "12345678909",
"_id": "12345678909",
"ddd": "EXEMPLO",
"tipo": "EXEMPLO",
"posicao": null,
"telefone": "11999999999"
}
],
"dadosCadastrais": {
"endCep": null,
"endNum": null,
"endBairro": null,
"endCidade": null,
"endEstado": null,
"codigoCnae": "1",
"razaoSocial": "EMPRESA EXEMPLO LTDA",
"dataAbertura": "2026-01-15",
"dataFundacao": null,
"nomeFantasia": null,
"descricaoCnae": "Informação de exemplo",
"endLogradouro": null,
"endComplemento": null,
"endTipoLogradouro": null
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3005Busca por E-mail
CadastralBusca possíveis pessoas relacionadas ao e-mail informado quando houver vínculo nas bases consultadas.
Contrato v1
3005
Busca por E-mail
CadastralBusca possíveis pessoas relacionadas ao e-mail informado quando houver vínculo nas bases consultadas.
Parâmetros
email *Requisição
json
{
"email": "nome@dominio.com.br"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3005,
"slug": "busca-email",
"nome": "Busca por E-mail",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"persons": [
{
"uf": "SP",
"nome": "PESSOA EXEMPLO",
"idade": "EXEMPLO",
"cidade": "SAO PAULO",
"nomeMae": null,
"telefone": null,
"documento": "12345678909",
"veiculoPlaca": null,
"veiculoModelo": null
},
{
"uf": "SP",
"nome": "PESSOA EXEMPLO",
"idade": "EXEMPLO",
"cidade": "SAO PAULO",
"nomeMae": null,
"telefone": null,
"documento": "12345678909",
"veiculoPlaca": null,
"veiculoModelo": null
}
],
"searchKey": "EXEMPLO",
"searchKeyType": "EXEMPLO"
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3006MAX Brasil Avançado CNPJ
CNPJAnálise aprofundada de empresa com score, cadastro, contatos, quadro societário, indicadores de risco, restrições financeiras, protestos e processos judiciais.
Contrato v1
3006
MAX Brasil Avançado CNPJ
CNPJAnálise aprofundada de empresa com score, cadastro, contatos, quadro societário, indicadores de risco, restrições financeiras, protestos e processos judiciais.
Parâmetros
cnpj *Requisição
json
{
"cnpj": "12345678000195"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3006,
"slug": "analise-360-avancada-cnpj",
"nome": "MAX Brasil Avançado CNPJ",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"protestos": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"situacao": null,
"cartorios": [],
"dataConsulta": "2026-01-15",
"valorTotalProtestado": null
}
],
"apontamentos": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"nome": "PESSOA EXEMPLO",
"vara": "EXEMPLO",
"forum": "EXEMPLO",
"cidade": "SAO PAULO",
"estado": "SP",
"comarca": "EXEMPLO",
"cpfCnpj": "12345678000195",
"idRegistro": null,
"confiancaId": null,
"fonteOrigem": null,
"tipoJustica": "EXEMPLO",
"tipoEntidade": null,
"tipoProcesso": "EXEMPLO",
"tipoRegistro": null,
"autorProcesso": "EXEMPLO",
"valorProcesso": 123.45,
"dataProcessada": "2026-01-15",
"numeroProcesso": "EXEMPLO",
"numeroProtocolo": null,
"dataDistribuicao": "2026-01-15",
"indiceSimilaridade": null
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"nome": "PESSOA EXEMPLO",
"vara": "EXEMPLO",
"forum": "EXEMPLO",
"cidade": "SAO PAULO",
"estado": "SP",
"comarca": "EXEMPLO",
"cpfCnpj": "12345678000195",
"idRegistro": null,
"confiancaId": null,
"fonteOrigem": null,
"tipoJustica": "EXEMPLO",
"tipoEntidade": null,
"tipoProcesso": "EXEMPLO",
"tipoRegistro": null,
"autorProcesso": "EXEMPLO",
"valorProcesso": 123.45,
"dataProcessada": "2026-01-15",
"numeroProcesso": "EXEMPLO",
"numeroProtocolo": null,
"dataDistribuicao": "2026-01-15",
"indiceSimilaridade": null
}
],
"indicacoesPJ": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"cor": "EXEMPLO",
"nome": "PESSOA EXEMPLO",
"categoria": "EXEMPLO",
"descricao": "Informação de exemplo",
"interpretacao": "EXEMPLO"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"cor": "EXEMPLO",
"nome": "PESSOA EXEMPLO",
"categoria": "EXEMPLO",
"descricao": "Informação de exemplo",
"interpretacao": "EXEMPLO"
}
],
"scoreCredito": {
"tipo": "EXEMPLO",
"score": 750,
"razoes": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"codigo": "1",
"mensagem": null
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"codigo": "1",
"mensagem": null
}
],
"perfilScore": null,
"riscoDeCredito": "BAIXO",
"riscoCreditoMensagem": "BAIXO",
"probabilidadeDePagamento": "EXEMPLO",
"pontuacaoCompromissoPagamento": null,
"probabilidadeDePagamentoMensagem": "Informação de exemplo"
},
"resumoCredito": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"valor": 123.45,
"descricao": "Informação de exemplo",
"dataUltimo": "2026-01-15",
"quantidade": 35,
"dataPrimeiro": "2026-01-15"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"valor": 123.45,
"descricao": "Informação de exemplo",
"dataUltimo": null,
"quantidade": 35,
"dataPrimeiro": null
}
],
"historicoEmail": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"email": "exemplo@empresa.com.br",
"itemUltimaAtualizacao": "EXEMPLO"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"email": "exemplo@empresa.com.br",
"itemUltimaAtualizacao": "EXEMPLO"
}
],
"protestosVecPj": {
"ext": "12345678000195",
"registros": [
{
"id": "12345678000195",
"uf": "SP",
"_id": "12345678000195",
"data": "",
"tipo": "EXEMPLO",
"moeda": "EXEMPLO",
"valor": "EXEMPLO",
"cidade": "SAO PAULO",
"cartorio": "EXEMPLO",
"contrato": null,
"endereco": "AVENIDA EXEMPLO, 100",
"natureza": null
},
{
"id": "12345678000195",
"uf": "SP",
"_id": "12345678000195",
"data": "",
"tipo": "EXEMPLO",
"moeda": "EXEMPLO",
"valor": "EXEMPLO",
"cidade": "SAO PAULO",
"cartorio": "EXEMPLO",
"contrato": null,
"endereco": "AVENIDA EXEMPLO, 100",
"natureza": null
}
],
"valorTotal": "EXEMPLO",
"numRegistros": 1,
"ocorrenciaMaisAntiga": null,
"ocorrenciaMaisRecente": null
},
"historicoNumero": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"numero": "EXEMPLO",
"itemUltimaAtualizacao": "EXEMPLO"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"numero": "12345678909",
"itemUltimaAtualizacao": "EXEMPLO"
}
],
"participantesPJ": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"nome": "PESSOA EXEMPLO",
"status": "REGULAR",
"cpfCnpj": "12345678000195",
"tipoEntidade": "EXEMPLO",
"dataReferencia": "2026-01-15",
"dataInicioSocio": "2026-01-15",
"nivelDeConfianca": "EXEMPLO",
"valorParticipacao": "EXEMPLO",
"flagCargoPrincipal": "EXEMPLO",
"flagDadosNegativos": "EXEMPLO",
"percentualParticipacao": "EXEMPLO",
"descricaoDeRelacionamento": "PESSOA EXEMPLO"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"nome": "PESSOA EXEMPLO",
"status": null,
"cpfCnpj": "12345678000195",
"tipoEntidade": "EXEMPLO",
"dataReferencia": "2026-01-15",
"dataInicioSocio": "2026-01-15",
"nivelDeConfianca": "EXEMPLO",
"valorParticipacao": "EXEMPLO",
"flagCargoPrincipal": "EXEMPLO",
"flagDadosNegativos": "EXEMPLO",
"percentualParticipacao": "EXEMPLO",
"descricaoDeRelacionamento": "PESSOA EXEMPLO"
}
],
"chequesSemFundos": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"cpfCnpj": "12345678000195",
"nomeBanco": "PESSOA EXEMPLO",
"tipoEntidade": "EXEMPLO",
"motivoDevolucao": "Informação de exemplo",
"dataUltimaDevolucao": "2026-01-15",
"quantidadeDevolucoes": 35,
"codigoBancoReportante": "1",
"prefixoAgenciaReportante": "EXEMPLO"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"cpfCnpj": "12345678000195",
"nomeBanco": "PESSOA EXEMPLO",
"tipoEntidade": "EXEMPLO",
"motivoDevolucao": "Informação de exemplo",
"dataUltimaDevolucao": "2026-01-15",
"quantidadeDevolucoes": 35,
"codigoBancoReportante": "1",
"prefixoAgenciaReportante": "EXEMPLO"
}
],
"processoJudicial": {
"acoesJudiciais": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"juiz": null,
"tipo": "EXEMPLO",
"valor": "EXEMPLO",
"estado": "SP",
"numero": "EXEMPLO",
"status": "REGULAR",
"decisoes": [],
"peticoes": [],
"dataAviso": "2026-01-15T12:00:00Z",
"envolvidos": [
{
"_id": "EXEMPLO",
"nome": "PESSOA EXEMPLO",
"tipo": "EXEMPLO",
"documento": "12345678000195",
"parteAtiva": true,
"polaridade": "EXEMPLO",
"dataUltimaCaptura": "2026-01-15T12:00:00Z",
"detalhesEnvolvido": {
"OAB": null,
"estado": null,
"tipoEspecifico": "EXEMPLO"
}
},
{
"_id": "EXEMPLO",
"nome": "PESSOA EXEMPLO",
"tipo": "EXEMPLO",
"documento": "12345678000195",
"parteAtiva": true,
"polaridade": "EXEMPLO",
"dataUltimaCaptura": "2026-01-15T12:00:00Z",
"detalhesEnvolvido": {
"OAB": null,
"estado": null,
"tipoEspecifico": "EXEMPLO"
}
}
],
"dataCaptura": "2026-01-15T12:00:00Z",
"atualizacoes": [],
"corpoJulgado": "EXEMPLO",
"nomeTribunal": "PESSOA EXEMPLO",
"numeroPartes": "EXEMPLO",
"tipoTribunal": "EXEMPLO",
"numeroPaginas": null,
"numeroVolumes": null,
"dataPublicacao": "2026-01-15T12:00:00Z",
"outrosAssuntos": [
"EXEMPLO"
],
"numeroInstancia": "EXEMPLO",
"resDataJudicata": "2026-01-15T12:00:00Z",
"assuntoPrincipal": "EXEMPLO",
"dataEncerramento": "2026-01-15T12:00:00Z",
"razaoDadosOcultos": null,
"tribunalDistrital": "EXEMPLO",
"ultimaAtualizacao": "12345678000195",
"dataRedistribuicao": "2026-01-15T12:00:00Z",
"idadeProcessoLegal": "EXEMPLO",
"numeroAtualizacoes": "EXEMPLO",
"dataUltimaMovimentacao": "2026-01-15T12:00:00Z",
"nomeAssuntoCnjInferido": "PESSOA EXEMPLO",
"numeroAssuntoCnjInferido": "EXEMPLO",
"acoesJudiciaisRelacionadas": [],
"numeroMedioAtualizacoesMes": null
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"juiz": "EXEMPLO",
"tipo": "EXEMPLO",
"valor": "EXEMPLO",
"estado": "SP",
"numero": "EXEMPLO",
"status": "REGULAR",
"decisoes": [],
"peticoes": [],
"dataAviso": "2026-01-15T12:00:00Z",
"envolvidos": [
{
"_id": "EXEMPLO",
"nome": "PESSOA EXEMPLO",
"tipo": "EXEMPLO",
"documento": "12345678909",
"parteAtiva": true,
"polaridade": "EXEMPLO",
"dataUltimaCaptura": "2026-01-15T12:00:00Z",
"detalhesEnvolvido": {
"OAB": null,
"estado": null,
"tipoEspecifico": "EXEMPLO"
}
},
{
"_id": "EXEMPLO",
"nome": "PESSOA EXEMPLO",
"tipo": "EXEMPLO",
"documento": "12345678000195",
"parteAtiva": true,
"polaridade": "EXEMPLO",
"dataUltimaCaptura": "2026-01-15T12:00:00Z",
"detalhesEnvolvido": {
"OAB": null,
"estado": null,
"tipoEspecifico": "EXEMPLO"
}
}
],
"dataCaptura": "2026-01-15T12:00:00Z",
"atualizacoes": [],
"corpoJulgado": "EXEMPLO",
"nomeTribunal": "PESSOA EXEMPLO",
"numeroPartes": "EXEMPLO",
"tipoTribunal": "EXEMPLO",
"numeroPaginas": null,
"numeroVolumes": null,
"dataPublicacao": "2026-01-15T12:00:00Z",
"outrosAssuntos": [
"EXEMPLO",
"EXEMPLO"
],
"numeroInstancia": "EXEMPLO",
"resDataJudicata": "2026-01-15T12:00:00Z",
"assuntoPrincipal": "EXEMPLO",
"dataEncerramento": "2026-01-15T12:00:00Z",
"razaoDadosOcultos": null,
"tribunalDistrital": "EXEMPLO",
"ultimaAtualizacao": "12345678000195",
"dataRedistribuicao": "2026-01-15T12:00:00Z",
"idadeProcessoLegal": "EXEMPLO",
"numeroAtualizacoes": "EXEMPLO",
"dataUltimaMovimentacao": "2026-01-15T12:00:00Z",
"nomeAssuntoCnjInferido": "PESSOA EXEMPLO",
"numeroAssuntoCnjInferido": "EXEMPLO",
"acoesJudiciaisRelacionadas": [],
"numeroMedioAtualizacoesMes": null
}
],
"totalAcoesJudiciais": 1,
"dataUltimaAcaoJudicial": "2026-01-15T12:00:00Z",
"totalAcoesJudiciaisReu": 1,
"dataPrimeiraAcaoJudicial": "2026-01-15T12:00:00Z",
"totalAcoesJudiciaisAutor": 1,
"totalAcoesJudiciaisOutro": 1,
"acoesJudiciaisUltimos30Dias": 1,
"acoesJudiciaisUltimos90Dias": 1,
"acoesJudiciaisSegredoJustica": 1,
"acoesJudiciaisUltimos180Dias": 1,
"acoesJudiciaisUltimos365Dias": 1,
"acoesJudiciaisSegundaInstancia": 1,
"acoesJudiciaisPrimeiraInstancia": 1,
"acoesJudiciaisTerceiraInstancia": 1
},
"historicoEndereco": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"cep": "01001000",
"rua": "AVENIDA EXEMPLO, 100",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"estado": "SP",
"numero": "EXEMPLO",
"itemUltimaAtualizacao": "EXEMPLO"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"cep": "01001000",
"rua": "AVENIDA EXEMPLO, 100",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"estado": "SP",
"numero": "EXEMPLO",
"itemUltimaAtualizacao": "EXEMPLO"
}
],
"informacoesCredito": {
"dados": {
"status": "REGULAR",
"atividade": "EXEMPLO",
"codigoNire": "1",
"dataAbertura": "2026-01-15",
"nomeCompania": "PESSOA EXEMPLO",
"nomeFantasia": "EMPRESA EXEMPLO LTDA",
"codigoPrimario": "1",
"codigoSecundario": "1",
"quantidadeFiliais": "EXEMPLO",
"atividadeSecundaria": "EXEMPLO",
"codigoNaturezaJuridica": "1"
},
"email": {
"endereco": "AVENIDA EXEMPLO, 100",
"dataUltimaAtualizacao": "2026-01-15"
},
"celular": {
"numero": null,
"dataUltimaAtualizacao": null
},
"endereco": {
"cep": "01001000",
"rua": "AVENIDA EXEMPLO, 100",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"estado": "SP",
"numero": "EXEMPLO",
"complemento": null,
"dataUltimaAtualizacao": "2026-01-15"
},
"telefone": {
"numero": "EXEMPLO",
"dataUltimaAtualizacao": null
}
},
"consultasAnteriores": {
"consultas31a60Dias": 1,
"consultas61a90Dias": 1,
"consultasMais90Dias": 1,
"consultasUltimos30Dias": 1
},
"debitosTrabalhistas": {
"date": "2026-01-15T12:00:00Z",
"validity": "EXEMPLO",
"requested": "EXEMPLO",
"certificate": "EXEMPLO",
"certidaoLink": "https://arquivos.cobrativa.com.br/exemplo",
"certificateUrlPartner": "https://arquivos.cobrativa.com.br/exemplo"
},
"pendenciasFinanceiras": {
"scpc": {
"moeda": null,
"registros": [],
"quantidade": null,
"valorTotal": null,
"ultimaOcorrencia": null,
"primeiraOcorrencia": null
},
"pefin": {
"detalhes": [
{
"id": "EXEMPLO",
"uf": null,
"_id": "EXEMPLO",
"tipo": "EXEMPLO",
"moeda": null,
"cidade": null,
"origem": "EXEMPLO",
"source": 1,
"avalista": "EXEMPLO",
"contrato": "EXEMPLO",
"informante": null,
"insertedAt": "EXEMPLO",
"dataOcorrencia": "2026-01-15",
"valorPendencia": "EXEMPLO",
"documentoOrigem": null,
"tituloOcorrencia": null,
"dataDisponibilidade": null
},
{
"id": "EXEMPLO",
"uf": null,
"_id": "EXEMPLO",
"tipo": "EXEMPLO",
"moeda": null,
"cidade": null,
"origem": "EXEMPLO",
"source": 1,
"avalista": "EXEMPLO",
"contrato": "EXEMPLO",
"informante": null,
"insertedAt": "EXEMPLO",
"dataOcorrencia": "2026-01-15",
"valorPendencia": "EXEMPLO",
"documentoOrigem": null,
"tituloOcorrencia": null,
"dataDisponibilidade": null
}
],
"maiorValor": 123.45,
"quantidade": 35,
"valorTotal": 123.45,
"dataPrimeiro": "2026-01-15",
"periodoFinal": null,
"valorDevedor": null,
"valorAvalista": null,
"valorPrimeiro": 123.45,
"dataMaiorValor": null,
"periodoInicial": null,
"quantidadeCredores": null,
"dataUltimaOcorrencia": "2026-01-15"
},
"refin": {
"detalhes": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"tipo": "EXEMPLO",
"origem": "EXEMPLO",
"source": 1,
"avalista": "EXEMPLO",
"contrato": "12345678909",
"insertedAt": "EXEMPLO",
"dataOcorrencia": "2026-01-15",
"valorPendencia": "EXEMPLO"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"tipo": "EXEMPLO",
"origem": "EXEMPLO",
"source": 1,
"avalista": "EXEMPLO",
"contrato": "EXEMPLO",
"insertedAt": "EXEMPLO",
"dataOcorrencia": "2026-01-15",
"valorPendencia": "EXEMPLO"
}
],
"quantidade": 35,
"valorTotal": "EXEMPLO",
"dataPrimeiro": "2026-01-15",
"dataUltimaOcorrencia": "2026-01-15"
},
"scpcBvs": {
"valor": null,
"registros": [],
"maiorValor": null,
"quantidade": null,
"dataMaiorValor": null,
"ultimaOcorrencia": null,
"dataPrimeiraOcorrencia": null,
"valorPrimeiraOcorrencia": null
},
"dividasVencidas": {
"detalhes": [],
"quantidade": 35,
"valorTotal": null,
"dataPrimeiro": null,
"dataUltimaOcorrencia": null
}
},
"restricoesFinanceiras": {
"apontamentos": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"cnpj": "12345678000195",
"valor": 123.45,
"endereco": {
"cidade": "SAO PAULO",
"estado": "SP"
},
"natureza": "EXEMPLO",
"nomeEmpresa": "EMPRESA EXEMPLO LTDA",
"dataInclusao": "2026-01-15",
"dataOcorrencia": "2026-01-15",
"numeroContrato": "EXEMPLO",
"tipoParticipante": "EXEMPLO",
"statusApontamento": "REGULAR"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"cnpj": "12345678000195",
"valor": 123.45,
"endereco": {
"cidade": "SAO PAULO",
"estado": "SP"
},
"natureza": "EXEMPLO",
"nomeEmpresa": "EMPRESA EXEMPLO LTDA",
"dataInclusao": "2026-01-15",
"dataOcorrencia": "2026-01-15",
"numeroContrato": "EXEMPLO",
"tipoParticipante": "EXEMPLO",
"statusApontamento": "REGULAR"
}
],
"pendenciasCredito": 1.5,
"dataUltimoApontamento": "2026-01-15"
},
"resumoAcessoPositivoPJ": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"total": "EXEMPLO",
"titulo": "EXEMPLO",
"periodoFinal": null,
"periodoInicial": null,
"valorAcumulado": "EXEMPLO"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"total": "EXEMPLO",
"titulo": "EXEMPLO",
"periodoFinal": null,
"periodoInicial": null,
"valorAcumulado": "EXEMPLO"
}
],
"protestosAcessoPositivo": {
"ocorrencias": [
{
"id": "EXEMPLO",
"uf": "",
"_id": "EXEMPLO",
"data": "2026-01-15",
"valor": "EXEMPLO",
"cidade": "SAO PAULO",
"cartorio": "EXEMPLO"
},
{
"id": "EXEMPLO",
"uf": "",
"_id": "EXEMPLO",
"data": "2026-01-15",
"valor": "EXEMPLO",
"cidade": "SAO PAULO",
"cartorio": "EXEMPLO"
}
]
},
"pendenciasAcessoPositivo": {
"ocorrencias": [
{
"id": "EXEMPLO",
"uf": null,
"_id": "EXEMPLO",
"data": "2026-01-15",
"valor": "EXEMPLO",
"informante": "EXEMPLO",
"tipoPendencia": "EXEMPLO"
},
{
"id": "EXEMPLO",
"uf": null,
"_id": "EXEMPLO",
"data": "2026-01-15",
"valor": "EXEMPLO",
"informante": "EXEMPLO",
"tipoPendencia": "EXEMPLO"
}
]
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3007Rating Avançado CNPJ
CNPJAvaliação empresarial com score, rating, decisão de crédito, cadastro, restrições, protestos e cheques sem fundos.
Contrato v1
3007
Rating Avançado CNPJ
CNPJAvaliação empresarial com score, rating, decisão de crédito, cadastro, restrições, protestos e cheques sem fundos.
Parâmetros
cnpj *Requisição
json
{
"cnpj": "12345678000195"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3007,
"slug": "rating-avancado-cnpj",
"nome": "Rating Avançado CNPJ",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"VEICULAR": {},
"CREDCADASTRAL": {
"PROTESTOS": {
"DATA_MAIOR": "",
"DATA_ULTIMO": "",
"OCORRENCIAS": [],
"VALOR_MAIOR": "",
"VALOR_TOTAL": "",
"VALOR_ULTIMO": "",
"DATA_PRIMEIRO": "",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"VALOR_PRIMEIRO": "",
"ULTIMO_PROTESTO": "",
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"CONTUMACIA": {
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIA": "EXEMPLO",
"DATA_ULTIMA_OCORRENCIA": "",
"DATA_PRIMEIRA_OCORRENCIA": ""
},
"MOTOR_CREDITO": {
"OCORRENCIAS": [
{
"SCORE": "EXEMPLO",
"MENSAGEM": "",
"SITUACAO": "REGULAR",
"TAXA_JUROS": "EXEMPLO",
"QTD_PARCELAS": "EXEMPLO",
"RATING_BACEN": "BAIXO",
"DECISAO_NEGOCIO": "EXEMPLO",
"CREDITO_SUGERIDO": "EXEMPLO",
"PARCELA_SUGERIDA": "EXEMPLO"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
},
"CH_SEM_FUNDOS_BACEN": {
"CPFCNPJ": "",
"CORRENTISTA": "",
"TIPO_PESSOA": "",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"INFORMACOES_DA_EMPRESA": {
"CNPJ": "",
"NIRE": "12345678909",
"TIPO": "",
"EMAIL": "",
"PORTE": "",
"NIRE_UF": "EXEMPLO",
"ENDERECO": {
"UF": "",
"CEP": "",
"BAIRRO": "",
"CIDADE": "",
"ENDERECO": ""
},
"SITUACAO": "REGULAR",
"TELEFONE": "",
"RAZAO_SOCIAL": "EMPRESA EXEMPLO LTDA",
"CNAE_PRIMARIO": "EXEMPLO",
"DATA_CONSULTA": "2026-01-15",
"DATA_FUNDACAO": "2026-01-15",
"DATA_SITUACAO": "2026-01-15",
"NOME_FANTASIA": "",
"SITUACAO_FGTS": "",
"CAPITAL_SOCIAL": "",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"TIPO_SOCIEDADE": "",
"CIDADES_FILIAIS": "",
"CNAE_SECUNDARIO": "",
"ENDERECO_MATRIZ": {
"UF": "",
"CEP": "",
"BAIRRO": "",
"CIDADE": "",
"ENDERECO": ""
},
"OPCAO_TRIBUTARIA": "",
"DATA_ENCERRAMENTO": "",
"NATUREZA_JURIDICA": "EXEMPLO",
"SITUACAO_SINTEGRA": "",
"DATA_CONSULTA_FGTS": "",
"DATA_VALIDADE_FGTS": "",
"FAIXA_FUNCIONARIOS": "",
"INSCRICAO_ESTADUAL": "12345678000195",
"QUANTIDADE_FILIAIS": "",
"INSCRICAO_ESTADUAL_UF": "EXEMPLO",
"RAZAO_SOCIAL_ANTERIOR": "",
"DATA_CONSULTA_SINTEGRA": "",
"DATA_SITUACAO_SINTEGRA": "",
"RAMO_ATIVIDADE_PRIMARIO": "EXEMPLO",
"RAMO_ATIVIDADE_SECUNDARIO": ""
},
"RESTRICOES_FINANCEIRAS": {
"OCORRENCIAS": [
{
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CREDOR": "EXEMPLO",
"ORIGEM": "EXEMPLO",
"CONTRATO": "EXEMPLO",
"SUBJUDICE": "",
"MODALIDADE": "EXEMPLO",
"TIPO_DEVEDOR": "EXEMPLO",
"DATA_INCLUSAO": "2026-01-15",
"DATA_VENCIMENTO": "2026-01-15"
},
{
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CREDOR": "EXEMPLO",
"ORIGEM": "EXEMPLO",
"CONTRATO": "EXEMPLO",
"SUBJUDICE": "",
"MODALIDADE": "EXEMPLO",
"TIPO_DEVEDOR": "EXEMPLO",
"DATA_INCLUSAO": "2026-01-15",
"DATA_VENCIMENTO": "2026-01-15"
}
],
"VALOR_TOTAL": "EXEMPLO",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"ULTIMO_VENCIMENTO": "EXEMPLO",
"PRIMEIRO_VENCIMENTO": "",
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"INFORMACOES_ALERTAS_RESTRICOES": {
"OCORRENCIAS": [],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
}
},
"COBRATIVA_DADOS_CADASTRAIS": {
"status": "success",
"version": 1,
"attempted": true,
"source_slug": "busca-cnpj",
"response_data": {
"body": {
"data": {
"emails": [
{
"id": "12345678000195",
"_id": "12345678000195",
"email": "exemplo@empresa.com.br",
"posicao": null
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"email": "exemplo@empresa.com.br",
"posicao": null
}
],
"documento": "12345678000195",
"enderecos": [
{
"id": "12345678000195",
"uf": "SP",
"_id": "12345678000195",
"cep": "01001000",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"numero": "EXEMPLO",
"posicao": null,
"logradouro": "AVENIDA EXEMPLO, 100",
"complemento": "EXEMPLO",
"tipoLogradouro": "AVENIDA EXEMPLO, 100"
},
{
"id": "12345678000195",
"uf": "SP",
"_id": "12345678000195",
"cep": "01001000",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"numero": "EXEMPLO",
"posicao": null,
"logradouro": "AVENIDA EXEMPLO, 100",
"complemento": "EXEMPLO",
"tipoLogradouro": "AVENIDA EXEMPLO, 100"
}
],
"telefones": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"ddd": "EXEMPLO",
"tipo": "EXEMPLO",
"posicao": null,
"telefone": "11999999999"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"ddd": "EXEMPLO",
"tipo": "EXEMPLO",
"posicao": null,
"telefone": "11999999999"
}
],
"dadosCadastrais": {
"endCep": null,
"endNum": null,
"endBairro": null,
"endCidade": null,
"endEstado": null,
"codigoCnae": "1",
"razaoSocial": "EMPRESA EXEMPLO LTDA",
"dataAbertura": "2026-01-15",
"dataFundacao": null,
"nomeFantasia": null,
"descricaoCnae": "Informação de exemplo",
"endLogradouro": null,
"endComplemento": null,
"endTipoLogradouro": null
}
},
"type": "EXEMPLO",
"error": null,
"customQuery": false,
"servicesBroken": []
},
"status": {
"cod": 1,
"msg": "EXEMPLO"
}
}
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3008Rating Estágios CNPJ
CNPJAvaliação de crédito empresarial com score, estágio de risco, decisão do motor, dados cadastrais, restrições e alertas.
Contrato v1
3008
Rating Estágios CNPJ
CNPJAvaliação de crédito empresarial com score, estágio de risco, decisão do motor, dados cadastrais, restrições e alertas.
Parâmetros
cnpj *Requisição
json
{
"cnpj": "12345678000195"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3008,
"slug": "rating-score-cnpj",
"nome": "Rating Estágios CNPJ",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"VEICULAR": {},
"CREDCADASTRAL": {
"PROTESTOS": {
"DATA_MAIOR": "",
"DATA_ULTIMO": "",
"OCORRENCIAS": [
{
"DATA": "2026-01-15",
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CREDOR": "",
"ORIGEM": "EXEMPLO",
"ANUENCIA": "",
"CARTORIO": "EXEMPLO",
"SUBJUDICE": "",
"QUANTIDADE": "",
"VENCIMENTO": "EXEMPLO",
"VALOR_CUSTAS": "",
"TIPO_ANOTACAO": ""
},
{
"DATA": "2026-01-15",
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CREDOR": "",
"ORIGEM": "EXEMPLO",
"ANUENCIA": "",
"CARTORIO": "EXEMPLO",
"SUBJUDICE": "",
"QUANTIDADE": "",
"VENCIMENTO": "EXEMPLO",
"VALOR_CUSTAS": "",
"TIPO_ANOTACAO": ""
}
],
"VALOR_MAIOR": "",
"VALOR_TOTAL": "",
"VALOR_ULTIMO": "",
"DATA_PRIMEIRO": "",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"VALOR_PRIMEIRO": "",
"ULTIMO_PROTESTO": "",
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"CONTUMACIA": {
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIA": "EXEMPLO",
"DATA_ULTIMA_OCORRENCIA": "",
"DATA_PRIMEIRA_OCORRENCIA": ""
},
"MOTOR_CREDITO": {
"OCORRENCIAS": [
{
"SCORE": "EXEMPLO",
"MENSAGEM": "",
"SITUACAO": "REGULAR",
"TAXA_JUROS": "EXEMPLO",
"QTD_PARCELAS": "EXEMPLO",
"RATING_BACEN": "BAIXO",
"DECISAO_NEGOCIO": "EXEMPLO",
"CREDITO_SUGERIDO": "EXEMPLO",
"PARCELA_SUGERIDA": "EXEMPLO"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
},
"CH_SEM_FUNDOS_BACEN": {
"CPFCNPJ": "",
"CORRENTISTA": "",
"TIPO_PESSOA": "",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"INFORMACOES_DA_EMPRESA": {
"CNPJ": "",
"NIRE": "12345678909",
"TIPO": "",
"EMAIL": "",
"PORTE": "",
"NIRE_UF": "EXEMPLO",
"ENDERECO": {
"UF": "",
"CEP": "",
"BAIRRO": "",
"CIDADE": "",
"ENDERECO": ""
},
"SITUACAO": "REGULAR",
"TELEFONE": "",
"RAZAO_SOCIAL": "EMPRESA EXEMPLO LTDA",
"CNAE_PRIMARIO": "EXEMPLO",
"DATA_CONSULTA": "2026-01-15",
"DATA_FUNDACAO": "2026-01-15",
"DATA_SITUACAO": "2026-01-15",
"NOME_FANTASIA": "EMPRESA EXEMPLO LTDA",
"SITUACAO_FGTS": "",
"CAPITAL_SOCIAL": "",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"TIPO_SOCIEDADE": "",
"CIDADES_FILIAIS": "",
"CNAE_SECUNDARIO": "",
"ENDERECO_MATRIZ": {
"UF": "",
"CEP": "",
"BAIRRO": "",
"CIDADE": "",
"ENDERECO": ""
},
"OPCAO_TRIBUTARIA": "",
"DATA_ENCERRAMENTO": "",
"NATUREZA_JURIDICA": "EXEMPLO",
"SITUACAO_SINTEGRA": "",
"DATA_CONSULTA_FGTS": "",
"DATA_VALIDADE_FGTS": "",
"FAIXA_FUNCIONARIOS": "",
"INSCRICAO_ESTADUAL": "12345678000195",
"QUANTIDADE_FILIAIS": "",
"INSCRICAO_ESTADUAL_UF": "EXEMPLO",
"RAZAO_SOCIAL_ANTERIOR": "",
"DATA_CONSULTA_SINTEGRA": "",
"DATA_SITUACAO_SINTEGRA": "",
"RAMO_ATIVIDADE_PRIMARIO": "EXEMPLO",
"RAMO_ATIVIDADE_SECUNDARIO": ""
},
"RESTRICOES_FINANCEIRAS": {
"OCORRENCIAS": [
{
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CREDOR": "EXEMPLO",
"ORIGEM": "EXEMPLO",
"CONTRATO": "EXEMPLO",
"SUBJUDICE": "",
"MODALIDADE": "EXEMPLO",
"TIPO_DEVEDOR": "EXEMPLO",
"DATA_INCLUSAO": "2026-01-15",
"DATA_VENCIMENTO": "2026-01-15"
}
],
"VALOR_TOTAL": "EXEMPLO",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"ULTIMO_VENCIMENTO": "EXEMPLO",
"PRIMEIRO_VENCIMENTO": "",
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"INFORMACOES_ALERTAS_RESTRICOES": {
"OCORRENCIAS": [],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
}
},
"COBRATIVA_DADOS_CADASTRAIS": {
"status": "success",
"version": 1,
"attempted": true,
"source_slug": "busca-cnpj",
"response_data": {
"body": {
"data": {
"emails": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"email": "exemplo@empresa.com.br",
"posicao": null
}
],
"documento": "12345678000195",
"enderecos": [
{
"id": "EXEMPLO",
"uf": "SP",
"_id": "EXEMPLO",
"cep": "01001000",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"numero": "EXEMPLO",
"posicao": null,
"logradouro": "AVENIDA EXEMPLO, 100",
"complemento": null,
"tipoLogradouro": "AVENIDA EXEMPLO, 100"
}
],
"telefones": [
{
"id": "12345678000195",
"_id": "12345678000195",
"ddd": "EXEMPLO",
"tipo": "EXEMPLO",
"posicao": null,
"telefone": "11999999999"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"ddd": "EXEMPLO",
"tipo": "EXEMPLO",
"posicao": null,
"telefone": "11999999999"
}
],
"dadosCadastrais": {
"endCep": null,
"endNum": null,
"endBairro": null,
"endCidade": null,
"endEstado": null,
"codigoCnae": "1",
"razaoSocial": "EMPRESA EXEMPLO LTDA",
"dataAbertura": "2026-01-15",
"dataFundacao": null,
"nomeFantasia": "EMPRESA EXEMPLO LTDA",
"descricaoCnae": "Informação de exemplo",
"endLogradouro": null,
"endComplemento": null,
"endTipoLogradouro": null
}
},
"type": "EXEMPLO",
"error": null,
"customQuery": false,
"servicesBroken": []
},
"status": {
"cod": 1,
"msg": "EXEMPLO"
}
}
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3009Rating Raio X CNPJ
CNPJAnálise empresarial com scores e ratings, faturamento, capacidade de pagamento, quadro societário, restrições, dados complementares da Base II, SCR/Bacen e processos judiciais.
Contrato v1
3009
Rating Raio X CNPJ
CNPJAnálise empresarial com scores e ratings, faturamento, capacidade de pagamento, quadro societário, restrições, dados complementares da Base II, SCR/Bacen e processos judiciais.
Parâmetros
cnpj *Requisição
json
{
"cnpj": "12345678000195"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3009,
"slug": "rating-raio-x-cnpj",
"nome": "Rating Raio X CNPJ",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"data": "2026-01-15",
"hora": "EXEMPLO",
"operacoes": {
"registros": [
{
"total": "EXEMPLO",
"modalidade": "EXEMPLO",
"percentual": "EXEMPLO",
"subdominio": "EXEMPLO",
"variacao_cambial": "EXEMPLO",
"codigo_modalidade": "1"
},
{
"total": "EXEMPLO",
"modalidade": "EXEMPLO",
"percentual": "EXEMPLO",
"subdominio": "EXEMPLO",
"variacao_cambial": "EXEMPLO",
"codigo_modalidade": "1"
}
],
"risco_total": "BAIXO",
"carteira_de_credito": "EXEMPLO",
"responsabilidade_total": "EXEMPLO"
},
"prejuizos": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"valor_total": "EXEMPLO"
},
"protocolo": "EXEMPLO",
"scr_score": {
"valor": null,
"importante": "EXEMPLO",
"observacao": "Informação de exemplo"
},
"dados_bacen": {
"resumo_geral_scr": {
"documento": "12345678000195",
"tipo_de_documento": "12345678909",
"coobrigacao_assumida": "EXEMPLO",
"coobrigacao_recebida": "EXEMPLO",
"data_base_consultada": "2026-01-15"
},
"quantidade_de_operacoes": 35,
"inicio_do_relacionamento": "PESSOA EXEMPLO",
"quantidade_de_instituicoes": 35,
"indicadores_de_confiabilidade": {
"total_subjudice": "EXEMPLO",
"total_discordancia": "EXEMPLO",
"operacoes_subjudice": 1,
"risco_indireto_vendor": "BAIXO",
"operacoes_em_discordancia": 1,
"percentual_de_volume_processado": "EXEMPLO",
"percentual_de_documentos_processados": "12345678909"
}
},
"faturamento": {
"idade_empresa": 35,
"capacidade_pagamento": 35,
"faturamento_presumido": "EXEMPLO"
},
"informativo": "EXEMPLO",
"localizacao": {
"uf": "SP",
"cep": "01001000",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"latitude": "EXEMPLO",
"longitude": "EXEMPLO",
"area_risco": "BAIXO",
"logradouro": "AVENIDA EXEMPLO, 100",
"complemento": "EXEMPLO"
},
"motor_credito": {
"score": 750,
"credito": "EXEMPLO",
"parcelas": "EXEMPLO",
"taxaJuros": "EXEMPLO",
"ratingBacen": "BAIXO",
"valorParcelaSugerida": "EXEMPLO",
"valorEmprestimoSugerido": "EXEMPLO"
},
"nome_consulta": "PESSOA EXEMPLO",
"dividas_ativas": {
"bb": 1,
"anm": 1,
"fgts": 1,
"sida": 1,
"bacen": 1,
"total": 1,
"previdencia": 1
},
"credito_vencido": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"valor_total": "EXEMPLO"
},
"cheques_sustados": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"registros": []
},
"credito_a_vencer": {
"total": {
"valor": "EXEMPLO",
"qtd_meses": null,
"percentual": "EXEMPLO"
},
"registros": [
{
"valor": "EXEMPLO",
"descricao": "Informação de exemplo",
"qtd_meses": 1,
"percentual": "EXEMPLO"
},
{
"valor": "EXEMPLO",
"descricao": "Informação de exemplo",
"qtd_meses": 1,
"percentual": "EXEMPLO"
}
]
},
"dados_cadastrais": {
"cnpj": "12345678000195",
"email": "exemplo@empresa.com.br",
"porte": "EXEMPLO",
"matriz": "EXEMPLO",
"telefone": "11999999999",
"razao_social": "EMPRESA EXEMPLO LTDA",
"data_fundacao": "2026-01-15",
"nome_fantasia": "EMPRESA EXEMPLO LTDA",
"situacao_cnpj": "12345678000195",
"capital_social": "EXEMPLO",
"cnae_principal": "EXEMPLO",
"descricao_cnae": "Informação de exemplo",
"tempo_atividade": "EXEMPLO",
"cnaes_secundarios": [
"EXEMPLO",
"EXEMPLO"
],
"natureza_juridica": "EXEMPLO",
"data_situacao_cnpj": "12345678000195",
"inscricao_estadual": "",
"quantidade_filiais": 35,
"faturamento_presumido": "EXEMPLO",
"quantidade_funcionarios": "EXEMPLO",
"codigo_natureza_juridica": "1"
},
"score_de_credito": {
"score": 750,
"texto": "EXEMPLO",
"modelo": "EXEMPLO",
"rating": {
"escala": [
"EXEMPLO",
"EXEMPLO"
],
"descritivo": "EXEMPLO",
"observacao": "Informação de exemplo",
"classificacao_numerica": "BAIXO",
"classificacao_alfabetica": "BAIXO"
},
"natureza": "EXEMPLO",
"status_do_consumidor": {
"mensagem": "Informação de exemplo",
"situacao": "REGULAR"
},
"probabilidade_inadimplencia": "EXEMPLO"
},
"cheques_sem_fundo": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"registros": [
{
"nome": "PESSOA EXEMPLO",
"motivo": "Informação de exemplo",
"agencia": "EXEMPLO",
"nome_banco": "PESSOA EXEMPLO",
"quantidade": 35,
"data_ultimo": "2026-01-15",
"numero_banco": "EXEMPLO"
}
]
},
"faturas_em_atraso": {
"nota": null,
"escala": [
"EXEMPLO",
"EXEMPLO"
],
"descricao": "Informação de exemplo"
},
"limite_de_credito": {
"status": "REGULAR",
"registros": [
{
"valor": "EXEMPLO",
"descricao": "Informação de exemplo"
}
],
"valor_total": "EXEMPLO"
},
"quadro_societario": {
"socios": [
{
"nome": "PESSOA EXEMPLO",
"funcao": "EXEMPLO",
"telefone": "11999999999",
"whatsapp": "11999999999",
"documento": "12345678909",
"tipo_documento": "12345678909",
"renda_presumida": "EXEMPLO",
"participacao_percentual": null
}
],
"quantidade_socios": 35,
"renda_media_socios": "EXEMPLO"
},
"contratos_recentes": {
"nota": "EXEMPLO",
"escala": [
"EXEMPLO",
"EXEMPLO"
],
"descricao": "Informação de exemplo"
},
"titulos_protestados": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"registros": []
},
"alerta_de_restricoes": {
"com_ocorrencias": {
"blocos": [
{
"status": "REGULAR",
"titulo": "EXEMPLO",
"detalhes": [
{
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"valor_total": "EXEMPLO"
}
],
"ocorrencias": 1
},
{
"status": "REGULAR",
"titulo": "EXEMPLO",
"detalhes": [
{
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"valor_total": "EXEMPLO"
}
],
"ocorrencias": 1
}
],
"quantidade_blocos": 35
},
"sem_ocorrencias": {
"blocos": [
{
"status": "REGULAR",
"titulo": "EXEMPLO",
"mensagem": "Informação de exemplo"
},
{
"status": "REGULAR",
"titulo": "EXEMPLO",
"mensagem": "Informação de exemplo"
}
],
"quantidade_blocos": 35
}
},
"operacoes_detalhadas": [
{
"total": "EXEMPLO",
"modalidade": "EXEMPLO",
"percentual": "EXEMPLO",
"subdominio": "EXEMPLO",
"vencimentos": [
{
"meses": 1,
"valor": "EXEMPLO",
"codigo": "1",
"descricao": "Informação de exemplo",
"percentual": "EXEMPLO",
"restritivo": "EXEMPLO"
},
{
"meses": 1,
"valor": "EXEMPLO",
"codigo": "1",
"descricao": "Informação de exemplo",
"percentual": "EXEMPLO",
"restritivo": "EXEMPLO"
}
],
"variacao_cambial": "EXEMPLO",
"codigo_modalidade": "1"
},
{
"total": "EXEMPLO",
"modalidade": "EXEMPLO",
"percentual": "EXEMPLO",
"subdominio": "EXEMPLO",
"vencimentos": [
{
"meses": null,
"valor": "EXEMPLO",
"codigo": "1",
"descricao": "Informação de exemplo",
"percentual": "EXEMPLO",
"restritivo": "EXEMPLO"
}
],
"variacao_cambial": "EXEMPLO",
"codigo_modalidade": "1"
}
],
"pagamentos_adiantados": {
"nota": null,
"escala": [
"EXEMPLO",
"EXEMPLO"
],
"descricao": "Informação de exemplo",
"observacao": "Informação de exemplo"
},
"score_rating_bancario": {
"valor": 123.45,
"rating": "BAIXO",
"status": "REGULAR",
"categoria": "EXEMPLO",
"juros_faixa": "EXEMPLO",
"perfil_risco": "BAIXO",
"probabilidade_pagamento": "EXEMPLO",
"comparativo_faixa_etaria": "EXEMPLO",
"probabilidade_inadimplencia": "EXEMPLO"
},
"historico_de_consultas": [],
"minuta_declaracao_lgpd": "EXEMPLO",
"score_de_risco_base_ii": {
"importante": "EXEMPLO",
"score_de_risco": {
"faixa": "EXEMPLO",
"valor": 123.45,
"escala": "EXEMPLO"
},
"probabilidade_de_inadimplencia": {
"valor": "EXEMPLO",
"descricao": "Informação de exemplo"
}
},
"informacoes_importantes": "EXEMPLO",
"dados_cadastrais_base_ii": {
"endereco": {
"uf": "SP",
"cep": "01001000",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"logradouro": "AVENIDA EXEMPLO, 100"
},
"situacao": "REGULAR",
"documento": "12345678000195",
"tipo_pessoa": "EXEMPLO",
"razao_social": "EMPRESA EXEMPLO LTDA",
"data_fundacao": "2026-01-15",
"data_situacao": "",
"tempo_atividade": "EXEMPLO"
},
"decisao_negociar_cliente": false,
"indicador_comportamental": {
"contratos_recentes": "EXEMPLO",
"nota_comportamental": "EXEMPLO",
"valor_total_dividas": 123.45,
"score_comportamental": 750
},
"negativacoes_registradas": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"registros": [
{
"uf": "SP",
"tipo": "EXEMPLO",
"valor": "EXEMPLO",
"cidade": "SAO PAULO",
"informante": "EXEMPLO",
"data_debito": "2026-01-15",
"disponivel_em": "EXEMPLO",
"documento_origem": "12345678000195"
},
{
"uf": "SP",
"tipo": "EXEMPLO",
"valor": "EXEMPLO",
"cidade": "SAO PAULO",
"informante": "EXEMPLO",
"data_debito": "2026-01-15",
"disponivel_em": "EXEMPLO",
"documento_origem": "12345678000195"
}
]
},
"cheques_sem_fundo_base_ii": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"registros": [
{
"data": "2026-01-15",
"valor": 123.45,
"natureza": "EXEMPLO"
}
],
"quantidade": 35,
"valor_total": "EXEMPLO"
},
"pontualidade_de_pagamento": {
"observacao": "Informação de exemplo",
"cartao_de_credito": null,
"operacoes_parceladas": null
},
"quadro_societario_base_ii": [],
"acoes_e_processos_judiciais": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"processos": [],
"observacao": "Informação de exemplo",
"total_de_processos": 1,
"ultima_distribuicao": null,
"valor_medio_da_causa": "EXEMPLO",
"valor_total_das_causas": "EXEMPLO"
},
"titulos_protestados_base_ii": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"registros": [],
"quantidade": 35,
"valor_total": "EXEMPLO"
},
"processos_judiciais_base_iii": {
"resumo": {
"situacao": "REGULAR",
"valor_total": 123.45,
"data_consulta": "2026-01-15",
"total_processos": 1,
"distribuicao_por_uf": [],
"distribuicao_por_tipo": [],
"valor_total_informado_nos_detalhes": 123.45
},
"processos": []
},
"falencia_recuperacao_judicial": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"observacao": "Informação de exemplo"
},
"historico_de_consultas_base_ii": {
"registros": [],
"resumo_mensal": [],
"quantidade_total": 35
},
"pendencias_financeiras_base_ii": {
"resumo": {
"pefin": {
"quantidade": 35,
"valor_total": "EXEMPLO"
},
"refin": {
"quantidade": 35,
"valor_total": "EXEMPLO"
},
"pendencias_vencidas": {
"quantidade": 35,
"valor_total": "EXEMPLO"
}
},
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"registros": [
{
"data": "2026-01-15",
"tipo": "EXEMPLO",
"valor": 123.45,
"credor": "EXEMPLO",
"natureza": "EXEMPLO",
"data_entrada": "2026-01-15"
},
{
"data": "2026-01-15",
"tipo": "EXEMPLO",
"valor": 123.45,
"credor": "EXEMPLO",
"natureza": "EXEMPLO",
"data_entrada": "2026-01-15"
}
],
"quantidade": 35
},
"avaliacao_preliminar_de_credito": {
"importante": "EXEMPLO",
"score_de_risco": {
"valor": 123.45,
"escala": "EXEMPLO",
"mensagem": "Informação de exemplo"
},
"faturamento_presumido": {
"valor": "EXEMPLO",
"descricao": "Informação de exemplo"
},
"negociacao_recomendada": "EXEMPLO",
"probabilidade_de_inadimplencia": {
"valor": "EXEMPLO",
"observacao": "Informação de exemplo"
}
},
"resumo_de_consultas_ultimos_meses": {
"periodos": [],
"total_no_periodo": {
"total": 1,
"intervalo": ""
}
},
"cadin_divida_ativa_uniao_receita_federal": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo"
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
1806Restrições Quod + Ações Judiciais CNPJ
CNPJScore, pendências financeiras, protestos, cheques sem fundos e ações cíveis do CNPJ.
Contrato v20180521
1806
Restrições Quod + Ações Judiciais CNPJ
CNPJScore, pendências financeiras, protestos, cheques sem fundos e ações cíveis do CNPJ.
Parâmetros
cnpj *Requisição
json
{
"cnpj": "12345678000195"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 1806,
"slug": "risco-acoes-judiciais-cnpj",
"nome": "Restrições Quod + Ações Judiciais CNPJ",
"versao": "20180521"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"VEICULAR": {},
"CREDCADASTRAL": {
"SCORES": {
"OCORRENCIAS": [
{
"RISCO": "BAIXO",
"SCORE": "EXEMPLO",
"TEXTO": "12345678909",
"LAYOUT": "EXEMPLO",
"EXECUCAO": "EXEMPLO",
"INFORMANTE": "EXEMPLO",
"TIPO_SCORE": "EXEMPLO",
"CLASSIF_ABC": "EXEMPLO",
"CLASSIF_NRO": "EXEMPLO",
"DESCR_PLANO": "EXEMPLO",
"DESCR_SCORE": "EXEMPLO",
"MODELO_SCORE": "",
"PROBABILIDADE_INADIMPLENCIA": "EXEMPLO"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
},
"PROTESTOS": {
"DATA_MAIOR": "",
"DATA_ULTIMO": "",
"OCORRENCIAS": [],
"VALOR_MAIOR": "",
"VALOR_TOTAL": "EXEMPLO",
"VALOR_ULTIMO": "",
"DATA_PRIMEIRO": "",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"VALOR_PRIMEIRO": "",
"ULTIMO_PROTESTO": "",
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"ACOES_CIVEIS": {
"DATA_MAIOR": "",
"DATA_MENOR": "",
"DATA_ULTIMO": "",
"OCORRENCIAS": [],
"VALOR_MAIOR": "",
"VALOR_MENOR": "",
"VALOR_TOTAL": "",
"VALOR_ULTIMO": "",
"DATA_PRIMEIRO": "",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"VALOR_PRIMEIRO": "",
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"PEND_FINANCEIRAS": {
"DATA_MAIOR": "",
"PROVEDORES": [
{
"VALOR_CALCULADO": "EXEMPLO",
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
}
],
"OCORRENCIAS": [
{
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CREDOR": "EXEMPLO",
"ORIGEM": "EXEMPLO",
"CONTRATO": "EXEMPLO",
"ENTIDADE": "",
"SUBJUDICE": "",
"INFORMANTE": "EXEMPLO",
"MODALIDADE": "EXEMPLO",
"TIPO_DEVEDOR": "EXEMPLO",
"DATA_INCLUSAO": "2026-01-15",
"DATA_VENCIMENTO": "2026-01-15"
}
],
"VALOR_MAIOR": "",
"VALOR_TOTAL": "EXEMPLO",
"DATA_PRIMEIRO": "",
"PERIODO_FINAL": "",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"TOTAL_CREDORES": "",
"VALOR_PRIMEIRO": "",
"PERIODO_INICIAL": "",
"ULTIMO_VENCIMENTO": "EXEMPLO",
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"CH_SEM_FUNDOS_BACEN": {
"CPFCNPJ": "",
"CORRENTISTA": "",
"OCORRENCIAS": [
{
"DCR_BANCO": "EXEMPLO",
"NUM_BANCO": "EXEMPLO",
"NUM_AGENCIA": "EXEMPLO",
"QTD_CHEQUES": "EXEMPLO",
"DADOS_AGENCIA": "",
"DOC_RELACIONADO": "",
"MOTIVO_DEVOLUCAO": "Informação de exemplo",
"DT_ULTIMA_OCORRENCIA": "EXEMPLO"
},
{
"DCR_BANCO": "EXEMPLO",
"NUM_BANCO": "EXEMPLO",
"NUM_AGENCIA": "EXEMPLO",
"QTD_CHEQUES": "EXEMPLO",
"DADOS_AGENCIA": "",
"DOC_RELACIONADO": "",
"MOTIVO_DEVOLUCAO": "Informação de exemplo",
"DT_ULTIMA_OCORRENCIA": "EXEMPLO"
}
],
"TIPO_PESSOA": "",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"INFORMACOES_ALERTAS_RESTRICOES": {
"OCORRENCIAS": [
{
"TITULO": "EXEMPLO",
"OBSERVACOES": "EXEMPLO",
"CODIGO_TIPO_INFORMACAO": "1",
"DESCRICAO_TIPO_INFORMACAO": "Informação de exemplo"
},
{
"TITULO": "EXEMPLO",
"OBSERVACOES": "EXEMPLO",
"CODIGO_TIPO_INFORMACAO": "1",
"DESCRICAO_TIPO_INFORMACAO": "Informação de exemplo"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
}
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3010Score Boa Vista + Cadastro CNPJ
CNPJScore empresarial, restrições e comportamento de pagamento da empresa.
Contrato v1
3010
Score Boa Vista + Cadastro CNPJ
CNPJScore empresarial, restrições e comportamento de pagamento da empresa.
Parâmetros
cnpj *Requisição
json
{
"cnpj": "12345678000195"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3010,
"slug": "score-cadastro-cnpj",
"nome": "Score Boa Vista + Cadastro CNPJ",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"VEICULAR": {},
"CREDCADASTRAL": {
"SCORES": {
"OCORRENCIAS": [
{
"RISCO": "BAIXO",
"SCORE": "EXEMPLO",
"TEXTO": "EXEMPLO",
"LAYOUT": "EXEMPLO",
"EXECUCAO": "",
"INFORMANTE": "EXEMPLO",
"TIPO_SCORE": "EXEMPLO",
"CLASSIF_ABC": "EXEMPLO",
"CLASSIF_NRO": "EXEMPLO",
"DESCR_PLANO": "EXEMPLO",
"DESCR_SCORE": "EXEMPLO",
"MODELO_SCORE": "",
"PROBABILIDADE_INADIMPLENCIA": "EXEMPLO"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
},
"PROTESTOS": {
"DATA_MAIOR": "",
"DATA_ULTIMO": "",
"OCORRENCIAS": [
{
"DATA": "2026-01-15",
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CREDOR": "",
"ORIGEM": "EXEMPLO",
"ANUENCIA": "",
"CARTORIO": "EXEMPLO",
"SUBJUDICE": "",
"QUANTIDADE": "",
"VENCIMENTO": "EXEMPLO",
"VALOR_CUSTAS": "",
"TIPO_ANOTACAO": ""
},
{
"DATA": "2026-01-15",
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CREDOR": "",
"ORIGEM": "EXEMPLO",
"ANUENCIA": "",
"CARTORIO": "EXEMPLO",
"SUBJUDICE": "",
"QUANTIDADE": "",
"VENCIMENTO": "EXEMPLO",
"VALOR_CUSTAS": "",
"TIPO_ANOTACAO": ""
}
],
"VALOR_MAIOR": "",
"VALOR_TOTAL": "EXEMPLO",
"VALOR_ULTIMO": "",
"DATA_PRIMEIRO": "",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"VALOR_PRIMEIRO": "",
"ULTIMO_PROTESTO": "",
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"CONTUMACIA": {
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIA": "EXEMPLO",
"DATA_ULTIMA_OCORRENCIA": "",
"DATA_PRIMEIRA_OCORRENCIA": ""
},
"COMPROMISSOS": {
"PONTUACAO": "EXEMPLO",
"OCORRENCIAS": [
{
"PERIODO": "EXEMPLO",
"PONTUACAO_MENSAL": "EXEMPLO"
},
{
"PERIODO": "EXEMPLO",
"PONTUACAO_MENSAL": "EXEMPLO"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
}
},
"CREDITO_OBTIDO": {
"PONTUACAO": "EXEMPLO",
"OCORRENCIAS": [
{
"PERIODO": "EXEMPLO",
"PONTUACAO_MENSAL": "EXEMPLO"
},
{
"PERIODO": "EXEMPLO",
"PONTUACAO_MENSAL": "EXEMPLO"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
}
},
"HIST_CONSULTAS": {
"DETALHES": [
{
"CNPJ": "12345678000195",
"DATA": "2026-01-15",
"RAZAO_SOCIAL": "EMPRESA EXEMPLO LTDA"
},
{
"CNPJ": "12345678000195",
"DATA": "2026-01-15",
"RAZAO_SOCIAL": "EMPRESA EXEMPLO LTDA"
}
],
"SEGMENTOS": [],
"DATA_FINAL": "2026-01-15",
"QUANTIDADES": [
{
"ANO": "EXEMPLO",
"MAIO": "EXEMPLO",
"ABRIL": "EXEMPLO",
"JULHO": "EXEMPLO",
"JUNHO": "EXEMPLO",
"MARCO": "EXEMPLO",
"AGOSTO": "EXEMPLO",
"JANEIRO": "EXEMPLO",
"OUTUBRO": "",
"DEZEMBRO": "",
"NOVEMBRO": "",
"SETEMBRO": "",
"FEVEREIRO": "EXEMPLO"
},
{
"ANO": "EXEMPLO",
"MAIO": "",
"ABRIL": "",
"JULHO": "",
"JUNHO": "",
"MARCO": "",
"AGOSTO": "EXEMPLO",
"JANEIRO": "",
"OUTUBRO": "EXEMPLO",
"DEZEMBRO": "EXEMPLO",
"NOVEMBRO": "EXEMPLO",
"SETEMBRO": "EXEMPLO",
"FEVEREIRO": ""
}
],
"DATA_INICIAL": "2026-01-15",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
},
"PEND_FINANCEIRAS": {
"DATA_MAIOR": "2026-01-15",
"PROVEDORES": [
{
"VALOR_CALCULADO": "EXEMPLO",
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
}
],
"OCORRENCIAS": [
{
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CREDOR": "EXEMPLO",
"ORIGEM": "EXEMPLO",
"CONTRATO": "EXEMPLO",
"ENTIDADE": "",
"SUBJUDICE": "",
"INFORMANTE": "EXEMPLO",
"MODALIDADE": "EXEMPLO",
"TIPO_DEVEDOR": "EXEMPLO",
"DATA_INCLUSAO": "2026-01-15",
"DATA_VENCIMENTO": "2026-01-15"
},
{
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CREDOR": "EXEMPLO",
"ORIGEM": "EXEMPLO",
"CONTRATO": "EXEMPLO",
"ENTIDADE": "",
"SUBJUDICE": "",
"INFORMANTE": "EXEMPLO",
"MODALIDADE": "EXEMPLO",
"TIPO_DEVEDOR": "EXEMPLO",
"DATA_INCLUSAO": "2026-01-15",
"DATA_VENCIMENTO": "2026-01-15"
}
],
"VALOR_MAIOR": "",
"VALOR_TOTAL": "EXEMPLO",
"DATA_PRIMEIRO": "2026-01-15",
"PERIODO_FINAL": "EXEMPLO",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"TOTAL_CREDORES": "",
"VALOR_PRIMEIRO": "",
"PERIODO_INICIAL": "EXEMPLO",
"ULTIMO_VENCIMENTO": "",
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"PAGAMENTO_PONTUAL": {
"PONTUACAO": "EXEMPLO",
"OCORRENCIAS": [
{
"PERIODO": "EXEMPLO",
"PONTUACAO_MENSAL": "EXEMPLO"
},
{
"PERIODO": "EXEMPLO",
"PONTUACAO_MENSAL": "EXEMPLO"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
}
},
"PAGAMENTO_ATRASADO": {
"OCORRENCIAS": [
{
"ITENS": [
{
"PERIODO": "EXEMPLO",
"PONTUACAO_MENSAL": "EXEMPLO"
},
{
"PERIODO": "EXEMPLO",
"PONTUACAO_MENSAL": "EXEMPLO"
}
],
"DESCRICAO": "Informação de exemplo",
"PONTUACAO": "EXEMPLO"
},
{
"ITENS": [
{
"PERIODO": "EXEMPLO",
"PONTUACAO_MENSAL": "EXEMPLO"
},
{
"PERIODO": "EXEMPLO",
"PONTUACAO_MENSAL": "EXEMPLO"
}
],
"DESCRICAO": "Informação de exemplo",
"PONTUACAO": "EXEMPLO"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
}
},
"CH_SEM_FUNDOS_BACEN": {
"CPFCNPJ": "12345678000195",
"CORRENTISTA": "EXEMPLO",
"TIPO_PESSOA": "EXEMPLO",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"CH_SEM_FUNDOS_VAREJO": {
"CPFCNPJ": "12345678000195",
"CORRENTISTA": "EXEMPLO",
"TIPO_PESSOA": "EXEMPLO",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"COMPROMETIMENTO_FUTURO": {
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
}
},
"INFORMACOES_DA_EMPRESA": {
"CNPJ": "12345678000195",
"NIRE": "12345678909",
"TIPO": "",
"EMAIL": "",
"PORTE": "",
"NIRE_UF": "EXEMPLO",
"ENDERECO": {
"UF": "SP",
"CEP": "01001000",
"BAIRRO": "CENTRO",
"CIDADE": "SAO PAULO",
"ENDERECO": "AVENIDA EXEMPLO, 100"
},
"SITUACAO": "REGULAR",
"TELEFONE": "",
"RAZAO_SOCIAL": "EMPRESA EXEMPLO LTDA",
"CNAE_PRIMARIO": "EXEMPLO",
"DATA_CONSULTA": "2026-01-15",
"DATA_FUNDACAO": "2026-01-15",
"DATA_SITUACAO": "2026-01-15",
"NOME_FANTASIA": "EMPRESA EXEMPLO LTDA",
"SITUACAO_FGTS": "",
"CAPITAL_SOCIAL": "",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"TIPO_SOCIEDADE": "",
"CIDADES_FILIAIS": "",
"CNAE_SECUNDARIO": "",
"ENDERECO_MATRIZ": {
"UF": "",
"CEP": "",
"BAIRRO": "",
"CIDADE": "",
"ENDERECO": ""
},
"OPCAO_TRIBUTARIA": "",
"DATA_ENCERRAMENTO": "",
"NATUREZA_JURIDICA": "EXEMPLO",
"SITUACAO_SINTEGRA": "",
"DATA_CONSULTA_FGTS": "",
"DATA_VALIDADE_FGTS": "",
"FAIXA_FUNCIONARIOS": "",
"INSCRICAO_ESTADUAL": "12345678000195",
"QUANTIDADE_FILIAIS": "",
"INSCRICAO_ESTADUAL_UF": "EXEMPLO",
"RAZAO_SOCIAL_ANTERIOR": "",
"DATA_CONSULTA_SINTEGRA": "",
"DATA_SITUACAO_SINTEGRA": "",
"RAMO_ATIVIDADE_PRIMARIO": "EXEMPLO",
"RAMO_ATIVIDADE_SECUNDARIO": ""
},
"EVENTOS_PESSOA_JURIDICA": {
"PONTUACAO": "",
"OCORRENCIAS": [
{
"PERIODO": "EXEMPLO",
"INDICADOR": "EXEMPLO",
"PONTUACAO": "EXEMPLO"
},
{
"PERIODO": "EXEMPLO",
"INDICADOR": "EXEMPLO",
"PONTUACAO": "EXEMPLO"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
}
},
"INFORMACOES_ALERTAS_RESTRICOES": {
"OCORRENCIAS": [],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"PERIODO_RELACIONAMENTO_FORNECEDORES": {
"PONTUACAO": "",
"OCORRENCIAS": [
{
"VALOR": "EXEMPLO",
"PERIODO": "EXEMPLO"
},
{
"VALOR": "EXEMPLO",
"PERIODO": "EXEMPLO"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
}
}
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3011SCR Bacen Premium CNPJ
CNPJEndividamento bancário do CNPJ no SCR: modalidades, vencimentos, prejuízos e coobrigações.
Contrato v1
3011
SCR Bacen Premium CNPJ
CNPJEndividamento bancário do CNPJ no SCR: modalidades, vencimentos, prejuízos e coobrigações.
Parâmetros
cnpj *Requisição
json
{
"cnpj": "12345678000195"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3011,
"slug": "scr-bacen-premium-cnpj",
"nome": "SCR Bacen Premium CNPJ",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"VEICULAR": {},
"CREDCADASTRAL": {
"RELATORIO_SCR": {
"SCORE": {
"FAIXA": "EXEMPLO",
"PONTUACAO": "EXEMPLO"
},
"DOCUMENTO": "12345678000195",
"OPERACOES": [
{
"TOTAL": "EXEMPLO",
"MODALIDADE": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"PERCENTUAL": "EXEMPLO",
"VENCIMENTOS": [
{
"VALOR": "EXEMPLO",
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo",
"QTD_MESES": "EXEMPLO",
"PERCENTUAL": "EXEMPLO",
"RESTRITIVO": "EXEMPLO"
},
{
"VALOR": "EXEMPLO",
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo",
"QTD_MESES": "EXEMPLO",
"PERCENTUAL": "EXEMPLO",
"RESTRITIVO": "EXEMPLO"
}
],
"SUB_MODALIDADE": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"VARIACAO_CAMBIAL": "EXEMPLO"
},
{
"TOTAL": "EXEMPLO",
"MODALIDADE": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"PERCENTUAL": "EXEMPLO",
"VENCIMENTOS": [
{
"VALOR": "EXEMPLO",
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo",
"QTD_MESES": "EXEMPLO",
"PERCENTUAL": "EXEMPLO",
"RESTRITIVO": "EXEMPLO"
},
{
"VALOR": "EXEMPLO",
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo",
"QTD_MESES": "EXEMPLO",
"PERCENTUAL": "EXEMPLO",
"RESTRITIVO": "EXEMPLO"
}
],
"SUB_MODALIDADE": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"VARIACAO_CAMBIAL": "EXEMPLO"
}
],
"CONSOLIDADO": {
"PREJUIZO": {
"VALOR": "EXEMPLO",
"OPERACOES": [],
"PERCENTUAL": "EXEMPLO"
},
"LIMITE_CREDITO": {
"VALOR": "EXEMPLO",
"OPERACOES": [],
"PERCENTUAL": "EXEMPLO"
},
"CREDITO_AVENCER": {
"VALOR": "EXEMPLO",
"OPERACOES": [
{
"VALOR": "EXEMPLO",
"DESCRICAO": "Informação de exemplo",
"QTD_MESES": "EXEMPLO",
"PERCENTUAL": "EXEMPLO"
},
{
"VALOR": "EXEMPLO",
"DESCRICAO": "Informação de exemplo",
"QTD_MESES": "EXEMPLO",
"PERCENTUAL": "EXEMPLO"
}
],
"PERCENTUAL": "EXEMPLO"
},
"CREDITO_VENCIDO": {
"VALOR": "EXEMPLO",
"OPERACOES": [
{
"VALOR": "EXEMPLO",
"DESCRICAO": "Informação de exemplo",
"QTD_MESES": "EXEMPLO",
"PERCENTUAL": "EXEMPLO"
},
{
"VALOR": "EXEMPLO",
"DESCRICAO": "Informação de exemplo",
"QTD_MESES": "EXEMPLO",
"PERCENTUAL": "EXEMPLO"
}
],
"PERCENTUAL": "EXEMPLO"
}
},
"VALOR_REPASSE": "EXEMPLO",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"TIPO_DOCUMENTO": "12345678909",
"NOME_RAZAO_SOCIAL": "",
"DATABASE_CONSULTADA": "2026-01-15",
"NASCIMENTO_FUNDACAO": "",
"COOBRIGACAO_ASSUMIDA": "EXEMPLO",
"COOBRIGACAO_RECEBIDA": "EXEMPLO",
"QUANTIDADE_OPERACOES": "EXEMPLO",
"RISCO_INDIRETO_VENDOR": "BAIXO",
"QUANTIDADE_INSTITUICOES": "EXEMPLO",
"DATA_INICIO_RELACIONAMENTO": "PESSOA EXEMPLO",
"VALOR_TRANSACOES_JUDICIAIS": "EXEMPLO",
"PERCENTUAL_VOLUME_PROCESSADO": "EXEMPLO",
"VALOR_TRANSACOES_DIVERGENTES": "EXEMPLO",
"QUANTIDADE_OPERACOES_SUBJUDICE": "EXEMPLO",
"RESPONSABILIDADE_TOTAL_SUBJUDICE": "EXEMPLO",
"PERCENTUAL_DOCUMENTOS_PROCESSADOS": "12345678909",
"QUANTIDADE_OPERACOES_DISCORDANCIA": "EXEMPLO",
"RESPONSABILIDADE_TOTAL_DISCORDANCIA": "EXEMPLO"
}
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3012Serasa Avançado CNPJ
CNPJRelatório avançado com identificação empresarial, restrições e fatos do CNPJ.
Contrato v1
3012
Serasa Avançado CNPJ
CNPJRelatório avançado com identificação empresarial, restrições e fatos do CNPJ.
Parâmetros
documento *Requisição
json
{
"documento": "12345678000195"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3012,
"slug": "credito-completo-cnpj",
"nome": "Serasa Avançado CNPJ",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"reports": [
{
"facts": {
"bankrupts": {
"summary": {
"count": 1,
"balance": 1
}
},
"judgementFilings": {
"summary": {
"count": 1,
"balance": 1,
"lastOccurrence": "EXEMPLO",
"firstOccurrence": "EXEMPLO"
},
"judgementFilingsResponse": [
{
"city": "SAO PAULO",
"cadus": "EXEMPLO",
"state": "SP",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"principal": true,
"civilCourt": "EXEMPLO",
"distributor": "EXEMPLO",
"legalNature": "EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
},
{
"city": "SAO PAULO",
"cadus": "EXEMPLO",
"state": "SP",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"principal": true,
"civilCourt": "EXEMPLO",
"distributor": "EXEMPLO",
"legalNature": "EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
}
]
},
"inquiryCompanyResponse": {
"results": [
{
"companyName": "EMPRESA EXEMPLO LTDA",
"companyAlias": "EMPRESA EXEMPLO LTDA",
"daysQuantity": 1,
"occurrenceDate": "2026-01-15",
"companyDocumentId": "EMPRESA EXEMPLO LTDA"
},
{
"companyName": "EMPRESA EXEMPLO LTDA",
"companyAlias": "EMPRESA EXEMPLO LTDA",
"daysQuantity": 1,
"occurrenceDate": "2026-01-15",
"companyDocumentId": "EMPRESA EXEMPLO LTDA"
}
],
"quantity": {
"actual": 1,
"historical": [
{
"inquiryDate": "2026-01-15",
"occurrences": 1
},
{
"inquiryDate": "2026-01-15",
"occurrences": 1
}
]
}
}
},
"score": {
"score": 750,
"message": "Informação de exemplo",
"scoreModel": "EXEMPLO",
"defaultRate": "EXEMPLO"
},
"scores": {
"scoreResponse": [
{
"score": 750,
"message": "Informação de exemplo",
"scoreModel": "EXEMPLO"
}
]
},
"QSAReport": {
"companyData": {
"nature": "EXEMPLO",
"controlType": "EXEMPLO",
"countryOrigin": "EXEMPLO",
"accomplishedValue": 1,
"socialCapitalValue": 123.45,
"informationUpdateDate": "2026-01-15"
},
"partnerCompleteReport": {
"partnersList": [
{
"name": "PESSOA EXEMPLO",
"status": "REGULAR",
"sinceDate": "2026-01-15",
"documentId": "12345678000195",
"statusCode": "REGULAR",
"nationality": "EXEMPLO",
"documentType": "EXEMPLO",
"restrictionSign": true,
"capitalTotalValue": 123.45,
"capitalVoterValue": 123.45,
"documentConsistency": true
}
]
},
"directorCompleteReport": {
"directorsList": [
{
"name": "PESSOA EXEMPLO",
"role": "EXEMPLO",
"status": "REGULAR",
"sinceDate": "2026-01-15",
"documentId": "12345678909",
"statusCode": "REGULAR",
"documentType": "EXEMPLO",
"restrictionSign": true,
"documentConsistency": true,
"informationUpdateDate": "2026-01-15"
}
]
}
},
"reportName": "PESSOA EXEMPLO",
"negativeData": {
"check": {
"summary": {
"count": 1,
"balance": 1,
"lastOccurrence": "EXEMPLO",
"firstOccurrence": "EXEMPLO"
},
"checkResponse": [
{
"city": "SAO PAULO",
"cadus": "EXEMPLO",
"alinea": 1,
"bankName": "PESSOA EXEMPLO",
"checkCount": 1,
"checkNumber": "EXEMPLO",
"federalUnit": "EXEMPLO",
"bankAgencyId": 35,
"inclusionDate": "2026-01-15",
"occurrenceDate": "2026-01-15"
}
]
},
"pefin": {
"summary": {
"count": 1,
"balance": 1.5,
"lastOccurrence": "EXEMPLO",
"firstOccurrence": "EXEMPLO"
},
"pefinResponse": [
{
"cadus": "EXEMPLO",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"principal": true,
"contractId": "EXEMPLO",
"legalNature": "EXEMPLO",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
},
{
"cadus": "EXEMPLO",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"principal": true,
"contractId": "EXEMPLO",
"legalNature": "EXEMPLO",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
}
]
},
"refin": {
"summary": {
"count": 1,
"balance": 1.5,
"lastOccurrence": "EXEMPLO",
"firstOccurrence": "EXEMPLO"
},
"refinResponse": [
{
"cadus": "EXEMPLO",
"amount": 123.45,
"principal": true,
"contractId": "EXEMPLO",
"legalNature": "EXEMPLO",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
},
{
"cadus": "EXEMPLO",
"amount": 123.45,
"principal": true,
"contractId": "EXEMPLO",
"legalNature": "EXEMPLO",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
}
]
},
"notary": {
"summary": {
"count": 1,
"balance": 1.5,
"lastOccurrence": "EXEMPLO",
"firstOccurrence": "EXEMPLO"
},
"notaryResponse": [
{
"city": "SAO PAULO",
"cadus": "EXEMPLO",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"federalUnit": "EXEMPLO",
"officeNumber": "EXEMPLO",
"inclusionDate": "2026-01-15",
"occurrenceDate": "2026-01-15"
},
{
"city": "SAO PAULO",
"cadus": "EXEMPLO",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"federalUnit": "EXEMPLO",
"officeNumber": "EXEMPLO",
"inclusionDate": "2026-01-15",
"occurrenceDate": "2026-01-15"
}
]
},
"collectionRecords": {
"summary": {
"count": 1,
"balance": 1.5,
"lastOccurrence": "EXEMPLO",
"firstOccurrence": "EXEMPLO"
},
"collectionRecordsResponse": [
{
"city": "SAO PAULO",
"cadus": "EXEMPLO",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"debtMode": "EXEMPLO",
"principal": true,
"contractId": "EXEMPLO",
"federalUnit": "EXEMPLO",
"legalNature": "EXEMPLO",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
},
{
"city": "SAO PAULO",
"cadus": "EXEMPLO",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"debtMode": "EXEMPLO",
"principal": true,
"contractId": "12345678000195",
"federalUnit": "EXEMPLO",
"legalNature": "EXEMPLO",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
}
]
}
},
"negativeSummary": {},
"identificationReport": {
"cnae": "EXEMPLO",
"phone": {
"areaCode": "1",
"phoneNumber": "11999999999"
},
"address": {
"city": "SAO PAULO",
"state": "SP",
"zipCode": "1",
"district": "CENTRO",
"addressLine": "AVENIDA EXEMPLO, 100"
},
"companyUrl": "",
"nireNumber": "12345678909",
"statusCode": "REGULAR",
"updateDate": "2026-01-15",
"companyName": "EMPRESA EXEMPLO LTDA",
"partnership": "EXEMPLO",
"companyAlias": "EMPRESA EXEMPLO LTDA",
"branchOffices": "EXEMPLO",
"documentNumber": "12345678000195",
"companyRegister": "EMPRESA EXEMPLO LTDA",
"legalNatureCode": "1",
"predecessorList": [
{
"predecessorDate": "2026-01-15",
"predecessorName": "PESSOA EXEMPLO"
}
],
"reorganizations": [],
"economicActivity": "EXEMPLO",
"companyFoundation": "EMPRESA EXEMPLO LTDA",
"stateRegistration": "EXEMPLO",
"statusRegistration": "REGULAR",
"companyRegisterDate": "EMPRESA EXEMPLO LTDA",
"statusCodeDescription": "REGULAR"
},
"checkFilingsHistorical": {
"checkFilingsHistoricalResponse": []
}
}
]
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3013Serasa Básico CNPJ
CNPJRelatório com cadastro, restrições e consultas do CNPJ.
Contrato v1
3013
Serasa Básico CNPJ
CNPJRelatório com cadastro, restrições e consultas do CNPJ.
Parâmetros
documento *Requisição
json
{
"documento": "12345678000195"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3013,
"slug": "credito-essencial-cnpj",
"nome": "Serasa Básico CNPJ",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"reports": [
{
"facts": {
"inquiryCompanyResponse": {
"results": [
{
"companyName": "EMPRESA EXEMPLO LTDA",
"companyAlias": "EMPRESA EXEMPLO LTDA",
"daysQuantity": 1,
"occurrenceDate": "2026-01-15",
"companyDocumentId": "EMPRESA EXEMPLO LTDA"
},
{
"companyName": "EMPRESA EXEMPLO LTDA",
"companyAlias": "EMPRESA EXEMPLO LTDA",
"daysQuantity": 1,
"occurrenceDate": "2026-01-15",
"companyDocumentId": "EMPRESA EXEMPLO LTDA"
}
],
"quantity": {
"actual": 1,
"bankActual": 1,
"historical": [
{
"inquiryDate": "2026-01-15",
"occurrences": 1,
"bankOccurrences": 1
}
]
}
}
},
"score": {
"score": 750,
"message": "Informação de exemplo",
"scoreModel": "EXEMPLO",
"defaultRate": "EXEMPLO"
},
"partner": {
"PartnerResponse": {
"results": [
{
"name": "PESSOA EXEMPLO",
"status": "REGULAR",
"documentId": "12345678000195",
"statusCode": "REGULAR",
"hasNegative": true,
"inconsistent": false,
"participationPercentage": 35
}
]
}
},
"director": {
"DirectorResponse": {
"results": [
{
"name": "PESSOA EXEMPLO",
"role": "EXEMPLO",
"status": "REGULAR",
"documentId": "12345678909",
"statusCode": "REGULAR",
"hasNegative": true,
"documentType": "EXEMPLO"
}
]
}
},
"reportName": "PESSOA EXEMPLO",
"negativeData": {
"check": {
"summary": {
"count": 1,
"balance": 1,
"lastOccurrence": "EXEMPLO",
"firstOccurrence": "EXEMPLO"
},
"checkResponse": [
{
"city": "SAO PAULO",
"cadus": "EXEMPLO",
"alinea": 1,
"bankId": 1,
"bankName": "PESSOA EXEMPLO",
"checkCount": 1,
"checkNumber": "EXEMPLO",
"federalUnit": "EXEMPLO",
"bankAgencyId": 35,
"inclusionDate": "2026-01-15",
"occurrenceDate": "2026-01-15"
}
]
},
"pefin": {
"summary": {
"count": 1,
"balance": 1.5,
"lastOccurrence": "EXEMPLO",
"firstOccurrence": "EXEMPLO"
},
"pefinResponse": [
{
"cadus": "EXEMPLO",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"principal": true,
"contractId": "EXEMPLO",
"legalNature": "EXEMPLO",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
},
{
"cadus": "EXEMPLO",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"principal": true,
"contractId": "EXEMPLO",
"legalNature": "EXEMPLO",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
}
]
},
"refin": {
"summary": {
"count": 1,
"balance": 1.5,
"lastOccurrence": "EXEMPLO",
"firstOccurrence": "EXEMPLO"
},
"refinResponse": [
{
"cadus": "EXEMPLO",
"amount": 123.45,
"principal": true,
"contractId": "EXEMPLO",
"legalNature": "EXEMPLO",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
},
{
"cadus": "EXEMPLO",
"amount": 123.45,
"principal": true,
"contractId": "EXEMPLO",
"legalNature": "EXEMPLO",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
}
]
},
"notary": {
"summary": {
"count": 1,
"balance": 1.5,
"lastOccurrence": "EXEMPLO",
"firstOccurrence": "EXEMPLO"
},
"notaryResponse": [
{
"city": "SAO PAULO",
"cadus": "EXEMPLO",
"amount": 123.45,
"federalUnit": "EXEMPLO",
"officeNumber": "EXEMPLO",
"inclusionDate": "2026-01-15",
"occurrenceDate": "2026-01-15"
},
{
"city": "SAO PAULO",
"cadus": "EXEMPLO",
"amount": 123.45,
"federalUnit": "EXEMPLO",
"officeNumber": "EXEMPLO",
"inclusionDate": "2026-01-15",
"occurrenceDate": "2026-01-15"
}
]
},
"collectionRecords": {
"summary": {
"count": 1,
"balance": 1.5,
"lastOccurrence": "EXEMPLO",
"firstOccurrence": "EXEMPLO"
},
"collectionRecordsResponse": [
{
"city": "SAO PAULO",
"cadus": "EXEMPLO",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"principal": true,
"contractId": "EXEMPLO",
"federalUnit": "EXEMPLO",
"legalNature": "EXEMPLO",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
},
{
"city": "SAO PAULO",
"cadus": "EXEMPLO",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"principal": true,
"contractId": "12345678000195",
"federalUnit": "EXEMPLO",
"legalNature": "EXEMPLO",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
}
]
}
},
"registration": {
"address": {
"city": "SAO PAULO",
"state": "SP",
"zipCode": "1",
"district": "CENTRO",
"addressLine": "AVENIDA EXEMPLO, 100"
},
"companyName": "EMPRESA EXEMPLO LTDA",
"foundationDate": "2026-01-15",
"companyDocument": "EMPRESA EXEMPLO LTDA",
"statusRegistration": "REGULAR"
},
"negativeSummary": {}
}
]
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3015MAX Brasil Avançado CPF
CPFAnálise aprofundada de pessoa física com score, cadastro, CNH, contatos, restrições financeiras, protestos, processos judiciais e vínculos empresariais.
Contrato v1
3015
MAX Brasil Avançado CPF
CPFAnálise aprofundada de pessoa física com score, cadastro, CNH, contatos, restrições financeiras, protestos, processos judiciais e vínculos empresariais.
Parâmetros
cpf *Requisição
json
{
"cpf": "12345678909"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3015,
"slug": "analise-360-avancada-cpf",
"nome": "MAX Brasil Avançado CPF",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"dadosCnh": {
"cursos": null,
"motivo": {
"requerimento1": null,
"requerimento2": null,
"requerimento3": null,
"requerimento4": null,
"requerimentoPid1": null,
"requerimentoPid2": null,
"requerimentoPid3": null,
"requerimentoPid4": null
},
"portaria": null,
"validade": "2026-01-15",
"bloqueios": [],
"categoria": "EXEMPLO",
"descricao": null,
"numeroPgu": null,
"ufDominio": null,
"dataEmissao": "2026-01-15",
"impedimento": null,
"observacoes": [
"EXEMPLO"
],
"ufExpeditor": null,
"numeroRenach": "EXEMPLO",
"toxicologico": {
"situacao": "REGULAR",
"dataColeta": null,
"dataVencimento": null
},
"numeroEspelho": null,
"numeroRegistro": "12345678909",
"orgaoExpedidor": null,
"ufExpedicao_pid": null,
"categoriaRebaixada": null,
"ufHabilitacaoAtual": null,
"categoriaAutorizada": null,
"numeroFormularioCnh": null,
"numeroFormularioPid": null,
"situacaoCnhAnterior": null,
"dataUltimaAtualizacao": null,
"ufPrimeiraHabilitacao": null,
"habilitacaoEstrangeira": null,
"numeroListaImpedimento": null,
"dataPrimeiraHabilitacao": "2026-01-15",
"numeroFormularioCnhBasePid": null,
"ufSolicitanteTransferencia": null,
"paisOrigemHabilitacaoEstrangeira": null,
"identificacaoHabilitacaoEstrangeira": null
},
"protestos": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"situacao": null,
"cartorios": [],
"dataConsulta": null,
"valorTotalProtestado": null
}
],
"apontamentos": [],
"scoreCredito": {
"tipo": "EXEMPLO",
"score": 750,
"razoes": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"codigo": "1",
"mensagem": "Informação de exemplo"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"codigo": "1",
"mensagem": "Informação de exemplo"
}
],
"perfilScore": 750,
"riscoDeCredito": "BAIXO",
"riscoCreditoMensagem": "BAIXO",
"probabilidadeDePagamento": "EXEMPLO",
"pontuacaoCompromissoPagamento": 750,
"probabilidadeDePagamentoMensagem": "Informação de exemplo"
},
"debitoAcPosPF": [
{
"id": "EXEMPLO",
"uf": null,
"_id": "EXEMPLO",
"valor": "EXEMPLO",
"informante": "EXEMPLO",
"tipoPendencia": "EXEMPLO",
"dataOcorrencia": "2026-01-15"
},
{
"id": "EXEMPLO",
"uf": null,
"_id": "EXEMPLO",
"valor": "EXEMPLO",
"informante": "EXEMPLO",
"tipoPendencia": "EXEMPLO",
"dataOcorrencia": "2026-01-15"
}
],
"resumoCredito": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"valor": 123.45,
"descricao": "Informação de exemplo",
"dataUltimo": null,
"quantidade": 35,
"dataPrimeiro": null
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"valor": 123.45,
"descricao": "Informação de exemplo",
"dataUltimo": null,
"quantidade": 35,
"dataPrimeiro": null
}
],
"historicoEmail": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"email": "exemplo@empresa.com.br",
"itemUltimaAtualizacao": "EXEMPLO"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"email": "exemplo@empresa.com.br",
"itemUltimaAtualizacao": "EXEMPLO"
}
],
"protestosVecPj": {
"ext": null,
"registros": [],
"valorTotal": null,
"numRegistros": 1,
"ocorrenciaMaisAntiga": null,
"ocorrenciaMaisRecente": null
},
"historicoNumero": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"numero": "12345678909",
"itemUltimaAtualizacao": "EXEMPLO"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"numero": "EXEMPLO",
"itemUltimaAtualizacao": "EXEMPLO"
}
],
"participantesPJ": [],
"chequesSemFundos": [],
"processoJudicial": {
"acoesJudiciais": [
{
"id": "12345678909",
"_id": "12345678909",
"juiz": "EXEMPLO",
"tipo": "EXEMPLO",
"valor": "EXEMPLO",
"estado": "SP",
"numero": "EXEMPLO",
"status": "REGULAR",
"decisoes": [],
"peticoes": [],
"dataAviso": "2026-01-15T12:00:00Z",
"envolvidos": [
{
"_id": "12345678909",
"nome": "PESSOA EXEMPLO",
"tipo": "EXEMPLO",
"documento": "12345678909",
"parteAtiva": true,
"polaridade": "EXEMPLO",
"dataUltimaCaptura": "2026-01-15T12:00:00Z",
"detalhesEnvolvido": {
"OAB": null,
"estado": null,
"tipoEspecifico": "EXEMPLO"
}
},
{
"_id": "12345678909",
"nome": "PESSOA EXEMPLO",
"tipo": "EXEMPLO",
"documento": "12345678000195",
"parteAtiva": true,
"polaridade": "EXEMPLO",
"dataUltimaCaptura": "2026-01-15T12:00:00Z",
"detalhesEnvolvido": {
"OAB": null,
"estado": null,
"tipoEspecifico": "EXEMPLO"
}
}
],
"dataCaptura": "2026-01-15T12:00:00Z",
"atualizacoes": [],
"corpoJulgado": "EXEMPLO",
"nomeTribunal": "PESSOA EXEMPLO",
"numeroPartes": "EXEMPLO",
"tipoTribunal": "EXEMPLO",
"numeroPaginas": null,
"numeroVolumes": null,
"dataPublicacao": "2026-01-15T12:00:00Z",
"outrosAssuntos": [
"EXEMPLO"
],
"numeroInstancia": "EXEMPLO",
"resDataJudicata": "2026-01-15T12:00:00Z",
"assuntoPrincipal": "EXEMPLO",
"dataEncerramento": "2026-01-15T12:00:00Z",
"razaoDadosOcultos": null,
"tribunalDistrital": null,
"ultimaAtualizacao": "12345678000195",
"dataRedistribuicao": "2026-01-15T12:00:00Z",
"idadeProcessoLegal": "EXEMPLO",
"numeroAtualizacoes": "EXEMPLO",
"dataUltimaMovimentacao": "2026-01-15T12:00:00Z",
"nomeAssuntoCnjInferido": "PESSOA EXEMPLO",
"numeroAssuntoCnjInferido": "EXEMPLO",
"acoesJudiciaisRelacionadas": [],
"numeroMedioAtualizacoesMes": null
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"juiz": "EXEMPLO",
"tipo": "EXEMPLO",
"valor": "EXEMPLO",
"estado": "SP",
"numero": "EXEMPLO",
"status": "REGULAR",
"decisoes": [],
"peticoes": [
{
"_id": "EXEMPLO",
"tipo": "EXEMPLO",
"autor": null,
"dataCriacao": "2026-01-15T12:00:00Z",
"dataEntrada": "2026-01-15T12:00:00Z"
},
{
"_id": "EXEMPLO",
"tipo": "EXEMPLO",
"autor": null,
"dataCriacao": "2026-01-15T12:00:00Z",
"dataEntrada": "2026-01-15T12:00:00Z"
}
],
"dataAviso": "2026-01-15T12:00:00Z",
"envolvidos": [
{
"_id": "EXEMPLO",
"nome": "PESSOA EXEMPLO",
"tipo": "EXEMPLO",
"documento": "12345678909",
"parteAtiva": true,
"polaridade": "EXEMPLO",
"dataUltimaCaptura": "2026-01-15T12:00:00Z",
"detalhesEnvolvido": {
"OAB": null,
"estado": null,
"tipoEspecifico": "EXEMPLO"
}
},
{
"_id": "12345678909",
"nome": "PESSOA EXEMPLO",
"tipo": "EXEMPLO",
"documento": "12345678000195",
"parteAtiva": true,
"polaridade": "EXEMPLO",
"dataUltimaCaptura": "2026-01-15T12:00:00Z",
"detalhesEnvolvido": {
"OAB": null,
"estado": null,
"tipoEspecifico": "EXEMPLO"
}
}
],
"dataCaptura": "2026-01-15T12:00:00Z",
"atualizacoes": [],
"corpoJulgado": "EXEMPLO",
"nomeTribunal": "PESSOA EXEMPLO",
"numeroPartes": "EXEMPLO",
"tipoTribunal": "EXEMPLO",
"numeroPaginas": null,
"numeroVolumes": null,
"dataPublicacao": "2026-01-15T12:00:00Z",
"outrosAssuntos": [
"EXEMPLO"
],
"numeroInstancia": "EXEMPLO",
"resDataJudicata": "2026-01-15T12:00:00Z",
"assuntoPrincipal": "EXEMPLO",
"dataEncerramento": "2026-01-15T12:00:00Z",
"razaoDadosOcultos": null,
"tribunalDistrital": "EXEMPLO",
"ultimaAtualizacao": "12345678000195",
"dataRedistribuicao": "2026-01-15T12:00:00Z",
"idadeProcessoLegal": "EXEMPLO",
"numeroAtualizacoes": "EXEMPLO",
"dataUltimaMovimentacao": "2026-01-15T12:00:00Z",
"nomeAssuntoCnjInferido": "PESSOA EXEMPLO",
"numeroAssuntoCnjInferido": "EXEMPLO",
"acoesJudiciaisRelacionadas": [],
"numeroMedioAtualizacoesMes": null
}
],
"totalAcoesJudiciais": 1,
"dataUltimaAcaoJudicial": "2026-01-15T12:00:00Z",
"totalAcoesJudiciaisReu": 1,
"dataPrimeiraAcaoJudicial": "2026-01-15T12:00:00Z",
"totalAcoesJudiciaisAutor": 1,
"totalAcoesJudiciaisOutro": 1,
"acoesJudiciaisUltimos30Dias": 1,
"acoesJudiciaisUltimos90Dias": 1,
"acoesJudiciaisSegredoJustica": 1,
"acoesJudiciaisUltimos180Dias": 1,
"acoesJudiciaisUltimos365Dias": 1,
"acoesJudiciaisSegundaInstancia": 1,
"acoesJudiciaisPrimeiraInstancia": 1,
"acoesJudiciaisTerceiraInstancia": 1
},
"historicoEndereco": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"cep": "01001000",
"rua": "AVENIDA EXEMPLO, 100",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"estado": "SP",
"numero": "EXEMPLO",
"itemUltimaAtualizacao": "EXEMPLO"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"cep": "01001000",
"rua": "AVENIDA EXEMPLO, 100",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"estado": "SP",
"numero": "EXEMPLO",
"itemUltimaAtualizacao": "EXEMPLO"
}
],
"informacoesCredito": {
"cpf": "12345678909",
"nome": "PESSOA EXEMPLO",
"email": {
"endereco": "AVENIDA EXEMPLO, 100",
"dataUltimaAtualizacao": "2026-01-15"
},
"idade": 35,
"genero": "EXEMPLO",
"celular": {
"numero": "EXEMPLO",
"dataUltimaAtualizacao": "2026-01-15"
},
"nomeMae": "PESSOA EXEMPLO",
"endereco": {
"cep": "01001000",
"rua": "AVENIDA EXEMPLO, 100",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"estado": "SP",
"numero": "EXEMPLO",
"complemento": "EXEMPLO",
"dataUltimaAtualizacao": "2026-01-15"
},
"telefone": {
"numero": "12345678909",
"dataUltimaAtualizacao": "2026-01-15"
},
"cpfStatus": "12345678909",
"dataNascimento": "2026-01-15",
"dataUltimaAtualizacaoNome": "PESSOA EXEMPLO"
},
"consultasAnteriores": {
"consultas31a60Dias": 1,
"consultas61a90Dias": 1,
"consultasMais90Dias": 1,
"consultasUltimos30Dias": 1
},
"dadosCadastraisPFAP": {
"uf": "SP",
"nome": "PESSOA EXEMPLO",
"nomeMae": "PESSOA EXEMPLO",
"endereco": "AVENIDA EXEMPLO, 100",
"situacao": "REGULAR",
"telefone": "11999999999",
"regiaoCPF": "12345678909",
"estadoCivil": "EXEMPLO",
"grauInstrucao": "EXEMPLO",
"rendaPresumida": "EXEMPLO",
"textoRendaPresumida": "EXEMPLO"
},
"debitosTrabalhistas": {
"date": null,
"validity": null,
"requested": null,
"certificate": null,
"certidaoLink": null,
"certificateUrlPartner": null
},
"pendenciasFinanceiras": {
"scpc": {
"moeda": null,
"registros": [],
"quantidade": null,
"valorTotal": null,
"ultimaOcorrencia": null,
"primeiraOcorrencia": null
},
"pefin": {
"detalhes": [],
"maiorValor": 123.45,
"quantidade": 35,
"valorTotal": 123.45,
"dataPrimeiro": null,
"periodoFinal": null,
"valorDevedor": null,
"valorAvalista": null,
"valorPrimeiro": 123.45,
"dataMaiorValor": null,
"periodoInicial": null,
"quantidadeCredores": null,
"dataUltimaOcorrencia": null
},
"refin": {
"detalhes": [],
"quantidade": 35,
"valorTotal": null,
"dataPrimeiro": null,
"dataUltimaOcorrencia": null
}
},
"restricoesFinanceiras": {
"apontamentos": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"cnpj": "12345678000195",
"valor": 123.45,
"endereco": {
"cidade": "SAO PAULO",
"estado": "SP"
},
"natureza": "EXEMPLO",
"nomeEmpresa": "EMPRESA EXEMPLO LTDA",
"dataInclusao": "2026-01-15",
"dataOcorrencia": "2026-01-15",
"numeroContrato": "EXEMPLO",
"tipoParticipante": "EXEMPLO",
"statusApontamento": "REGULAR"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"cnpj": "12345678000195",
"valor": 123.45,
"endereco": {
"cidade": "SAO PAULO",
"estado": "SP"
},
"natureza": "EXEMPLO",
"nomeEmpresa": "EMPRESA EXEMPLO LTDA",
"dataInclusao": "2026-01-15",
"dataOcorrencia": "2026-01-15",
"numeroContrato": "EXEMPLO",
"tipoParticipante": "EXEMPLO",
"statusApontamento": "REGULAR"
}
],
"pendenciasCredito": 1.5,
"dataUltimoApontamento": "2026-01-15"
},
"resumoAcessoPositivoPF": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"total": "EXEMPLO",
"titulo": "EXEMPLO",
"periodoFinal": null,
"periodoInicial": null,
"valorAcumulado": "EXEMPLO"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"total": "EXEMPLO",
"titulo": "EXEMPLO",
"periodoFinal": null,
"periodoInicial": null,
"valorAcumulado": "EXEMPLO"
}
],
"tituloProtestadoAcPosPF": [],
"participacoesOutrasEmpresas": []
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3016Rating Avançado CPF
CPFAvaliação de crédito de pessoa física com score, rating, decisão, renda, restrições e contatos localizados.
Contrato v1
3016
Rating Avançado CPF
CPFAvaliação de crédito de pessoa física com score, rating, decisão, renda, restrições e contatos localizados.
Parâmetros
cpf *Requisição
json
{
"cpf": "12345678909"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3016,
"slug": "rating-avancado-cpf",
"nome": "Rating Avançado CPF",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"VEICULAR": {},
"CREDCADASTRAL": {
"EMAILS": {
"INFOEMAILS": [
{
"ENDERECO": "AVENIDA EXEMPLO, 100"
},
{
"ENDERECO": "AVENIDA EXEMPLO, 100"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"REGISTRO_LOCALIZADO": "EXEMPLO"
},
"CONTATOS": {
"INFOCONTATOS": [
{
"UF": "",
"CEP": "",
"NOME": "PESSOA EXEMPLO",
"IDADE": "",
"BAIRRO": "",
"CIDADE": "",
"RELACAO": "EXEMPLO",
"ENDERECO": "",
"DOCUMENTO": "12345678909",
"NASCIMENTO": "2026-01-15",
"TIPO_PESSOA": ""
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"REGISTRO_LOCALIZADO": "EXEMPLO"
},
"MOTOR_CREDITO": {
"OCORRENCIAS": [
{
"SCORE": "EXEMPLO",
"MENSAGEM": "",
"SITUACAO": "REGULAR",
"TAXA_JUROS": "EXEMPLO",
"QTD_PARCELAS": "EXEMPLO",
"RATING_BACEN": "BAIXO",
"DECISAO_NEGOCIO": "EXEMPLO",
"CREDITO_SUGERIDO": "EXEMPLO",
"PARCELA_SUGERIDA": "EXEMPLO"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
},
"RENDA_PRESUMIDA": {
"FAIXA": "EXEMPLO",
"MENSAGEM": "Informação de exemplo",
"DESCRICAO": "Informação de exemplo",
"RENDA_ANUAL": "EXEMPLO",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"DATA_REFERENCIA": "",
"VALOR_PRESUMIDO": "",
"DADOS_CADASTRO_POSITIVO": ""
},
"SOMENTE_ENDERECO": {
"DADOS": [
{
"UF": "SP",
"CEP": "01001000",
"BAIRRO": "CENTRO",
"CIDADE": "SAO PAULO",
"NUMERO": "EXEMPLO",
"ENDERECO": "AVENIDA EXEMPLO, 100",
"LATITUDE": "",
"DOCUMENTO": "",
"LONGITUDE": "",
"PONTUACAO": "",
"COMPLEMENTO": "",
"TIPO_PESSOA": "",
"COD_IDENTIFICACAO_ENDERECO": ""
},
{
"UF": "SP",
"CEP": "01001000",
"BAIRRO": "CENTRO",
"CIDADE": "SAO PAULO",
"NUMERO": "EXEMPLO",
"ENDERECO": "AVENIDA EXEMPLO, 100",
"LATITUDE": "",
"DOCUMENTO": "",
"LONGITUDE": "",
"PONTUACAO": "",
"COMPLEMENTO": "",
"TIPO_PESSOA": "",
"COD_IDENTIFICACAO_ENDERECO": ""
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"REGISTRO_LOCALIZADO": "EXEMPLO"
},
"SOMENTE_TELEFONE": {
"DADOS": [
{
"DDD": "EXEMPLO",
"DOCUMENTO": "",
"PONTUACAO": "",
"TIPO_PESSOA": "",
"NUM_TELEFONE": "11999999999",
"TIPO_TELEFONE": "11999999999",
"COD_IDENTIFICADAO_TELEFONE": "11999999999"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"REGISTRO_LOCALIZADO": "EXEMPLO"
},
"RESTRICOES_FINANCEIRAS": {
"OCORRENCIAS": [
{
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CREDOR": "EXEMPLO",
"ORIGEM": "EXEMPLO",
"CONTRATO": "EXEMPLO",
"SUBJUDICE": "",
"MODALIDADE": "EXEMPLO",
"TIPO_DEVEDOR": "EXEMPLO",
"DATA_INCLUSAO": "2026-01-15",
"DATA_VENCIMENTO": "2026-01-15"
},
{
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CREDOR": "EXEMPLO",
"ORIGEM": "EXEMPLO",
"CONTRATO": "EXEMPLO",
"SUBJUDICE": "",
"MODALIDADE": "EXEMPLO",
"TIPO_DEVEDOR": "EXEMPLO",
"DATA_INCLUSAO": "2026-01-15",
"DATA_VENCIMENTO": "2026-01-15"
}
],
"VALOR_TOTAL": "EXEMPLO",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"ULTIMO_VENCIMENTO": "",
"PRIMEIRO_VENCIMENTO": "",
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"PARTICIPACAO_EM_EMPRESAS": {
"OCORRENCIAS": [
{
"CNPJ": "",
"PARTICIPACAO": "",
"RAZAO_SOCIAL": "",
"PARTICIPANTE_TIPO": "",
"QTD_OUTROS_SOCIOS": "",
"PARTICIPANTE_CARGO": "",
"PARTICIPANTE_ENTRADA": "",
"PARTICIPANTE_DOCUMENTO": ""
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
},
"IDENTIFICACAO_PESSOA_FISICA": {
"MAE": "PESSOA EXEMPLO",
"NOME": "PESSOA EXEMPLO",
"SEXO": "EXEMPLO",
"EMAIL": "",
"RG_UF": "",
"END_UF": "",
"END_CEP": "",
"NOME_PAI": "",
"TELEFONE": "",
"RG_NUMERO": "EXEMPLO",
"CPF_NUMERO": "12345678909",
"CPF_ORIGEM": "",
"END_BAIRRO": "",
"END_CIDADE": "",
"NASCIMENTO": "2026-01-15",
"NUMERO_PIS": "",
"FAIXA_RENDA": "",
"NOME_SOCIAL": "",
"CPF_SITUACAO": "12345678909",
"ESTADO_CIVIL": "",
"NATURALIDADE": "",
"CLASSE_SOCIAL": "",
"NACIONALIDADE": "",
"END_LOGRADOURO": "",
"GRAU_INSTRUCAO": "EXEMPLO",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"TITULO_ELEITOR": "",
"INDICACAO_OBITO": "EXEMPLO",
"RG_DATA_EMISSAO": "",
"PODER_AQUISITIVO": "",
"NUMERO_DEPENDENTES": "",
"ULTIMO_IMPOSTO_RENDA": "",
"CARTAO_NACIONAL_SAUDE": "",
"CPF_DATA_ATUALIZACAO_RECEITA": "",
"QTD_DEPENDENTES_BOLSA_FAMILIA": ""
},
"INFORMACOES_ALERTAS_RESTRICOES": {
"OCORRENCIAS": [
{
"TITULO": "EXEMPLO",
"OBSERVACOES": "EXEMPLO",
"CODIGO_TIPO_INFORMACAO": "1",
"DESCRICAO_TIPO_INFORMACAO": "Informação de exemplo"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
}
},
"COBRATIVA_DADOS_CADASTRAIS": {
"status": "success",
"version": 1,
"attempted": true,
"source_slug": "ic-cpf-completo",
"response_data": {
"body": {
"data": {
"emails": [],
"filiais": [],
"documento": "12345678909",
"enderecos": [
{
"id": "EXEMPLO",
"uf": "SP",
"_id": "EXEMPLO",
"cep": "01001000",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"numero": "EXEMPLO",
"posicao": null,
"logradouro": "AVENIDA EXEMPLO, 100",
"complemento": "EXEMPLO",
"tipoLogradouro": "AVENIDA EXEMPLO, 100"
},
{
"id": "EXEMPLO",
"uf": "SP",
"_id": "EXEMPLO",
"cep": "01001000",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"numero": "EXEMPLO",
"posicao": null,
"logradouro": "AVENIDA EXEMPLO, 100",
"complemento": null,
"tipoLogradouro": "AVENIDA EXEMPLO, 100"
}
],
"telefones": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"ddd": "EXEMPLO",
"tipo": "EXEMPLO",
"posicao": null,
"telefone": "11999999999"
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"ddd": "EXEMPLO",
"tipo": "EXEMPLO",
"posicao": null,
"telefone": "11999999999"
}
],
"rendaPresumida": "EXEMPLO",
"dadosCadastrais": {
"rg": null,
"nome": "PESSOA EXEMPLO",
"sexo": "EXEMPLO",
"ufRg": null,
"email": null,
"idade": "EXEMPLO",
"signo": "EXEMPLO",
"cpfMae": "12345678909",
"endCep": "01001000",
"endNum": "EXEMPLO",
"telDdd": "EXEMPLO",
"telNum": "EXEMPLO",
"nomeMae": "PESSOA EXEMPLO",
"documento": "12345678909",
"endBairro": "CENTRO",
"endCidade": "SAO PAULO",
"endEstado": "EXEMPLO",
"faixaIdade": null,
"situacaoCpf": "12345678909",
"endLogradouro": "AVENIDA EXEMPLO, 100",
"tituloEleitor": null,
"dataNascimento": "2026-01-15",
"endComplemento": "EXEMPLO",
"dataSituacaoCpf": null,
"endTipoLogradouro": "AVENIDA EXEMPLO, 100"
},
"participacoesSocietarias": []
},
"type": "EXEMPLO",
"error": null,
"customQuery": false,
"servicesBroken": []
},
"status": {
"cod": 1,
"msg": "EXEMPLO"
}
}
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3017Rating Estágios CPF
CPFAvaliação de crédito de pessoa física com score, estágio de risco, decisão do motor, dados cadastrais, renda, restrições e contatos.
Contrato v1
3017
Rating Estágios CPF
CPFAvaliação de crédito de pessoa física com score, estágio de risco, decisão do motor, dados cadastrais, renda, restrições e contatos.
Parâmetros
cpf *Requisição
json
{
"cpf": "12345678909"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3017,
"slug": "rating-score-cpf",
"nome": "Rating Estágios CPF",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"VEICULAR": {},
"CREDCADASTRAL": {
"EMAILS": {
"INFOEMAILS": [
{
"ENDERECO": "AVENIDA EXEMPLO, 100"
},
{
"ENDERECO": "AVENIDA EXEMPLO, 100"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"REGISTRO_LOCALIZADO": "EXEMPLO"
},
"CONTATOS": {
"INFOCONTATOS": [
{
"UF": "",
"CEP": "",
"NOME": "PESSOA EXEMPLO",
"IDADE": "",
"BAIRRO": "",
"CIDADE": "",
"RELACAO": "EXEMPLO",
"ENDERECO": "",
"DOCUMENTO": "12345678909",
"NASCIMENTO": "2026-01-15",
"TIPO_PESSOA": ""
},
{
"UF": "",
"CEP": "",
"NOME": "PESSOA EXEMPLO",
"IDADE": "",
"BAIRRO": "",
"CIDADE": "",
"RELACAO": "EXEMPLO",
"ENDERECO": "",
"DOCUMENTO": "12345678909",
"NASCIMENTO": "2026-01-15",
"TIPO_PESSOA": ""
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"REGISTRO_LOCALIZADO": "EXEMPLO"
},
"MOTOR_CREDITO": {
"OCORRENCIAS": [
{
"SCORE": "EXEMPLO",
"MENSAGEM": "",
"SITUACAO": "REGULAR",
"TAXA_JUROS": "EXEMPLO",
"QTD_PARCELAS": "EXEMPLO",
"RATING_BACEN": "BAIXO",
"DECISAO_NEGOCIO": "EXEMPLO",
"CREDITO_SUGERIDO": "EXEMPLO",
"PARCELA_SUGERIDA": "EXEMPLO"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
},
"RENDA_PRESUMIDA": {
"FAIXA": "EXEMPLO",
"MENSAGEM": "Informação de exemplo",
"DESCRICAO": "Informação de exemplo",
"RENDA_ANUAL": "EXEMPLO",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"DATA_REFERENCIA": "",
"VALOR_PRESUMIDO": "",
"DADOS_CADASTRO_POSITIVO": ""
},
"SOMENTE_ENDERECO": {
"DADOS": [
{
"UF": "SP",
"CEP": "01001000",
"BAIRRO": "CENTRO",
"CIDADE": "SAO PAULO",
"NUMERO": "EXEMPLO",
"ENDERECO": "AVENIDA EXEMPLO, 100",
"LATITUDE": "",
"DOCUMENTO": "",
"LONGITUDE": "",
"PONTUACAO": "",
"COMPLEMENTO": "",
"TIPO_PESSOA": "",
"COD_IDENTIFICACAO_ENDERECO": ""
},
{
"UF": "SP",
"CEP": "01001000",
"BAIRRO": "CENTRO",
"CIDADE": "SAO PAULO",
"NUMERO": "EXEMPLO",
"ENDERECO": "AVENIDA EXEMPLO, 100",
"LATITUDE": "",
"DOCUMENTO": "",
"LONGITUDE": "",
"PONTUACAO": "",
"COMPLEMENTO": "",
"TIPO_PESSOA": "",
"COD_IDENTIFICACAO_ENDERECO": ""
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"REGISTRO_LOCALIZADO": "EXEMPLO"
},
"SOMENTE_TELEFONE": {
"DADOS": [
{
"DDD": "EXEMPLO",
"DOCUMENTO": "",
"PONTUACAO": "",
"TIPO_PESSOA": "",
"NUM_TELEFONE": "11999999999",
"TIPO_TELEFONE": "11999999999",
"COD_IDENTIFICADAO_TELEFONE": "11999999999"
},
{
"DDD": "EXEMPLO",
"DOCUMENTO": "",
"PONTUACAO": "",
"TIPO_PESSOA": "",
"NUM_TELEFONE": "11999999999",
"TIPO_TELEFONE": "11999999999",
"COD_IDENTIFICADAO_TELEFONE": "11999999999"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"REGISTRO_LOCALIZADO": "EXEMPLO"
},
"RESTRICOES_FINANCEIRAS": {
"OCORRENCIAS": [
{
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CREDOR": "EXEMPLO",
"ORIGEM": "EXEMPLO",
"CONTRATO": "12345678909",
"SUBJUDICE": "",
"MODALIDADE": "EXEMPLO",
"TIPO_DEVEDOR": "EXEMPLO",
"DATA_INCLUSAO": "2026-01-15",
"DATA_VENCIMENTO": "2026-01-15"
},
{
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CREDOR": "EXEMPLO",
"ORIGEM": "EXEMPLO",
"CONTRATO": "12345678909",
"SUBJUDICE": "",
"MODALIDADE": "EXEMPLO",
"TIPO_DEVEDOR": "EXEMPLO",
"DATA_INCLUSAO": "2026-01-15",
"DATA_VENCIMENTO": "2026-01-15"
}
],
"VALOR_TOTAL": "EXEMPLO",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"ULTIMO_VENCIMENTO": "",
"PRIMEIRO_VENCIMENTO": "",
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"PARTICIPACAO_EM_EMPRESAS": {
"OCORRENCIAS": [
{
"CNPJ": "12345678000195",
"PARTICIPACAO": "EXEMPLO",
"RAZAO_SOCIAL": "EMPRESA EXEMPLO LTDA",
"PARTICIPANTE_TIPO": "",
"QTD_OUTROS_SOCIOS": "",
"PARTICIPANTE_CARGO": "",
"PARTICIPANTE_ENTRADA": "",
"PARTICIPANTE_DOCUMENTO": ""
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
},
"IDENTIFICACAO_PESSOA_FISICA": {
"MAE": "PESSOA EXEMPLO",
"NOME": "PESSOA EXEMPLO",
"SEXO": "EXEMPLO",
"EMAIL": "",
"RG_UF": "",
"END_UF": "",
"END_CEP": "",
"NOME_PAI": "",
"TELEFONE": "",
"RG_NUMERO": "EXEMPLO",
"CPF_NUMERO": "12345678909",
"CPF_ORIGEM": "",
"END_BAIRRO": "",
"END_CIDADE": "",
"NASCIMENTO": "2026-01-15",
"NUMERO_PIS": "",
"FAIXA_RENDA": "",
"NOME_SOCIAL": "",
"CPF_SITUACAO": "12345678909",
"ESTADO_CIVIL": "",
"NATURALIDADE": "",
"CLASSE_SOCIAL": "",
"NACIONALIDADE": "",
"END_LOGRADOURO": "",
"GRAU_INSTRUCAO": "",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"TITULO_ELEITOR": "",
"INDICACAO_OBITO": "EXEMPLO",
"RG_DATA_EMISSAO": "",
"PODER_AQUISITIVO": "",
"NUMERO_DEPENDENTES": "",
"ULTIMO_IMPOSTO_RENDA": "",
"CARTAO_NACIONAL_SAUDE": "",
"CPF_DATA_ATUALIZACAO_RECEITA": "",
"QTD_DEPENDENTES_BOLSA_FAMILIA": ""
},
"INFORMACOES_ALERTAS_RESTRICOES": {
"OCORRENCIAS": [
{
"TITULO": "EXEMPLO",
"OBSERVACOES": "EXEMPLO",
"CODIGO_TIPO_INFORMACAO": "1",
"DESCRICAO_TIPO_INFORMACAO": "Informação de exemplo"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
}
},
"COBRATIVA_DADOS_CADASTRAIS": {
"status": "success",
"version": 1,
"attempted": true,
"source_slug": "ic-cpf-completo",
"response_data": {
"body": {
"data": {
"emails": [],
"filiais": [],
"documento": "12345678909",
"enderecos": [
{
"id": "12345678000195",
"uf": "SP",
"_id": "12345678000195",
"cep": "01001000",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"numero": "EXEMPLO",
"posicao": null,
"logradouro": "AVENIDA EXEMPLO, 100",
"complemento": null,
"tipoLogradouro": "AVENIDA EXEMPLO, 100"
},
{
"id": "EXEMPLO",
"uf": "SP",
"_id": "EXEMPLO",
"cep": "01001000",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"numero": "EXEMPLO",
"posicao": null,
"logradouro": "AVENIDA EXEMPLO, 100",
"complemento": null,
"tipoLogradouro": "AVENIDA EXEMPLO, 100"
}
],
"telefones": [
{
"id": "12345678000195",
"_id": "12345678000195",
"ddd": "EXEMPLO",
"tipo": "EXEMPLO",
"posicao": null,
"telefone": "11999999999"
},
{
"id": "12345678000195",
"_id": "12345678000195",
"ddd": "EXEMPLO",
"tipo": "EXEMPLO",
"posicao": null,
"telefone": "11999999999"
}
],
"rendaPresumida": "EXEMPLO",
"dadosCadastrais": {
"rg": null,
"nome": "PESSOA EXEMPLO",
"sexo": "EXEMPLO",
"ufRg": null,
"email": null,
"idade": "EXEMPLO",
"signo": "EXEMPLO",
"cpfMae": "12345678909",
"endCep": "01001000",
"endNum": "EXEMPLO",
"telDdd": "EXEMPLO",
"telNum": "EXEMPLO",
"nomeMae": "PESSOA EXEMPLO",
"documento": "12345678909",
"endBairro": "CENTRO",
"endCidade": "SAO PAULO",
"endEstado": "EXEMPLO",
"faixaIdade": null,
"situacaoCpf": "12345678909",
"endLogradouro": "AVENIDA EXEMPLO, 100",
"tituloEleitor": null,
"dataNascimento": "2026-01-15",
"endComplemento": null,
"dataSituacaoCpf": null,
"endTipoLogradouro": "AVENIDA EXEMPLO, 100"
},
"participacoesSocietarias": [
{
"id": "12345678000195",
"_id": "12345678000195",
"nome": "PESSOA EXEMPLO",
"posicao": null,
"dataSaida": null,
"documento": "12345678000195",
"dataEntrada": "2026-01-15",
"participacao": "EXEMPLO",
"qualificacaoSocio": null,
"representanteLegal": null
}
]
},
"type": "EXEMPLO",
"error": null,
"customQuery": false,
"servicesBroken": []
},
"status": {
"cod": 1,
"msg": "EXEMPLO"
}
}
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3018Rating Raio X CPF
CPFAnálise de pessoa física com scores e ratings, renda, comportamento de pagamento, restrições, participações em empresas, dados complementares da Base II, SCR/Bacen e processos judiciais.
Contrato v1
3018
Rating Raio X CPF
CPFAnálise de pessoa física com scores e ratings, renda, comportamento de pagamento, restrições, participações em empresas, dados complementares da Base II, SCR/Bacen e processos judiciais.
Parâmetros
cpf *Requisição
json
{
"cpf": "12345678909"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3018,
"slug": "rating-raio-x-cpf",
"nome": "Rating Raio X CPF",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"data": "2026-01-15",
"hora": "EXEMPLO",
"renda": {
"renda_presumida": "EXEMPLO",
"capacidade_pagamento": 35
},
"operacoes": {
"registros": [
{
"total": "EXEMPLO",
"modalidade": "EXEMPLO",
"percentual": "EXEMPLO",
"subdominio": "EXEMPLO",
"variacao_cambial": "EXEMPLO",
"codigo_modalidade": "1"
},
{
"total": "EXEMPLO",
"modalidade": "EXEMPLO",
"percentual": "EXEMPLO",
"subdominio": "EXEMPLO",
"variacao_cambial": "EXEMPLO",
"codigo_modalidade": "1"
}
],
"risco_total": "BAIXO",
"carteira_de_credito": "EXEMPLO",
"responsabilidade_total": "EXEMPLO"
},
"prejuizos": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"valor_total": "EXEMPLO"
},
"protocolo": "EXEMPLO",
"scr_score": {
"valor": null,
"importante": "EXEMPLO",
"observacao": "Informação de exemplo"
},
"dados_bacen": {
"resumo_geral_scr": {
"documento": "12345678909",
"tipo_de_documento": "12345678909",
"coobrigacao_assumida": "EXEMPLO",
"coobrigacao_recebida": "EXEMPLO",
"data_base_consultada": "2026-01-15"
},
"quantidade_de_operacoes": 35,
"inicio_do_relacionamento": "PESSOA EXEMPLO",
"quantidade_de_instituicoes": 35,
"indicadores_de_confiabilidade": {
"total_subjudice": "EXEMPLO",
"total_discordancia": "EXEMPLO",
"operacoes_subjudice": 1,
"risco_indireto_vendor": "BAIXO",
"operacoes_em_discordancia": 1,
"percentual_de_volume_processado": "EXEMPLO",
"percentual_de_documentos_processados": "12345678909"
}
},
"informativo": "EXEMPLO",
"localizacao": {
"uf": "SP",
"cep": "01001000",
"bairro": "CENTRO",
"cidade": "SAO PAULO",
"latitude": "",
"longitude": "",
"area_risco": "BAIXO",
"logradouro": "AVENIDA EXEMPLO, 100",
"complemento": "EXEMPLO"
},
"motor_credito": {
"score": 750,
"credito": "EXEMPLO",
"parcelas": "EXEMPLO",
"taxaJuros": "EXEMPLO",
"ratingBacen": "BAIXO",
"valorParcelaSugerida": "EXEMPLO",
"valorEmprestimoSugerido": "EXEMPLO"
},
"nome_consulta": "PESSOA EXEMPLO",
"dividas_ativas": {
"bb": 1,
"anm": 1,
"fgts": 1,
"sida": 1,
"bacen": 1,
"total": 1,
"previdencia": 1
},
"credito_vencido": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"valor_total": "EXEMPLO"
},
"cheques_sustados": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"registros": []
},
"credito_a_vencer": {
"total": {
"valor": "EXEMPLO",
"qtd_meses": null,
"percentual": "EXEMPLO"
},
"registros": [
{
"valor": "EXEMPLO",
"descricao": "Informação de exemplo",
"qtd_meses": 1,
"percentual": "EXEMPLO"
},
{
"valor": "EXEMPLO",
"descricao": "Informação de exemplo",
"qtd_meses": 1,
"percentual": "EXEMPLO"
}
]
},
"dados_cadastrais": {
"rg": "EXEMPLO",
"cpf": "12345678909",
"sexo": "EXEMPLO",
"email": "exemplo@empresa.com.br",
"idade": "EXEMPLO",
"celular": "11999999999",
"origem_cpf": "12345678909",
"nome_da_mae": "PESSOA EXEMPLO",
"estado_civil": "EXEMPLO",
"situacao_cpf": "12345678909",
"nome_completo": "PESSOA EXEMPLO",
"orgao_emissor": "EXEMPLO",
"data_nascimento": "2026-01-15",
"grau_de_instrucao": "EXEMPLO",
"titulo_de_eleitor": "EXEMPLO"
},
"score_de_credito": {
"score": 750,
"texto": "EXEMPLO",
"modelo": "EXEMPLO",
"rating": {
"escala": [
"EXEMPLO",
"EXEMPLO"
],
"descritivo": "EXEMPLO",
"observacao": "Informação de exemplo",
"classificacao_numerica": "BAIXO",
"classificacao_alfabetica": "BAIXO"
},
"natureza": "EXEMPLO",
"status_do_consumidor": {
"mensagem": "Informação de exemplo",
"situacao": "REGULAR"
},
"probabilidade_inadimplencia": "EXEMPLO"
},
"cheques_sem_fundo": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"registros": []
},
"faturas_em_atraso": {
"nota": "EXEMPLO",
"escala": [
"EXEMPLO",
"EXEMPLO"
],
"descricao": "Informação de exemplo"
},
"limite_de_credito": {
"status": "REGULAR",
"registros": [
{
"valor": "EXEMPLO",
"descricao": "Informação de exemplo"
},
{
"valor": "EXEMPLO",
"descricao": "Informação de exemplo"
}
],
"valor_total": "EXEMPLO"
},
"contratos_recentes": {
"nota": "EXEMPLO",
"escala": [
"EXEMPLO",
"EXEMPLO"
],
"descricao": "Informação de exemplo"
},
"titulos_protestados": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"registros": [
{
"UF": "SP",
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CIDADE": "SAO PAULO",
"CARTORIO": "EXEMPLO",
"REGISTRO": "EXEMPLO",
"TIPOREGISTRO": "EXEMPLO",
"DATAOCORRENCIA": "2026-01-15",
"TIPOOCORRENCIA": "EXEMPLO",
"TAMANHOREGISTRO": "EXEMPLO"
},
{
"UF": "SP",
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CIDADE": "SAO PAULO",
"CARTORIO": "EXEMPLO",
"REGISTRO": "EXEMPLO",
"TIPOREGISTRO": "EXEMPLO",
"DATAOCORRENCIA": "2026-01-15",
"TIPOOCORRENCIA": "EXEMPLO",
"TAMANHOREGISTRO": "EXEMPLO"
}
]
},
"alerta_de_restricoes": {
"com_ocorrencias": {
"blocos": [
{
"status": "REGULAR",
"titulo": "EXEMPLO",
"detalhes": [
{
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"valor_total": "EXEMPLO"
}
],
"ocorrencias": 1
},
{
"status": "REGULAR",
"titulo": "EXEMPLO",
"detalhes": [
{
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"valor_total": "EXEMPLO"
}
],
"ocorrencias": 1
}
],
"quantidade_blocos": 35
},
"sem_ocorrencias": {
"blocos": [
{
"status": "REGULAR",
"titulo": "EXEMPLO",
"mensagem": "Informação de exemplo"
},
{
"status": "REGULAR",
"titulo": "EXEMPLO",
"mensagem": "Informação de exemplo"
}
],
"quantidade_blocos": 35
}
},
"operacoes_detalhadas": [
{
"total": "EXEMPLO",
"modalidade": "EXEMPLO",
"percentual": "EXEMPLO",
"subdominio": "EXEMPLO",
"vencimentos": [
{
"meses": 1,
"valor": "EXEMPLO",
"codigo": "1",
"descricao": "Informação de exemplo",
"percentual": "EXEMPLO",
"restritivo": "EXEMPLO"
},
{
"meses": 1,
"valor": "EXEMPLO",
"codigo": "1",
"descricao": "Informação de exemplo",
"percentual": "EXEMPLO",
"restritivo": "EXEMPLO"
}
],
"variacao_cambial": "EXEMPLO",
"codigo_modalidade": "1"
},
{
"total": "EXEMPLO",
"modalidade": "EXEMPLO",
"percentual": "EXEMPLO",
"subdominio": "EXEMPLO",
"vencimentos": [
{
"meses": null,
"valor": "EXEMPLO",
"codigo": "1",
"descricao": "Informação de exemplo",
"percentual": "EXEMPLO",
"restritivo": "EXEMPLO"
}
],
"variacao_cambial": "EXEMPLO",
"codigo_modalidade": "1"
}
],
"pagamentos_adiantados": {
"nota": null,
"escala": [
"EXEMPLO",
"EXEMPLO"
],
"descricao": "Informação de exemplo",
"observacao": "Informação de exemplo"
},
"score_rating_bancario": {
"valor": 123.45,
"rating": "BAIXO",
"status": "REGULAR",
"categoria": "EXEMPLO",
"juros_faixa": "EXEMPLO",
"perfil_risco": "BAIXO",
"probabilidade_pagamento": "EXEMPLO",
"comparativo_faixa_etaria": "EXEMPLO",
"probabilidade_inadimplencia": "EXEMPLO"
},
"historico_de_consultas": [
{
"data": "2026-01-15",
"empresa": "EMPRESA EXEMPLO LTDA"
},
{
"data": "2026-01-15",
"empresa": "EMPRESA EXEMPLO LTDA"
}
],
"minuta_declaracao_lgpd": "EXEMPLO",
"score_de_risco_base_ii": {
"importante": "EXEMPLO",
"score_de_risco": {
"faixa": "EXEMPLO",
"valor": 123.45,
"escala": "EXEMPLO"
},
"probabilidade_de_inadimplencia": {
"valor": "EXEMPLO",
"descricao": "Informação de exemplo"
}
},
"informacoes_importantes": "EXEMPLO",
"dados_cadastrais_base_ii": {
"nome": "PESSOA EXEMPLO",
"idade": "EXEMPLO",
"situacao": "REGULAR",
"documento": "12345678909",
"nascimento": "2026-01-15",
"nome_da_mae": "PESSOA EXEMPLO",
"tipo_pessoa": "EXEMPLO",
"data_situacao": ""
},
"decisao_negociar_cliente": false,
"indicador_comportamental": {
"contratos_recentes": "EXEMPLO",
"nota_comportamental": "EXEMPLO",
"valor_total_dividas": 123.45,
"score_comportamental": 750
},
"negativacoes_registradas": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"registros": [
{
"UF": "SP",
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CIDADE": "SAO PAULO",
"CONDICAO": "EXEMPLO",
"CONTRATO": "EXEMPLO",
"REGISTRO": "EXEMPLO",
"SITUACAO": "REGULAR",
"INFORMANTE": "EXEMPLO",
"TIPOREGISTRO": "EXEMPLO",
"DATAOCORRENCIA": "2026-01-15",
"TIPOOCORRENCIA": "EXEMPLO",
"TAMANHOREGISTRO": "EXEMPLO",
"CONDICAOMUNICIPIO": "SAO PAULO",
"DATADISPONIBILIZACAO": "2026-01-15",
"INFORMADOPELOCONSULENTE": "EXEMPLO"
},
{
"UF": "SP",
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CIDADE": "SAO PAULO",
"CONDICAO": "EXEMPLO",
"CONTRATO": "EXEMPLO",
"REGISTRO": "EXEMPLO",
"SITUACAO": "REGULAR",
"INFORMANTE": "EXEMPLO",
"TIPOREGISTRO": "EXEMPLO",
"DATAOCORRENCIA": "2026-01-15",
"TIPOOCORRENCIA": "EXEMPLO",
"TAMANHOREGISTRO": "EXEMPLO",
"CONDICAOMUNICIPIO": "SAO PAULO",
"DATADISPONIBILIZACAO": "2026-01-15",
"INFORMADOPELOCONSULENTE": "EXEMPLO"
}
]
},
"participacao_em_empresas": [
{
"cnae": null,
"cnpj": "12345678000195",
"funcao": "EXEMPLO",
"empresa": "EMPRESA EXEMPLO LTDA",
"entrada": "EXEMPLO",
"status_rf": "REGULAR",
"descricao_cnae": null,
"capital_participacao": "EXEMPLO",
"participacao_percentual": "EXEMPLO"
},
{
"cnae": null,
"cnpj": "12345678000195",
"funcao": "EXEMPLO",
"empresa": "EMPRESA EXEMPLO LTDA",
"entrada": "EXEMPLO",
"status_rf": "REGULAR",
"descricao_cnae": null,
"capital_participacao": "EXEMPLO",
"participacao_percentual": "EXEMPLO"
}
],
"cheques_sem_fundo_base_ii": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"registros": [],
"quantidade": 35,
"valor_total": "EXEMPLO"
},
"pontualidade_de_pagamento": {
"observacao": "Informação de exemplo",
"cartao_de_credito": null,
"operacoes_parceladas": null
},
"acoes_e_processos_judiciais": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"processos": [
{
"valor": "EXEMPLO",
"status": "REGULAR",
"tribunal": "EXEMPLO",
"tipo_acao": "",
"distribuicao": "",
"numero_processo": ""
},
{
"valor": "EXEMPLO",
"status": "REGULAR",
"tribunal": "EXEMPLO",
"tipo_acao": "",
"distribuicao": "",
"numero_processo": ""
}
],
"total_de_processos": 1,
"ultima_distribuicao": null,
"valor_medio_da_causa": "EXEMPLO",
"valor_total_das_causas": "EXEMPLO"
},
"titulos_protestados_base_ii": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"registros": [
{
"uf": "SP",
"data": "2026-01-15",
"valor": 123.45,
"cidade": "SAO PAULO",
"cartorio": "EXEMPLO",
"data_protesto": "2026-01-15"
},
{
"uf": "SP",
"data": "2026-01-15",
"valor": 123.45,
"cidade": "SAO PAULO",
"cartorio": "EXEMPLO",
"data_protesto": "2026-01-15"
}
],
"quantidade": 35,
"valor_total": "EXEMPLO"
},
"falencia_recuperacao_judicial": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo"
},
"historico_de_consultas_base_ii": {
"registros": [
{
"data": "2026-01-15",
"segmento": "EXEMPLO",
"quantidade": 35
},
{
"data": "2026-01-15",
"segmento": "EXEMPLO",
"quantidade": 35
}
],
"resumo_mensal": [
{
"mes_ano": "EXEMPLO",
"ocorrencias": 1
},
{
"mes_ano": "EXEMPLO",
"ocorrencias": 1
}
],
"quantidade_total": 35
},
"pendencias_financeiras_base_ii": {
"resumo": {
"pefin": {
"quantidade": 35,
"valor_total": "EXEMPLO"
},
"refin": {
"quantidade": 35,
"valor_total": "EXEMPLO"
},
"pendencias_vencidas": {
"quantidade": 35,
"valor_total": "EXEMPLO"
}
},
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo",
"registros": [
{
"data": "2026-01-15",
"tipo": "EXEMPLO",
"valor": 123.45,
"credor": "EXEMPLO",
"natureza": "EXEMPLO",
"data_entrada": "2026-01-15"
},
{
"data": "2026-01-15",
"tipo": "EXEMPLO",
"valor": 123.45,
"credor": "EXEMPLO",
"natureza": "EXEMPLO",
"data_entrada": "2026-01-15"
}
],
"quantidade": 35
},
"avaliacao_preliminar_de_credito": {
"importante": "EXEMPLO",
"score_de_risco": {
"valor": 123.45,
"escala": "EXEMPLO",
"mensagem": "Informação de exemplo"
},
"renda_presumida": {
"faixa": "EXEMPLO",
"descricao": "Informação de exemplo"
},
"negociacao_recomendada": "EXEMPLO",
"probabilidade_de_inadimplencia": {
"valor": null,
"observacao": "Informação de exemplo"
}
},
"participacao_em_empresas_base_ii": [],
"resumo_de_consultas_ultimos_meses": {
"periodos": [
{
"mes_ano": "EXEMPLO",
"periodo": "EXEMPLO",
"consultas": 1
},
{
"mes_ano": "EXEMPLO",
"periodo": "EXEMPLO",
"consultas": 1
}
],
"total_no_periodo": {
"total": 1,
"intervalo": "EXEMPLO"
}
},
"cadin_divida_ativa_uniao_receita_federal": {
"status": "REGULAR",
"mensagem": "Informação de exemplo",
"descricao": "Informação de exemplo"
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
1895Restrições Quod + Ações Judiciais CPF
CPFScore, pendências financeiras, protestos, cheques sem fundos e ações cíveis do CPF.
Contrato v20180521
1895
Restrições Quod + Ações Judiciais CPF
CPFScore, pendências financeiras, protestos, cheques sem fundos e ações cíveis do CPF.
Parâmetros
cpf *Requisição
json
{
"cpf": "12345678909"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 1895,
"slug": "risco-acoes-judiciais-cpf",
"nome": "Restrições Quod + Ações Judiciais CPF",
"versao": "20180521"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"VEICULAR": {},
"CREDCADASTRAL": {
"SCORES": {
"OCORRENCIAS": [
{
"RISCO": "BAIXO",
"SCORE": "EXEMPLO",
"TEXTO": "EXEMPLO",
"LAYOUT": "EXEMPLO",
"EXECUCAO": "EXEMPLO",
"INFORMANTE": "EXEMPLO",
"TIPO_SCORE": "EXEMPLO",
"CLASSIF_ABC": "EXEMPLO",
"CLASSIF_NRO": "EXEMPLO",
"DESCR_PLANO": "EXEMPLO",
"DESCR_SCORE": "EXEMPLO",
"MODELO_SCORE": "",
"PROBABILIDADE_INADIMPLENCIA": "EXEMPLO"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
},
"PROTESTOS": {
"DATA_MAIOR": "",
"DATA_ULTIMO": "",
"OCORRENCIAS": [
{
"DATA": "2026-01-15",
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CREDOR": "EXEMPLO",
"ORIGEM": "EXEMPLO",
"ANUENCIA": "",
"CARTORIO": "EXEMPLO",
"SUBJUDICE": "EXEMPLO",
"QUANTIDADE": "EXEMPLO",
"VENCIMENTO": "EXEMPLO",
"VALOR_CUSTAS": "",
"TIPO_ANOTACAO": "EXEMPLO"
},
{
"DATA": "2026-01-15",
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CREDOR": "EXEMPLO",
"ORIGEM": "EXEMPLO",
"ANUENCIA": "",
"CARTORIO": "EXEMPLO",
"SUBJUDICE": "EXEMPLO",
"QUANTIDADE": "EXEMPLO",
"VENCIMENTO": "EXEMPLO",
"VALOR_CUSTAS": "",
"TIPO_ANOTACAO": "EXEMPLO"
}
],
"VALOR_MAIOR": "",
"VALOR_TOTAL": "EXEMPLO",
"VALOR_ULTIMO": "",
"DATA_PRIMEIRO": "",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"VALOR_PRIMEIRO": "",
"ULTIMO_PROTESTO": "",
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"ACOES_CIVEIS": {
"DATA_MAIOR": "",
"DATA_MENOR": "",
"DATA_ULTIMO": "",
"OCORRENCIAS": [
{
"ACAO": "EXEMPLO",
"FORO": "EXEMPLO",
"VARA": "EXEMPLO",
"AUTOR": "EXEMPLO",
"VALOR": "EXEMPLO",
"ORIGEM": "EXEMPLO",
"COMARCA": "EXEMPLO",
"PROCESSO": "EXEMPLO",
"DOCUMENTO": "12345678909",
"REQUERIDO": "EXEMPLO",
"DATA_DISTRIBUICAO": "2026-01-15"
},
{
"ACAO": "EXEMPLO",
"FORO": "EXEMPLO",
"VARA": "EXEMPLO",
"AUTOR": "EXEMPLO",
"VALOR": "EXEMPLO",
"ORIGEM": "EXEMPLO",
"COMARCA": "EXEMPLO",
"PROCESSO": "EXEMPLO",
"DOCUMENTO": "12345678909",
"REQUERIDO": "EXEMPLO",
"DATA_DISTRIBUICAO": "2026-01-15"
}
],
"VALOR_MAIOR": "",
"VALOR_MENOR": "",
"VALOR_TOTAL": "",
"VALOR_ULTIMO": "",
"DATA_PRIMEIRO": "",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"VALOR_PRIMEIRO": "",
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"PEND_FINANCEIRAS": {
"DATA_MAIOR": "",
"PROVEDORES": [
{
"VALOR_CALCULADO": "EXEMPLO",
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
}
],
"OCORRENCIAS": [
{
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CREDOR": "EXEMPLO",
"ORIGEM": "EXEMPLO",
"CONTRATO": "EXEMPLO",
"ENTIDADE": "",
"SUBJUDICE": "",
"INFORMANTE": "EXEMPLO",
"MODALIDADE": "EXEMPLO",
"TIPO_DEVEDOR": "EXEMPLO",
"DATA_INCLUSAO": "2026-01-15",
"DATA_VENCIMENTO": "2026-01-15"
},
{
"MOEDA": "EXEMPLO",
"VALOR": "EXEMPLO",
"CREDOR": "EXEMPLO",
"ORIGEM": "EXEMPLO",
"CONTRATO": "EXEMPLO",
"ENTIDADE": "",
"SUBJUDICE": "",
"INFORMANTE": "EXEMPLO",
"MODALIDADE": "EXEMPLO",
"TIPO_DEVEDOR": "EXEMPLO",
"DATA_INCLUSAO": "2026-01-15",
"DATA_VENCIMENTO": "2026-01-15"
}
],
"VALOR_MAIOR": "",
"VALOR_TOTAL": "EXEMPLO",
"DATA_PRIMEIRO": "",
"PERIODO_FINAL": "",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"TOTAL_CREDORES": "",
"VALOR_PRIMEIRO": "",
"PERIODO_INICIAL": "",
"ULTIMO_VENCIMENTO": "EXEMPLO",
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"CH_SEM_FUNDOS_BACEN": {
"CPFCNPJ": "",
"CORRENTISTA": "",
"OCORRENCIAS": [],
"TIPO_PESSOA": "",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"INFORMACOES_ALERTAS_RESTRICOES": {
"OCORRENCIAS": [
{
"TITULO": "EXEMPLO",
"OBSERVACOES": "EXEMPLO",
"CODIGO_TIPO_INFORMACAO": "1",
"DESCRICAO_TIPO_INFORMACAO": "Informação de exemplo"
},
{
"TITULO": "EXEMPLO",
"OBSERVACOES": "EXEMPLO",
"CODIGO_TIPO_INFORMACAO": "1",
"DESCRICAO_TIPO_INFORMACAO": "Informação de exemplo"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
}
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3019Score Boa Vista + Cadastro CPF
CPFScore, Cadastro Positivo, pendências, protestos e perfil cadastral do CPF.
Contrato v1
3019
Score Boa Vista + Cadastro CPF
CPFScore, Cadastro Positivo, pendências, protestos e perfil cadastral do CPF.
Parâmetros
cpf *Requisição
json
{
"cpf": "12345678909"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3019,
"slug": "score-cadastro-cpf",
"nome": "Score Boa Vista + Cadastro CPF",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"VEICULAR": {},
"CREDCADASTRAL": {
"EMAILS": {
"INFOEMAILS": [
{
"ENDERECO": ""
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"REGISTRO_LOCALIZADO": "EXEMPLO"
},
"SCORES": {
"OCORRENCIAS": [
{
"RISCO": "BAIXO",
"SCORE": "EXEMPLO",
"TEXTO": "12345678909",
"LAYOUT": "EXEMPLO",
"EXECUCAO": "EXEMPLO",
"INFORMANTE": "EXEMPLO",
"TIPO_SCORE": "EXEMPLO",
"CLASSIF_ABC": "EXEMPLO",
"CLASSIF_NRO": "EXEMPLO",
"DESCR_PLANO": "EXEMPLO",
"DESCR_SCORE": "EXEMPLO",
"MODELO_SCORE": "",
"PROBABILIDADE_INADIMPLENCIA": "EXEMPLO"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
},
"CONTATOS": {
"INFOCONTATOS": [
{
"UF": "",
"CEP": "",
"NOME": "PESSOA EXEMPLO",
"IDADE": "",
"BAIRRO": "",
"CIDADE": "",
"RELACAO": "EXEMPLO",
"ENDERECO": "",
"DOCUMENTO": "12345678909",
"NASCIMENTO": "2026-01-15",
"TIPO_PESSOA": ""
},
{
"UF": "",
"CEP": "",
"NOME": "PESSOA EXEMPLO",
"IDADE": "",
"BAIRRO": "",
"CIDADE": "",
"RELACAO": "EXEMPLO",
"ENDERECO": "",
"DOCUMENTO": "12345678909",
"NASCIMENTO": "2026-01-15",
"TIPO_PESSOA": ""
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"REGISTRO_LOCALIZADO": "EXEMPLO"
},
"RENDA_PRESUMIDA": {
"FAIXA": "EXEMPLO",
"MENSAGEM": "Informação de exemplo",
"DESCRICAO": "Informação de exemplo",
"RENDA_ANUAL": "EXEMPLO",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"DATA_REFERENCIA": "",
"VALOR_PRESUMIDO": "",
"DADOS_CADASTRO_POSITIVO": ""
},
"PEND_FINANCEIRAS": {
"DATA_MAIOR": "",
"PROVEDORES": [
{
"VALOR_CALCULADO": "",
"QUANTIDADE_OCORRENCIAS": ""
}
],
"OCORRENCIAS": [],
"VALOR_MAIOR": "",
"VALOR_TOTAL": "",
"DATA_PRIMEIRO": "",
"PERIODO_FINAL": "",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"TOTAL_CREDORES": "",
"VALOR_PRIMEIRO": "",
"PERIODO_INICIAL": "",
"ULTIMO_VENCIMENTO": "",
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"SOMENTE_ENDERECO": {
"DADOS": [
{
"UF": "SP",
"CEP": "01001000",
"BAIRRO": "CENTRO",
"CIDADE": "SAO PAULO",
"NUMERO": "EXEMPLO",
"ENDERECO": "AVENIDA EXEMPLO, 100",
"LATITUDE": "",
"DOCUMENTO": "",
"LONGITUDE": "",
"PONTUACAO": "",
"COMPLEMENTO": "",
"TIPO_PESSOA": "",
"COD_IDENTIFICACAO_ENDERECO": ""
},
{
"UF": "SP",
"CEP": "01001000",
"BAIRRO": "CENTRO",
"CIDADE": "SAO PAULO",
"NUMERO": "EXEMPLO",
"ENDERECO": "AVENIDA EXEMPLO, 100",
"LATITUDE": "",
"DOCUMENTO": "",
"LONGITUDE": "",
"PONTUACAO": "",
"COMPLEMENTO": "",
"TIPO_PESSOA": "",
"COD_IDENTIFICACAO_ENDERECO": ""
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"REGISTRO_LOCALIZADO": "EXEMPLO"
},
"SOMENTE_TELEFONE": {
"DADOS": [
{
"DDD": "EXEMPLO",
"DOCUMENTO": "",
"PONTUACAO": "",
"TIPO_PESSOA": "",
"NUM_TELEFONE": "11999999999",
"TIPO_TELEFONE": "11999999999",
"COD_IDENTIFICADAO_TELEFONE": "11999999999"
},
{
"DDD": "EXEMPLO",
"DOCUMENTO": "",
"PONTUACAO": "",
"TIPO_PESSOA": "",
"NUM_TELEFONE": "11999999999",
"TIPO_TELEFONE": "11999999999",
"COD_IDENTIFICADAO_TELEFONE": "11999999999"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"REGISTRO_LOCALIZADO": "EXEMPLO"
},
"CONTROLE_POSITIVO": {
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"INDICADOR_COMPORTAMENTAL": {
"NOTA": "EXEMPLO",
"SCORE": "EXEMPLO",
"TOTAL_DIVIDAS": "EXEMPLO",
"CONTRATOS_RECENTES": "EXEMPLO"
}
},
"PROTESTO_SINTETICO": {
"OCORRENCIAS": [
{
"UF": "",
"VALOR": "EXEMPLO",
"CREDOR": "",
"CEDENTE": "",
"COMARCA": "EXEMPLO",
"ANUENCIA": "",
"CARTORIO": "EXEMPLO",
"ENDERECO": "",
"TELEFONE": "",
"VALOR_CUSTAS": "",
"INFO_CARTORIOS": "",
"DATA_OCORRENCIA": "",
"DATA_ATUALIZACAO": ""
},
{
"UF": "",
"VALOR": "EXEMPLO",
"CREDOR": "",
"CEDENTE": "",
"COMARCA": "EXEMPLO",
"ANUENCIA": "",
"CARTORIO": "EXEMPLO",
"ENDERECO": "",
"TELEFONE": "",
"VALOR_CUSTAS": "",
"INFO_CARTORIOS": "",
"DATA_OCORRENCIA": "",
"DATA_ATUALIZACAO": ""
}
],
"VALOR_TOTAL": "EXEMPLO",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"ULTIMO_PROTESTO": "",
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"PASSAGENS_COMERCIAIS": {
"OCORRENCIAS": [
{
"DATA_CONSULTA": "2026-01-15",
"HORA_CONSULTA": "",
"CLIENTE_CONSULTA": "EXEMPLO",
"TELEFONE_CLIENTE": "",
"CIDADE_UF_CLIENTE": ""
},
{
"DATA_CONSULTA": "2026-01-15",
"HORA_CONSULTA": "",
"CLIENTE_CONSULTA": "EXEMPLO",
"TELEFONE_CLIENTE": "",
"CIDADE_UF_CLIENTE": ""
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
},
"PARTICIPACAO_EM_EMPRESAS": {
"OCORRENCIAS": [
{
"CNPJ": "12345678000195",
"PARTICIPACAO": "EXEMPLO",
"RAZAO_SOCIAL": "EMPRESA EXEMPLO LTDA",
"PARTICIPANTE_TIPO": "",
"QTD_OUTROS_SOCIOS": "",
"PARTICIPANTE_CARGO": "",
"PARTICIPANTE_ENTRADA": "",
"PARTICIPANTE_DOCUMENTO": ""
},
{
"CNPJ": "12345678000195",
"PARTICIPACAO": "EXEMPLO",
"RAZAO_SOCIAL": "EMPRESA EXEMPLO LTDA",
"PARTICIPANTE_TIPO": "",
"QTD_OUTROS_SOCIOS": "",
"PARTICIPANTE_CARGO": "",
"PARTICIPANTE_ENTRADA": "",
"PARTICIPANTE_DOCUMENTO": ""
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
},
"IDENTIFICACAO_PESSOA_FISICA": {
"MAE": "",
"NOME": "PESSOA EXEMPLO",
"SEXO": "EXEMPLO",
"EMAIL": "",
"RG_UF": "EXEMPLO",
"END_UF": "",
"END_CEP": "",
"NOME_PAI": "",
"TELEFONE": "",
"RG_NUMERO": "EXEMPLO",
"CPF_NUMERO": "12345678909",
"CPF_ORIGEM": "",
"END_BAIRRO": "",
"END_CIDADE": "",
"NASCIMENTO": "2026-01-15",
"NUMERO_PIS": "",
"FAIXA_RENDA": "",
"NOME_SOCIAL": "",
"CPF_SITUACAO": "12345678909",
"ESTADO_CIVIL": "EXEMPLO",
"NATURALIDADE": "",
"CLASSE_SOCIAL": "",
"NACIONALIDADE": "",
"END_LOGRADOURO": "",
"GRAU_INSTRUCAO": "EXEMPLO",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"TITULO_ELEITOR": "",
"INDICACAO_OBITO": "EXEMPLO",
"RG_DATA_EMISSAO": "",
"PODER_AQUISITIVO": "",
"NUMERO_DEPENDENTES": "",
"ULTIMO_IMPOSTO_RENDA": "",
"CARTAO_NACIONAL_SAUDE": "",
"CPF_DATA_ATUALIZACAO_RECEITA": "",
"QTD_DEPENDENTES_BOLSA_FAMILIA": ""
},
"INFORMACOES_ALERTAS_RESTRICOES": {
"OCORRENCIAS": [
{
"TITULO": "EXEMPLO",
"OBSERVACOES": "EXEMPLO",
"CODIGO_TIPO_INFORMACAO": "1",
"DESCRICAO_TIPO_INFORMACAO": "Informação de exemplo"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIA": "EXEMPLO"
}
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3020SCR Bacen Premium CPF
CPFEndividamento bancário do CPF no SCR: modalidades, vencimentos, prejuízos e coobrigações.
Contrato v1
3020
SCR Bacen Premium CPF
CPFEndividamento bancário do CPF no SCR: modalidades, vencimentos, prejuízos e coobrigações.
Parâmetros
cpf *Requisição
json
{
"cpf": "12345678909"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3020,
"slug": "scr-bacen-premium-cpf",
"nome": "SCR Bacen Premium CPF",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"VEICULAR": {},
"CREDCADASTRAL": {
"RELATORIO_SCR": {
"SCORE": {
"FAIXA": "EXEMPLO",
"PONTUACAO": "EXEMPLO"
},
"DOCUMENTO": "12345678909",
"OPERACOES": [
{
"TOTAL": "EXEMPLO",
"MODALIDADE": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"PERCENTUAL": "EXEMPLO",
"VENCIMENTOS": [
{
"VALOR": "EXEMPLO",
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo",
"QTD_MESES": "EXEMPLO",
"PERCENTUAL": "EXEMPLO",
"RESTRITIVO": "EXEMPLO"
},
{
"VALOR": "EXEMPLO",
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo",
"QTD_MESES": "EXEMPLO",
"PERCENTUAL": "EXEMPLO",
"RESTRITIVO": "EXEMPLO"
}
],
"SUB_MODALIDADE": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"VARIACAO_CAMBIAL": "EXEMPLO"
},
{
"TOTAL": "EXEMPLO",
"MODALIDADE": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"PERCENTUAL": "EXEMPLO",
"VENCIMENTOS": [
{
"VALOR": "EXEMPLO",
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo",
"QTD_MESES": "EXEMPLO",
"PERCENTUAL": "EXEMPLO",
"RESTRITIVO": "EXEMPLO"
}
],
"SUB_MODALIDADE": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"VARIACAO_CAMBIAL": "EXEMPLO"
}
],
"CONSOLIDADO": {
"PREJUIZO": {
"VALOR": "EXEMPLO",
"OPERACOES": [],
"PERCENTUAL": "EXEMPLO"
},
"LIMITE_CREDITO": {
"VALOR": "EXEMPLO",
"OPERACOES": [
{
"VALOR": "EXEMPLO",
"DESCRICAO": "Informação de exemplo",
"QTD_MESES": "EXEMPLO",
"PERCENTUAL": "EXEMPLO"
},
{
"VALOR": "EXEMPLO",
"DESCRICAO": "Informação de exemplo",
"QTD_MESES": "EXEMPLO",
"PERCENTUAL": "EXEMPLO"
}
],
"PERCENTUAL": "EXEMPLO"
},
"CREDITO_AVENCER": {
"VALOR": "EXEMPLO",
"OPERACOES": [
{
"VALOR": "EXEMPLO",
"DESCRICAO": "Informação de exemplo",
"QTD_MESES": "EXEMPLO",
"PERCENTUAL": "EXEMPLO"
},
{
"VALOR": "EXEMPLO",
"DESCRICAO": "Informação de exemplo",
"QTD_MESES": "EXEMPLO",
"PERCENTUAL": "EXEMPLO"
}
],
"PERCENTUAL": "EXEMPLO"
},
"CREDITO_VENCIDO": {
"VALOR": "EXEMPLO",
"OPERACOES": [
{
"VALOR": "EXEMPLO",
"DESCRICAO": "Informação de exemplo",
"QTD_MESES": "EXEMPLO",
"PERCENTUAL": "EXEMPLO"
},
{
"VALOR": "EXEMPLO",
"DESCRICAO": "Informação de exemplo",
"QTD_MESES": "EXEMPLO",
"PERCENTUAL": "EXEMPLO"
}
],
"PERCENTUAL": "EXEMPLO"
}
},
"VALOR_REPASSE": "EXEMPLO",
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"TIPO_DOCUMENTO": "12345678909",
"NOME_RAZAO_SOCIAL": "",
"DATABASE_CONSULTADA": "2026-01-15",
"NASCIMENTO_FUNDACAO": "",
"COOBRIGACAO_ASSUMIDA": "EXEMPLO",
"COOBRIGACAO_RECEBIDA": "EXEMPLO",
"QUANTIDADE_OPERACOES": "EXEMPLO",
"RISCO_INDIRETO_VENDOR": "BAIXO",
"QUANTIDADE_INSTITUICOES": "EXEMPLO",
"DATA_INICIO_RELACIONAMENTO": "PESSOA EXEMPLO",
"VALOR_TRANSACOES_JUDICIAIS": "EXEMPLO",
"PERCENTUAL_VOLUME_PROCESSADO": "EXEMPLO",
"VALOR_TRANSACOES_DIVERGENTES": "EXEMPLO",
"QUANTIDADE_OPERACOES_SUBJUDICE": "EXEMPLO",
"RESPONSABILIDADE_TOTAL_SUBJUDICE": "EXEMPLO",
"PERCENTUAL_DOCUMENTOS_PROCESSADOS": "12345678909",
"QUANTIDADE_OPERACOES_DISCORDANCIA": "EXEMPLO",
"RESPONSABILIDADE_TOTAL_DISCORDANCIA": "EXEMPLO"
}
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3021Serasa Avançado CPF
CPFRelatório avançado com cadastro ampliado, restrições, fatos e vínculos do CPF.
Contrato v1
3021
Serasa Avançado CPF
CPFRelatório avançado com cadastro ampliado, restrições, fatos e vínculos do CPF.
Parâmetros
documento *Requisição
json
{
"documento": "12345678909"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3021,
"slug": "credito-completo-cpf",
"nome": "Serasa Avançado CPF",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"reports": [
{
"facts": {
"inquiry": {
"summary": {
"count": 1
},
"inquiryResponse": [
{
"daysQuantity": 1,
"occurrenceDate": "2026-01-15",
"segmentDescription": "EXEMPLO"
},
{
"daysQuantity": 1,
"occurrenceDate": "2026-01-15",
"segmentDescription": "EXEMPLO"
}
]
},
"bankrupts": {
"summary": {
"count": 1,
"balance": 1
},
"bankruptsResponse": []
},
"inquirySummary": {
"summary": {
"count": 1,
"checkCount": 1,
"creditCount": 1
},
"inquiryQuantity": {
"actual": 1,
"checkActual": 1,
"checkInquiriesQuantity": [
{
"inquiryDate": "2026-01-15",
"occurrences": 1
},
{
"inquiryDate": "2026-01-15",
"occurrences": 1
}
],
"creditInquiriesQuantity": [
{
"inquiryDate": "2026-01-15",
"occurrences": 1,
"bankOccurrences": 1,
"companyOccurrences": 1
},
{
"inquiryDate": "2026-01-15",
"occurrences": 1,
"bankOccurrences": 1,
"companyOccurrences": 1
}
]
}
},
"stolenDocuments": {
"summary": {
"count": 1,
"balance": 1
},
"stolenDocumentsResponse": []
},
"judgementFilings": {
"summary": {
"count": 1,
"balance": 1.5,
"lastOccurrence": "EXEMPLO",
"firstOccurrence": "EXEMPLO"
},
"judgementFilingsResponse": [
{
"city": "SAO PAULO",
"cadus": "EXEMPLO",
"state": "SP",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"civilCourt": "EXEMPLO",
"distributor": "EXEMPLO",
"legalNature": "EXEMPLO",
"legalSquare": "EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
},
{
"city": "SAO PAULO",
"cadus": "EXEMPLO",
"state": "SP",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"civilCourt": "EXEMPLO",
"distributor": "EXEMPLO",
"legalNature": "EXEMPLO",
"legalSquare": "EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
}
]
}
},
"score": {
"range": "EXEMPLO",
"score": 750,
"message": "Informação de exemplo",
"scoreModel": "EXEMPLO",
"codeMessage": 35,
"defaultRate": "EXEMPLO"
},
"partner": {
"summary": {
"count": 1,
"balance": 1
},
"partnershipResponse": [
{
"updateDate": "2026-01-15",
"companyName": "EMPRESA EXEMPLO LTDA",
"hasNegative": false,
"companyState": "EMPRESA EXEMPLO LTDA",
"companyStatus": "EMPRESA EXEMPLO LTDA",
"businessDocument": "12345678000195",
"companyStatusCode": "EMPRESA EXEMPLO LTDA",
"companyStatusDate": "EMPRESA EXEMPLO LTDA",
"participationPercentage": 35,
"participationInitialDate": "2026-01-15"
},
{
"updateDate": "2026-01-15",
"companyName": "EMPRESA EXEMPLO LTDA",
"hasNegative": true,
"companyState": "EMPRESA EXEMPLO LTDA",
"companyStatus": "EMPRESA EXEMPLO LTDA",
"businessDocument": "12345678000195",
"companyStatusCode": "EMPRESA EXEMPLO LTDA",
"companyStatusDate": "EMPRESA EXEMPLO LTDA",
"participationPercentage": 35,
"participationInitialDate": "2026-01-15"
}
]
},
"attributes": {
"attributesResponse": [
{
"message": "Informação de exemplo",
"scoring": 1,
"flagAgro": {
"value": "EXEMPLO"
},
"codeMessage": 35,
"attributeModel": "EXEMPLO"
}
]
},
"reportName": "PESSOA EXEMPLO",
"negativeData": {
"check": {
"summary": {
"count": 1,
"balance": 1
},
"checkResponse": []
},
"pefin": {
"summary": {
"count": 1,
"balance": 1.5,
"lastOccurrence": "EXEMPLO",
"firstOccurrence": "EXEMPLO"
},
"pefinResponse": [
{
"cadus": "EXEMPLO",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"principal": true,
"contractId": "EXEMPLO",
"legalNature": "EXEMPLO",
"legalSquare": "",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
},
{
"cadus": "EXEMPLO",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"principal": true,
"contractId": "EXEMPLO",
"legalNature": "EXEMPLO",
"legalSquare": "",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
}
]
},
"refin": {
"summary": {
"count": 1,
"balance": 1.5,
"lastOccurrence": "EXEMPLO",
"firstOccurrence": "EXEMPLO"
},
"refinResponse": [
{
"cadus": "EXEMPLO",
"amount": 123.45,
"principal": false,
"contractId": "EXEMPLO",
"legalNature": "EXEMPLO",
"legalSquare": "",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
},
{
"cadus": "EXEMPLO",
"amount": 123.45,
"principal": false,
"contractId": "EXEMPLO",
"legalNature": "EXEMPLO",
"legalSquare": "",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
}
]
},
"notary": {
"summary": {
"count": 1,
"balance": 1.5,
"lastOccurrence": "EXEMPLO",
"firstOccurrence": "EXEMPLO"
},
"notaryResponse": [
{
"city": "SAO PAULO",
"cadus": "EXEMPLO",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"federalUnit": "EXEMPLO",
"legalSquare": "EXEMPLO",
"officeNumber": "EXEMPLO",
"inclusionDate": "2026-01-15",
"occurrenceDate": "2026-01-15"
},
{
"city": "SAO PAULO",
"cadus": "EXEMPLO",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"federalUnit": "EXEMPLO",
"legalSquare": "EXEMPLO",
"officeNumber": "EXEMPLO",
"inclusionDate": "2026-01-15",
"occurrenceDate": "2026-01-15"
}
]
},
"collectionRecords": {
"summary": {
"count": 1,
"balance": 1
},
"collectionRecordsResponse": []
}
},
"registration": {
"phones": [
{
"areaCode": 1,
"phoneType": "11999999999",
"regionCode": 1,
"updateDate": "2026-01-15",
"phoneNumber": 1,
"phoneTypeCode": 1
},
{
"areaCode": 1,
"phoneType": "11999999999",
"regionCode": 1,
"updateDate": "2026-01-15",
"phoneNumber": 1,
"phoneTypeCode": 1
}
],
"address": {
"city": "SAO PAULO",
"state": "SP",
"country": "EXEMPLO",
"zipCode": "1",
"district": "CENTRO",
"addressLine": "AVENIDA EXEMPLO, 100"
},
"addresses": [
{
"city": "SAO PAULO",
"state": "SP",
"country": "EXEMPLO",
"zipCode": "1",
"district": "CENTRO",
"updateDate": "2026-01-15",
"addressLine": "AVENIDA EXEMPLO, 100",
"addressNumber": "AVENIDA EXEMPLO, 100",
"addressTypeCode": 1,
"addressComplement": "AVENIDA EXEMPLO, 100",
"addressTypeDescription": "AVENIDA EXEMPLO, 100"
},
{
"city": "SAO PAULO",
"state": "SP",
"country": "EXEMPLO",
"zipCode": "1",
"district": "CENTRO",
"updateDate": "2026-01-15",
"addressLine": "AVENIDA EXEMPLO, 100",
"addressNumber": "AVENIDA EXEMPLO, 100",
"addressTypeCode": 1,
"addressComplement": "AVENIDA EXEMPLO, 100",
"addressTypeDescription": "AVENIDA EXEMPLO, 100"
}
],
"birthDate": "2026-01-15",
"motherName": "PESSOA EXEMPLO",
"statusDate": "2026-01-15",
"consumerName": "PESSOA EXEMPLO",
"consumerGender": "EXEMPLO",
"documentNumber": "12345678909",
"statusRegistration": "REGULAR",
"statusRegistrationCode": "REGULAR",
"consumerGenderDescription": "EXEMPLO",
"corporateCompanyDocumentNumber": ""
},
"negativeSummary": {},
"checkFilingsHistorical": {
"checkFilingsHistoricalResponse": []
}
}
]
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3022Serasa Básico CPF
CPFRelatório com cadastro, restrições e histórico de consultas do CPF.
Contrato v1
3022
Serasa Básico CPF
CPFRelatório com cadastro, restrições e histórico de consultas do CPF.
Parâmetros
documento *Requisição
json
{
"documento": "12345678909"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3022,
"slug": "credito-essencial-cpf",
"nome": "Serasa Básico CPF",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"reports": [
{
"facts": {
"inquiry": {
"summary": {
"count": 1
},
"inquiryResponse": [
{
"daysQuantity": 1,
"occurrenceDate": "2026-01-15",
"segmentDescription": "EXEMPLO"
},
{
"daysQuantity": 1,
"occurrenceDate": "2026-01-15",
"segmentDescription": "EXEMPLO"
}
]
},
"inquirySummary": {
"inquiryQuantity": {
"actual": 1,
"creditInquiriesQuantity": [
{
"inquiryDate": "2026-01-15",
"occurrences": 1
},
{
"inquiryDate": "2026-01-15",
"occurrences": 1
}
]
}
},
"stolenDocuments": {
"summary": {
"count": 1,
"balance": 1
},
"stolenDocumentsResponse": []
}
},
"score": {
"range": "EXEMPLO",
"score": 750,
"message": "Informação de exemplo",
"scoreModel": "EXEMPLO",
"codeMessage": 35,
"defaultRate": "EXEMPLO"
},
"partner": {
"summary": {
"count": 1,
"balance": 1
},
"partnershipResponse": [
{
"updateDate": "2026-01-15",
"companyName": "EMPRESA EXEMPLO LTDA",
"hasNegative": true,
"companyState": "EMPRESA EXEMPLO LTDA",
"companyStatus": "EMPRESA EXEMPLO LTDA",
"businessDocument": "12345678000195",
"companyStatusCode": "EMPRESA EXEMPLO LTDA",
"companyStatusDate": "EMPRESA EXEMPLO LTDA",
"participationPercentage": 35
},
{
"updateDate": "2026-01-15",
"companyName": "EMPRESA EXEMPLO LTDA",
"hasNegative": false,
"companyState": "EMPRESA EXEMPLO LTDA",
"companyStatus": "EMPRESA EXEMPLO LTDA",
"businessDocument": "12345678000195",
"companyStatusCode": "EMPRESA EXEMPLO LTDA",
"companyStatusDate": "EMPRESA EXEMPLO LTDA",
"participationPercentage": 35
}
]
},
"reportName": "PESSOA EXEMPLO",
"negativeData": {
"check": {
"summary": {
"count": 1,
"balance": 1,
"checkCount": 1
},
"checkResponse": []
},
"pefin": {
"summary": {
"count": 1,
"balance": 1.5,
"lastOccurrence": "EXEMPLO",
"firstOccurrence": "EXEMPLO"
},
"pefinResponse": [
{
"cadus": "EXEMPLO",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"principal": false,
"contractId": "EXEMPLO",
"legalNature": "EXEMPLO",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
},
{
"cadus": "EXEMPLO",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"principal": false,
"contractId": "EXEMPLO",
"legalNature": "EXEMPLO",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
}
]
},
"refin": {
"summary": {
"count": 1,
"balance": 1.5,
"lastOccurrence": "EXEMPLO",
"firstOccurrence": "EXEMPLO"
},
"refinResponse": [
{
"cadus": "EXEMPLO",
"amount": 123.45,
"principal": false,
"contractId": "EXEMPLO",
"legalNature": "EXEMPLO",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
},
{
"cadus": "EXEMPLO",
"amount": 123.45,
"principal": true,
"contractId": "EXEMPLO",
"federalUnit": "EXEMPLO",
"legalNature": "EXEMPLO",
"creditorName": "PESSOA EXEMPLO",
"inclusionDate": "2026-01-15",
"legalNatureId": "EXEMPLO",
"occurrenceDate": "2026-01-15"
}
]
},
"notary": {
"summary": {
"count": 1,
"balance": 1.5,
"lastOccurrence": "EXEMPLO",
"firstOccurrence": "EXEMPLO"
},
"notaryResponse": [
{
"city": "SAO PAULO",
"cadus": "EXEMPLO",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"federalUnit": "EXEMPLO",
"officeNumber": "EXEMPLO",
"inclusionDate": "2026-01-15",
"occurrenceDate": "2026-01-15"
},
{
"city": "SAO PAULO",
"cadus": "EXEMPLO",
"amount": 123.45,
"dispute": {
"disputeIndicativeFlag": false
},
"federalUnit": "EXEMPLO",
"officeNumber": "EXEMPLO",
"inclusionDate": "2026-01-15",
"occurrenceDate": "2026-01-15"
}
]
},
"collectionRecords": {
"summary": {
"count": 1,
"balance": 1
},
"collectionRecordsResponse": []
}
},
"registration": {
"birthDate": "2026-01-15",
"motherName": "PESSOA EXEMPLO",
"statusDate": "2026-01-15",
"consumerName": "PESSOA EXEMPLO",
"documentNumber": "12345678909",
"statusRegistration": "REGULAR"
},
"negativeSummary": {}
}
]
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3024Dossiê Jurídico Resumido
JurídicoResumo quantitativo de processos judiciais em que a pessoa ou empresa aparece como parte.
Contrato v1
3024
Dossiê Jurídico Resumido
JurídicoResumo quantitativo de processos judiciais em que a pessoa ou empresa aparece como parte.
Parâmetros
documento *Requisição
json
{
"documento": "12345678909"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3024,
"slug": "dossie-juridico-resumido",
"nome": "Dossiê Jurídico Resumido",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"dossieJuridicoResumido": {
"data": {
"ultimo": "EXEMPLO",
"primeira": "EXEMPLO"
},
"posicao": {
"poloAtivo": {
"valor": "EXEMPLO",
"quantidade": 35
},
"outrosPolos": {
"valor": "EXEMPLO",
"quantidade": 35
},
"poloPassivo": {
"valor": "EXEMPLO",
"quantidade": 35
}
},
"processos": {
"despejo": 1,
"buscaApreensao": 1,
"sociosEmpresas": null
},
"tribunais": {
"total": 1,
"cortes": [
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"tipo": "EXEMPLO",
"tribunais": [
{
"_id": "EXEMPLO",
"total": 1,
"tribunal": "EXEMPLO",
"descricao": null
},
{
"_id": "EXEMPLO",
"total": 1,
"tribunal": "EXEMPLO",
"descricao": null
}
]
},
{
"id": "EXEMPLO",
"_id": "EXEMPLO",
"tipo": "EXEMPLO",
"tribunais": [
{
"_id": "EXEMPLO",
"total": 1,
"tribunal": "EXEMPLO",
"descricao": null
},
{
"_id": "EXEMPLO",
"total": 1,
"tribunal": "EXEMPLO",
"descricao": null
}
]
}
]
}
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3025Processos Judiciais CNPJ
JurídicoPesquisa detalhada de processos judiciais vinculados a um CNPJ, com posição da empresa, tribunais, assuntos, valores, datas e envolvidos.
Contrato v1
3025
Processos Judiciais CNPJ
JurídicoPesquisa detalhada de processos judiciais vinculados a um CNPJ, com posição da empresa, tribunais, assuntos, valores, datas e envolvidos.
Parâmetros
cnpj *Requisição
json
{
"cnpj": "12345678000195"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3025,
"slug": "relatorio-juridico-top-pj",
"nome": "Processos Judiciais CNPJ",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"VEICULAR": {},
"CREDCADASTRAL": {
"RELATORIO_JURIDICO_EMPRESARIAL": {
"ACOES": {
"DATA_ANTIGA": "",
"OCORRENCIAS": [
{
"UF": "SP",
"VALOR": "EXEMPLO",
"PARTES": [
{
"NOME": "PESSOA EXEMPLO",
"POLO": "EXEMPLO",
"TIPO": "EXEMPLO",
"ADVOGADOS": [],
"DOCUMENTO": "12345678000195"
},
{
"NOME": "PESSOA EXEMPLO",
"POLO": "EXEMPLO",
"TIPO": "EXEMPLO",
"ADVOGADOS": [],
"DOCUMENTO": "12345678909"
}
],
"TRIBUNAL": "EXEMPLO",
"GRAU_PROCESSO": "EXEMPLO",
"NUMERO_PROCESSO": "EXEMPLO",
"SEGREDO_JUSTICA": "EXEMPLO",
"JUSTICA_GRATUITA": "",
"STATUS_PREDICTUS": {
"JULGAMENTOS": [
{
"DATA_JULGAMENTO": "2026-01-15",
"TIPO_JULGAMENTO": "EXEMPLO"
},
{
"DATA_JULGAMENTO": "2026-01-15",
"TIPO_JULGAMENTO": "EXEMPLO"
}
],
"STATUS_PROCESSO": "REGULAR"
},
"CLASSE_PROCESSUAL": "EXEMPLO",
"DATA_DISTRIBUICAO": "2026-01-15"
},
{
"UF": "SP",
"VALOR": "EXEMPLO",
"PARTES": [
{
"NOME": "PESSOA EXEMPLO",
"POLO": "EXEMPLO",
"TIPO": "EXEMPLO",
"ADVOGADOS": [],
"DOCUMENTO": ""
},
{
"NOME": "PESSOA EXEMPLO",
"POLO": "EXEMPLO",
"TIPO": "EXEMPLO",
"ADVOGADOS": [],
"DOCUMENTO": "12345678909"
}
],
"TRIBUNAL": "EXEMPLO",
"GRAU_PROCESSO": "EXEMPLO",
"NUMERO_PROCESSO": "EXEMPLO",
"SEGREDO_JUSTICA": "EXEMPLO",
"JUSTICA_GRATUITA": "",
"STATUS_PREDICTUS": {
"JULGAMENTOS": [
{
"DATA_JULGAMENTO": "2026-01-15",
"TIPO_JULGAMENTO": "EXEMPLO"
},
{
"DATA_JULGAMENTO": "2026-01-15",
"TIPO_JULGAMENTO": "EXEMPLO"
}
],
"STATUS_PROCESSO": "REGULAR"
},
"CLASSE_PROCESSUAL": "EXEMPLO",
"DATA_DISTRIBUICAO": "2026-01-15"
}
],
"VALOR_TOTAL": "",
"DATA_RECENTE": "",
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
},
"RESUMO": [
{
"DESCRICAO": "Informação de exemplo",
"DATA_ANTIGA": "2026-01-15",
"VALOR_TOTAL": "EXEMPLO",
"DATA_RECENTE": "2026-01-15",
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"ACOES_ARQUIVADAS": {
"DATA_ANTIGA": "",
"OCORRENCIAS": [],
"VALOR_TOTAL": "",
"DATA_RECENTE": "",
"QUANTIDADE_OCORRENCIAS": ""
}
}
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3026Processos Judiciais CPF
JurídicoPesquisa detalhada de processos judiciais vinculados a um CPF, com posição da pessoa, tribunais, assuntos, valores, datas e envolvidos.
Contrato v1
3026
Processos Judiciais CPF
JurídicoPesquisa detalhada de processos judiciais vinculados a um CPF, com posição da pessoa, tribunais, assuntos, valores, datas e envolvidos.
Parâmetros
cpf *Requisição
json
{
"cpf": "12345678909"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3026,
"slug": "relatorio-juridico-top-pf",
"nome": "Processos Judiciais CPF",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"VEICULAR": {},
"CREDCADASTRAL": {
"RELATORIO_JURIDICO_PESSOA_FISICA": {
"ACOES": {
"DATA_ANTIGA": "",
"OCORRENCIAS": [
{
"UF": "SP",
"VALOR": "EXEMPLO",
"PARTES": [
{
"NOME": "PESSOA EXEMPLO",
"POLO": "EXEMPLO",
"TIPO": "EXEMPLO",
"ADVOGADOS": [],
"DOCUMENTO": "12345678909"
},
{
"NOME": "PESSOA EXEMPLO",
"POLO": "EXEMPLO",
"TIPO": "EXEMPLO",
"ADVOGADOS": [],
"DOCUMENTO": ""
}
],
"TRIBUNAL": "EXEMPLO",
"GRAU_PROCESSO": "EXEMPLO",
"NUMERO_PROCESSO": "EXEMPLO",
"SEGREDO_JUSTICA": "EXEMPLO",
"JUSTICA_GRATUITA": "",
"STATUS_PREDICTUS": {
"JULGAMENTOS": [
{
"DATA_JULGAMENTO": "2026-01-15",
"TIPO_JULGAMENTO": "EXEMPLO"
},
{
"DATA_JULGAMENTO": "2026-01-15",
"TIPO_JULGAMENTO": "EXEMPLO"
}
],
"STATUS_PROCESSO": "REGULAR"
},
"CLASSE_PROCESSUAL": "EXEMPLO",
"DATA_DISTRIBUICAO": "2026-01-15"
},
{
"UF": "SP",
"VALOR": "EXEMPLO",
"PARTES": [
{
"NOME": "PESSOA EXEMPLO",
"POLO": "EXEMPLO",
"TIPO": "EXEMPLO",
"ADVOGADOS": [],
"DOCUMENTO": "12345678909"
},
{
"NOME": "PESSOA EXEMPLO",
"POLO": "EXEMPLO",
"TIPO": "EXEMPLO",
"ADVOGADOS": [],
"DOCUMENTO": "12345678909"
}
],
"TRIBUNAL": "EXEMPLO",
"GRAU_PROCESSO": "EXEMPLO",
"NUMERO_PROCESSO": "EXEMPLO",
"SEGREDO_JUSTICA": "EXEMPLO",
"JUSTICA_GRATUITA": "",
"STATUS_PREDICTUS": {
"JULGAMENTOS": [
{
"DATA_JULGAMENTO": "2026-01-15",
"TIPO_JULGAMENTO": "EXEMPLO"
},
{
"DATA_JULGAMENTO": "2026-01-15",
"TIPO_JULGAMENTO": "EXEMPLO"
}
],
"STATUS_PROCESSO": "REGULAR"
},
"CLASSE_PROCESSUAL": "EXEMPLO",
"DATA_DISTRIBUICAO": "2026-01-15"
}
],
"VALOR_TOTAL": "",
"DATA_RECENTE": "",
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
},
"RESUMO": [
{
"DESCRICAO": "Informação de exemplo",
"DATA_ANTIGA": "2026-01-15",
"VALOR_TOTAL": "EXEMPLO",
"DATA_RECENTE": "2026-01-15",
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"ACOES_ARQUIVADAS": {
"DATA_ANTIGA": "",
"OCORRENCIAS": [],
"VALOR_TOTAL": "",
"DATA_RECENTE": "",
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
}
}
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3028Dados do Veículo por CPF/CNPJ
VeículosLocaliza veículos vinculados a um CPF ou CNPJ nas bases consultadas.
Contrato v1
3028
Dados do Veículo por CPF/CNPJ
VeículosLocaliza veículos vinculados a um CPF ou CNPJ nas bases consultadas.
Parâmetros
tipo_pessoa *documento *Requisição
json
{
"documento": "12345678909",
"tipo_pessoa": "F"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3028,
"slug": "dados-veiculo-cpf-cnpj",
"nome": "Dados do Veículo por CPF/CNPJ",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"VEICULAR": {
"VEICULOS_POR_DOCUMENTO": {
"OBSERVACAO": "",
"OCORRENCIAS": [
{
"UF": "SP",
"CMT": "",
"COR": "EXEMPLO",
"PBT": "",
"MOTOR": "",
"PLACA": "ABC1D23",
"CAMBIO": "",
"CHASSI": "9BWZZZ377VT004251",
"ESPECIE": "",
"RENAVAM": "",
"POTENCIA": "",
"SITUACAO": "REGULAR",
"MUNICIPIO": "",
"ANO_MODELO": "",
"CILINDRADA": "",
"CODIGO_FIPE": "",
"COMBUSTIVEL": "",
"PROCEDENCIA": "",
"MARCA_MODELO": "EXEMPLO",
"ANO_FABRICACAO": "EXEMPLO",
"CAPACIDADE_CARGA": "",
"DOC_PROPRIETARIO": "",
"NOME_PROPRIETARIO": "",
"QUANTIDADE_PASSAGEIROS": ""
},
{
"UF": "SP",
"CMT": "",
"COR": "EXEMPLO",
"PBT": "",
"MOTOR": "",
"PLACA": "ABC1D23",
"CAMBIO": "",
"CHASSI": "9BWZZZ377VT004251",
"ESPECIE": "",
"RENAVAM": "",
"POTENCIA": "",
"SITUACAO": "REGULAR",
"MUNICIPIO": "",
"ANO_MODELO": "",
"CILINDRADA": "",
"CODIGO_FIPE": "",
"COMBUSTIVEL": "",
"PROCEDENCIA": "",
"MARCA_MODELO": "EXEMPLO",
"ANO_FABRICACAO": "EXEMPLO",
"CAPACIDADE_CARGA": "",
"DOC_PROPRIETARIO": "",
"NOME_PROPRIETARIO": "",
"QUANTIDADE_PASSAGEIROS": ""
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
}
},
"CREDCADASTRAL": {
"VEICULOS_POR_DOCUMENTO": {
"OBSERVACAO": "",
"OCORRENCIAS": [
{
"UF": "SP",
"CMT": "",
"COR": "EXEMPLO",
"PBT": "",
"MOTOR": "",
"PLACA": "ABC1D23",
"CAMBIO": "",
"CHASSI": "9BWZZZ377VT004251",
"ESPECIE": "",
"RENAVAM": "",
"POTENCIA": "",
"SITUACAO": "REGULAR",
"MUNICIPIO": "",
"ANO_MODELO": "",
"CILINDRADA": "",
"CODIGO_FIPE": "",
"COMBUSTIVEL": "",
"PROCEDENCIA": "",
"MARCA_MODELO": "EXEMPLO",
"ANO_FABRICACAO": "EXEMPLO",
"CAPACIDADE_CARGA": "",
"DOC_PROPRIETARIO": "",
"NOME_PROPRIETARIO": "",
"QUANTIDADE_PASSAGEIROS": ""
},
{
"UF": "SP",
"CMT": "",
"COR": "EXEMPLO",
"PBT": "",
"MOTOR": "",
"PLACA": "ABC1D23",
"CAMBIO": "",
"CHASSI": "9BWZZZ377VT004251",
"ESPECIE": "",
"RENAVAM": "",
"POTENCIA": "",
"SITUACAO": "REGULAR",
"MUNICIPIO": "",
"ANO_MODELO": "",
"CILINDRADA": "",
"CODIGO_FIPE": "",
"COMBUSTIVEL": "",
"PROCEDENCIA": "",
"MARCA_MODELO": "EXEMPLO",
"ANO_FABRICACAO": "EXEMPLO",
"CAPACIDADE_CARGA": "",
"DOC_PROPRIETARIO": "",
"NOME_PROPRIETARIO": "",
"QUANTIDADE_PASSAGEIROS": ""
}
],
"STATUS_RETORNO": {
"CODIGO": "1",
"DESCRICAO": "Informação de exemplo"
},
"QUANTIDADE_OCORRENCIAS": "EXEMPLO"
}
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3029Histórico de Proprietários
VeículosRelaciona proprietários anteriores localizados para o veículo consultado pela placa.
Contrato v1
3029
Histórico de Proprietários
VeículosRelaciona proprietários anteriores localizados para o veículo consultado pela placa.
Parâmetros
placa *Requisição
json
{
"placa": "ABC1D23"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3029,
"slug": "historico-proprietarios",
"nome": "Histórico de Proprietários",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"renavam": "12345678901",
"numMotor": "EXEMPLO",
"anoModelo": "EXEMPLO",
"marcaModelo": "EXEMPLO",
"anoFabricacao": "EXEMPLO",
"historicoProprietarios": [
{
"uf": "SP",
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"cpfCnpj": "12345678000195",
"renavam": null,
"municipio": null,
"ocorrencia": null,
"anoExercicio": "EXEMPLO",
"proprietario": "EXEMPLO",
"tipoDocumento": null,
"dataEmplacamento": "ABC1D23",
"dataProcessamento": null,
"motivoTipoAutorizacao": null,
"correlacaoChassiRenavam": false
},
{
"uf": "SP",
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"cpfCnpj": "12345678000195",
"renavam": null,
"municipio": null,
"ocorrencia": null,
"anoExercicio": "EXEMPLO",
"proprietario": "EXEMPLO",
"tipoDocumento": null,
"dataEmplacamento": "ABC1D23",
"dataProcessamento": null,
"motivoTipoAutorizacao": null,
"correlacaoChassiRenavam": false
}
]
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3030Proprietário pela Placa
VeículosIdentifica o proprietário atual e os principais dados cadastrais do veículo a partir da placa.
Contrato v1
3030
Proprietário pela Placa
VeículosIdentifica o proprietário atual e os principais dados cadastrais do veículo a partir da placa.
Parâmetros
placa *Requisição
json
{
"placa": "ABC1D23"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3030,
"slug": "proprietario-atual",
"nome": "Proprietário pela Placa",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"proprietarioAtual": {
"cor": "EXEMPLO",
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"created": null,
"renavam": "12345678901",
"anoModelo": "EXEMPLO",
"marcaModelo": "EXEMPLO",
"ufJurisdicao": "EXEMPLO",
"anoFabricacao": "EXEMPLO",
"docProprietario": "12345678909",
"nomeProprietario": "PESSOA EXEMPLO",
"codigoMarcaModelo": null,
"tipoDocProprietario": null,
"tipoSituacaoVeiculo": null,
"dataUltimaAtualizacao": null,
"municipioEmplacamento": "ABC1D23"
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3031Veículo Alerta
VeículosAnálise veicular para lojistas com cadastro, procedência, FIPE, leilão, sinistro, roubo/furto e alertas de compra.
Contrato v1
3031
Veículo Alerta
VeículosAnálise veicular para lojistas com cadastro, procedência, FIPE, leilão, sinistro, roubo/furto e alertas de compra.
Parâmetros
placa *Requisição
json
{
"placa": "ABC1D23"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3031,
"slug": "completa-lojista",
"nome": "Veículo Alerta",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"uf": "SP",
"cmt": null,
"pbt": "EXEMPLO",
"eixos": "EXEMPLO",
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"cidade": "SAO PAULO",
"leilao": {
"score": {
"score": "EXEMPLO",
"aceitacao": "EXEMPLO",
"pontuacao": "EXEMPLO",
"percentualSobreRef": "EXEMPLO",
"exigenciaVistoriaEspecial": "EXEMPLO"
},
"descricao": "Informação de exemplo",
"registros": [
{
"cor": "EXEMPLO",
"lote": "EXEMPLO",
"marca": "EXEMPLO",
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"modelo": "EXEMPLO",
"anoModelo": "EXEMPLO",
"comitente": "EXEMPLO",
"leiloeiro": "EXEMPLO",
"dataLeilao": "2026-01-15",
"observacao": null,
"anoFabricacao": "EXEMPLO",
"condicaoGeral": null
}
]
},
"qtdPax": "EXEMPLO",
"recall": {
"marca": null,
"chassi": null,
"modelo": null,
"detalhes": [],
"situacao": null,
"anoModelo": null,
"recallsPendente": [],
"descricaoRetorno": null,
"situacaoObservacao": null
},
"anuncio": {
"fotosRaw": []
},
"renavam": "12345678901",
"numMotor": "EXEMPLO",
"potencia": "EXEMPLO",
"anoModelo": "EXEMPLO",
"categoria": "EXEMPLO",
"municipio": "SAO PAULO",
"codigoFipe": [
{
"codigo": "1",
"valorZeroKM": null
},
{
"codigo": "1",
"valorZeroKM": "EXEMPLO"
}
],
"corVeiculo": "EXEMPLO",
"registroDi": null,
"restricoes": null,
"rouboFurto": {
"historico": [
{
"cor": "EXEMPLO",
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"boletim": "EXEMPLO",
"declaracao": "EXEMPLO",
"informante": "EXEMPLO",
"ocorrencia": "EXEMPLO",
"marcaModelo": "EXEMPLO",
"ufOcorrencia": "EXEMPLO",
"dataOcorrencia": "2026-01-15",
"municipioOcorrencia": null
},
{
"cor": "EXEMPLO",
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"boletim": "EXEMPLO",
"declaracao": "EXEMPLO",
"informante": "EXEMPLO",
"ocorrencia": "EXEMPLO",
"marcaModelo": "EXEMPLO",
"ufOcorrencia": "EXEMPLO",
"dataOcorrencia": "2026-01-15",
"municipioOcorrencia": null
}
],
"constaOcorrencia": true,
"indicadorProcedencia": null,
"constaOcorrenciaAtiva": true,
"municipioEmplacamento": null
},
"ufFaturado": "EXEMPLO",
"caixaCambio": null,
"cilindradas": "EXEMPLO",
"codigoMarca": "1",
"combustivel": "EXEMPLO",
"docFaturado": "12345678000195",
"historicoKm": [],
"marcaImagem": null,
"marcaModelo": "EXEMPLO",
"numFaturado": "12345678000195",
"procedencia": "EXEMPLO",
"remarketing": {
"motor": null,
"placa": null,
"chassi": null,
"leilao": [],
"renavam": null,
"segmento": null,
"checklist": {
"dataInspecao": null
},
"marcaModelo": null,
"subSegmento": null,
"situacaoChassi": null
},
"tipoVeiculo": "EXEMPLO",
"baseEstadual": {
"uf": "SP",
"cor": "EXEMPLO",
"tipo": "EXEMPLO",
"motor": "EXEMPLO",
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"especie": "EXEMPLO",
"licdata": "2026-01-15",
"pronome": "PESSOA EXEMPLO",
"renavam": "12345678901",
"categoria": "EXEMPLO",
"dataVenda": null,
"debitoDer": null,
"municipio": "SAO PAULO",
"debitoIpva": "EXEMPLO",
"combustivel": "EXEMPLO",
"debitoDersa": null,
"debitoDpvat": "EXEMPLO",
"observacoes": null,
"debitoCetesb": null,
"debitoDetran": null,
"debitoMultas": "EXEMPLO",
"debitoRenainf": null,
"dataEmissaoCrv": "2026-01-15",
"pronomeAnterior": null,
"situacaoVeiculo": "REGULAR",
"comunicacaoVenda": "EXEMPLO",
"debitoMunicipais": "PESSOA EXEMPLO",
"existeDebitoIpva": "EXEMPLO",
"restricaoGuincho": "EXEMPLO",
"restricaoRenajud": "EXEMPLO",
"existeDebitoDpvat": "EXEMPLO",
"existeDebitoMulta": "EXEMPLO",
"outrasRestricoes1": "EXEMPLO",
"outrasRestricoes2": "EXEMPLO",
"outrasRestricoes3": "EXEMPLO",
"outrasRestricoes4": "EXEMPLO",
"restricaoJudicial": "EXEMPLO",
"dataAlteracaoMotor": null,
"restricaoAmbiental": null,
"tipoMarcacaoChassi": "9BWZZZ377VT004251",
"comunicacaoInclusao": null,
"debitoLicenciamento": "EXEMPLO",
"restricaoFinanceira": "EXEMPLO",
"restricaoNomeAgente": null,
"restricaoRouboFurto": "EXEMPLO",
"restricaoTributaria": "EXEMPLO",
"restricaoArrendatario": null,
"restricaoDataInclusao": null,
"exercicioLicenciamento": "EXEMPLO",
"restricaoAdminisrativa": "EXEMPLO",
"restricaoDocArrendatario": null,
"existeDebitoLicenciamento": "EXEMPLO",
"dataLimiteRestricaoTributaria": null,
"dataVigenciaContratoFinanceira": null,
"debitoPoliciaRodoviariaFederal": null,
"dataInclusaoIntencaoTrocaFinanceira": null
},
"baseNacional": {
"di": null,
"uf": "SP",
"cor": "EXEMPLO",
"motor": "EXEMPLO",
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"especie": "EXEMPLO",
"renavam": "12345678901",
"anoModelo": "EXEMPLO",
"categoria": null,
"municipio": "SAO PAULO",
"ocorrencia": "EXEMPLO",
"restricao1": "EXEMPLO",
"restricao2": "EXEMPLO",
"restricao3": "EXEMPLO",
"restricao4": "EXEMPLO",
"ufFaturado": null,
"combustivel": "EXEMPLO",
"docFaturado": "12345678000195",
"tipoVeiculo": "EXEMPLO",
"dtEmissaoCrv": null,
"anoFabricacao": "EXEMPLO",
"especieVeiculo": null,
"docProprietario": "12345678909",
"situacaoVeiculo": "REGULAR",
"tipoDocFaturado": "EXEMPLO",
"outrasRestricoes1": "EXEMPLO",
"outrasRestricoes2": "EXEMPLO",
"outrasRestricoes3": "EXEMPLO",
"outrasRestricoes4": "EXEMPLO",
"outrasRestricoes5": "EXEMPLO",
"outrasRestricoes6": "EXEMPLO",
"outrasRestricoes7": "EXEMPLO",
"outrasRestricoes8": "EXEMPLO",
"tipoDocImportadora": "EXEMPLO",
"tipoMarcacaoChassi": "9BWZZZ377VT004251",
"dtUltimaAtualizacao": "EXEMPLO",
"restricaoNomeAgente": null,
"restricaoDataInclusao": null,
"restricaoFinanciadora": null,
"restricaoFinanciamento": null,
"restricaoTipoTransacao": null,
"indicadorRestricaoRenajud": "EXEMPLO",
"indicadorComunicacaoVendas": "EXEMPLO"
},
"capMaxTracao": "EXEMPLO",
"tipoMontagem": "EXEMPLO",
"anoFabricacao": "EXEMPLO",
"nacionalidade": "EXEMPLO",
"numCarroceria": null,
"especieVeiculo": "EXEMPLO",
"situacaoChassi": "9BWZZZ377VT004251",
"tipoCarroceria": "EXEMPLO",
"capacidadeCarga": null,
"docProprietario": "EXEMPLO",
"eixoTraseiroDif": null,
"indicioSinistro": {
"descricao": null,
"classificacao": null
},
"numTerceiroEixo": null,
"situacaoVeiculo": "REGULAR",
"tipoDocFaturado": "EXEMPLO",
"identImportadora": null,
"radarSecuritario": [
{
"_id": "EXEMPLO",
"cias": [
{
"_id": "12345678000195",
"Nome": "PESSOA EXEMPLO",
"Codigo": 1
},
{
"_id": "12345678000195",
"Nome": "PESSOA EXEMPLO",
"Codigo": 1
}
],
"franquiaNormal": {
"valorPremio": {
"maior": "EXEMPLO",
"media": "EXEMPLO",
"menor": "EXEMPLO"
},
"valorFranquia": {
"maior": "EXEMPLO",
"media": "EXEMPLO",
"menor": "EXEMPLO"
}
},
"franquiaReduzida": {
"valorPremio": {
"maior": "EXEMPLO",
"media": "EXEMPLO",
"menor": "EXEMPLO"
},
"valorFranquia": {
"maior": "EXEMPLO",
"media": "EXEMPLO",
"menor": "EXEMPLO"
}
}
}
],
"codigoCombustivel": "1",
"codigoMarcaModelo": "1",
"tipoDocImportadora": "EXEMPLO",
"ultimaDataInclusao": null,
"dtUltimaAtualizacao": null,
"limiteRestricaoTrib": null,
"capacidadePassageiro": "SAO PAULO",
"documentoImportadora": null,
"dadosBasicosDoVeiculo": {
"marca": "EXEMPLO",
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"nacional": "EXEMPLO",
"anoModelo": "EXEMPLO",
"descricao": "Informação de exemplo",
"codigoFipe": "1",
"cilindradas": "EXEMPLO",
"combustivel": "EXEMPLO",
"anoFabricacao": "EXEMPLO",
"informacoesFipe": [
{
"ano": "EXEMPLO",
"marca": "EXEMPLO",
"fipeId": "EXEMPLO",
"modelo": "EXEMPLO",
"versao": "EXEMPLO",
"valorAtual": "EXEMPLO",
"combustivel": "EXEMPLO",
"historicoPreco": [
{
"ano": "EXEMPLO",
"mes": "EXEMPLO",
"valor": "EXEMPLO",
"predicao": false
},
{
"ano": "EXEMPLO",
"mes": "EXEMPLO",
"valor": "EXEMPLO",
"predicao": false
}
]
}
],
"informacoesGerais": [
{
"marca": "EXEMPLO",
"fipeId": "EXEMPLO",
"modelo": "EXEMPLO",
"versao": "EXEMPLO",
"idVersao": "EXEMPLO"
}
]
},
"municipioEmplacamento": "ABC1D23",
"decodificadorPrecificador": {
"cor": null,
"pais": null,
"marca": null,
"motor": null,
"chassi": null,
"modelo": null,
"origem": null,
"portas": null,
"regiao": null,
"tracao": null,
"versao": null,
"anoModelo": null,
"categoria": null,
"pesoBruto": null,
"tipoFreio": null,
"tipoMotor": null,
"codigoFipe": null,
"combustivel": null,
"comprimento": null,
"transmissao": null,
"anoFabricacao": null,
"classificacao": null,
"potenciaMotor": null,
"precificadorI": [],
"precificadorII": [],
"tipoCarroceria": null,
"localFabricacao": null,
"quantidadeEixos": null,
"distanciaEntreEixos": null,
"quantidadeIrregularidades": null
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3032Veículo Essencial
VeículosAnálise veicular por placa com cadastro, risco, FIPE, leilão, sinistro, roubo/furto e históricos disponíveis.
Contrato v1
3032
Veículo Essencial
VeículosAnálise veicular por placa com cadastro, risco, FIPE, leilão, sinistro, roubo/furto e históricos disponíveis.
Parâmetros
placa *Requisição
json
{
"placa": "ABC1D23"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3032,
"slug": "veiculo-essencial",
"nome": "Veículo Essencial",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"uf": null,
"cmt": "EXEMPLO",
"pbt": "EXEMPLO",
"eixos": "EXEMPLO",
"fotos": [],
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"cidade": null,
"leilao": {
"score": {
"score": null,
"aceitacao": null,
"pontuacao": null,
"percentualSobreRef": null,
"exigenciaVistoriaEspecial": null
},
"descricao": "Informação de exemplo",
"registros": []
},
"qtdPax": null,
"anuncio": {
"km": null,
"data": null,
"fotos": [],
"placa": null,
"valor": null,
"opcionais": [],
"observacao": null
},
"renavam": "12345678901",
"revisao": {
"veiculosFipe": []
},
"numMotor": "EXEMPLO",
"potencia": "EXEMPLO",
"anoModelo": "EXEMPLO",
"categoria": "EXEMPLO",
"municipio": "SAO PAULO",
"opcionais": [],
"acessorios": {
"veiculosFipe": []
},
"codigoFipe": [],
"corVeiculo": "EXEMPLO",
"custoMedio": {
"custoTotal": 1,
"custoCada10k": [],
"custoPlanoRevisaoTotal": 2020,
"custoDesgastePecasTotal": 1
},
"registroDi": null,
"restricoes": null,
"rouboFurto": {
"historico": [],
"constaOcorrencia": false,
"indicadorProcedencia": null,
"constaOcorrenciaAtiva": false,
"municipioEmplacamento": null
},
"ufFaturado": "EXEMPLO",
"caixaCambio": null,
"cestaBasica": {
"registros": [],
"veiculosFipe": []
},
"cilindradas": "EXEMPLO",
"combustivel": "EXEMPLO",
"docFaturado": "12345678000195",
"historicoKm": [],
"marcaModelo": "EXEMPLO",
"numFaturado": null,
"procedencia": "EXEMPLO",
"tipoVeiculo": "EXEMPLO",
"analiseRisco": {
"parecer": "EXEMPLO",
"imageLink": null,
"indiceRisco": "BAIXO"
},
"baseEstadual": {
"uf": "SP",
"cor": "EXEMPLO",
"tipo": "EXEMPLO",
"motor": "EXEMPLO",
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"especie": "EXEMPLO",
"licdata": "2026-01-15",
"pronome": null,
"renavam": "12345678901",
"categoria": "EXEMPLO",
"dataVenda": null,
"debitoDer": null,
"municipio": "SAO PAULO",
"debitoIpva": "EXEMPLO",
"combustivel": "EXEMPLO",
"debitoDersa": null,
"debitoDpvat": "EXEMPLO",
"observacoes": null,
"debitoCetesb": null,
"debitoDetran": null,
"debitoMultas": "EXEMPLO",
"debitoRenainf": null,
"dataEmissaoCrv": "2026-01-15",
"pronomeAnterior": null,
"situacaoVeiculo": "REGULAR",
"comunicacaoVenda": "EXEMPLO",
"debitoMunicipais": "PESSOA EXEMPLO",
"existeDebitoIpva": "EXEMPLO",
"restricaoGuincho": "EXEMPLO",
"restricaoRenajud": "EXEMPLO",
"existeDebitoDpvat": "EXEMPLO",
"existeDebitoMulta": "EXEMPLO",
"outrasRestricoes1": null,
"outrasRestricoes2": "EXEMPLO",
"outrasRestricoes3": "EXEMPLO",
"outrasRestricoes4": "EXEMPLO",
"restricaoJudicial": "EXEMPLO",
"dataAlteracaoMotor": null,
"restricaoAmbiental": null,
"tipoMarcacaoChassi": "9BWZZZ377VT004251",
"comunicacaoInclusao": null,
"debitoLicenciamento": "EXEMPLO",
"restricaoFinanceira": "EXEMPLO",
"restricaoNomeAgente": null,
"restricaoRouboFurto": "EXEMPLO",
"restricaoTributaria": "EXEMPLO",
"restricaoArrendatario": null,
"restricaoDataInclusao": null,
"exercicioLicenciamento": "EXEMPLO",
"restricaoAdminisrativa": "EXEMPLO",
"restricaoDocArrendatario": null,
"existeDebitoLicenciamento": "EXEMPLO",
"dataLimiteRestricaoTributaria": null,
"dataVigenciaContratoFinanceira": null,
"debitoPoliciaRodoviariaFederal": null,
"dataInclusaoIntencaoTrocaFinanceira": null
},
"baseNacional": {
"di": null,
"uf": "SP",
"cor": "EXEMPLO",
"motor": "EXEMPLO",
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"especie": null,
"renavam": "12345678901",
"anoModelo": "EXEMPLO",
"categoria": "EXEMPLO",
"municipio": "SAO PAULO",
"ocorrencia": null,
"restricao1": "EXEMPLO",
"restricao2": null,
"restricao3": null,
"restricao4": null,
"ufFaturado": "EXEMPLO",
"combustivel": "EXEMPLO",
"docFaturado": "12345678000195",
"tipoVeiculo": "EXEMPLO",
"dtEmissaoCrv": "2026-01-15",
"anoFabricacao": "EXEMPLO",
"especieVeiculo": "EXEMPLO",
"situacaoVeiculo": "REGULAR",
"tipoDocFaturado": "EXEMPLO",
"outrasRestricoes1": null,
"outrasRestricoes2": null,
"outrasRestricoes3": null,
"outrasRestricoes4": null,
"outrasRestricoes5": null,
"outrasRestricoes6": null,
"outrasRestricoes7": null,
"outrasRestricoes8": null,
"tipoDocImportadora": null,
"tipoMarcacaoChassi": null,
"dtUltimaAtualizacao": null,
"restricaoNomeAgente": null,
"restricaoDataInclusao": null,
"restricaoFinanciadora": null,
"restricaoFinanciamento": null,
"restricaoTipoTransacao": null,
"indicadorRestricaoRenajud": null,
"indicadorComunicacaoVendas": null
},
"capMaxTracao": "EXEMPLO",
"tipoMontagem": null,
"anoFabricacao": "EXEMPLO",
"nacionalidade": "EXEMPLO",
"numCarroceria": null,
"especieVeiculo": "EXEMPLO",
"situacaoChassi": "9BWZZZ377VT004251",
"tipoCarroceria": "EXEMPLO",
"valorAnunciado": null,
"capacidadeCarga": null,
"eixoTraseiroDif": "",
"indicioSinistro": {
"descricao": "Informação de exemplo",
"classificacao": null
},
"numTerceiroEixo": "",
"situacaoVeiculo": "REGULAR",
"tipoDocFaturado": "EXEMPLO",
"identImportadora": null,
"codigoCombustivel": null,
"codigoMarcaModelo": "",
"historicoAnuncios": [],
"tipoDocImportadora": null,
"ultimaDataInclusao": null,
"dtUltimaAtualizacao": null,
"limiteRestricaoTrib": null,
"capacidadePassageiro": "SAO PAULO",
"dadosBasicosDoVeiculo": {
"marca": "EXEMPLO",
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"nacional": "EXEMPLO",
"anoModelo": "EXEMPLO",
"descricao": "Informação de exemplo",
"codigoFipe": "1",
"cilindradas": "EXEMPLO",
"combustivel": "EXEMPLO",
"anoFabricacao": "EXEMPLO",
"informacoesFipe": [
{
"ano": "EXEMPLO",
"marca": "EXEMPLO",
"fipeId": "EXEMPLO",
"modelo": "EXEMPLO",
"versao": "EXEMPLO",
"valorAtual": "EXEMPLO",
"combustivel": "EXEMPLO",
"historicoPreco": [
{
"ano": "EXEMPLO",
"mes": "EXEMPLO",
"valor": "EXEMPLO",
"predicao": false
},
{
"ano": "EXEMPLO",
"mes": "EXEMPLO",
"valor": "EXEMPLO",
"predicao": false
}
]
},
{
"ano": "EXEMPLO",
"marca": "EXEMPLO",
"fipeId": "EXEMPLO",
"modelo": "EXEMPLO",
"versao": "EXEMPLO",
"valorAtual": "EXEMPLO",
"combustivel": "EXEMPLO",
"historicoPreco": [
{
"ano": "EXEMPLO",
"mes": "EXEMPLO",
"valor": "EXEMPLO",
"predicao": false
},
{
"ano": "EXEMPLO",
"mes": "EXEMPLO",
"valor": "EXEMPLO",
"predicao": false
}
]
}
],
"informacoesGerais": [
{
"marca": "EXEMPLO",
"fipeId": "EXEMPLO",
"modelo": "EXEMPLO",
"versao": "EXEMPLO",
"idVersao": "EXEMPLO"
},
{
"marca": "EXEMPLO",
"fipeId": "EXEMPLO",
"modelo": "EXEMPLO",
"versao": "EXEMPLO",
"idVersao": "EXEMPLO"
}
]
},
"municipioEmplacamento": null,
"historicoProprietarios": [
{
"uf": "SP",
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"cpfCnpj": "12345678000195",
"renavam": "12345678901",
"municipio": null,
"ocorrencia": null,
"anoExercicio": "EXEMPLO",
"proprietario": null,
"tipoDocumento": null,
"dataEmplacamento": null,
"dataProcessamento": null,
"motivoTipoAutorizacao": null,
"correlacaoChassiRenavam": false
}
],
"acessoriosCategorizados": {
"acessorios": [],
"categorias": []
},
"comparativoEspecificacoes": {
"opinioesDoDono": [],
"veiculoComparativo": []
},
"decodificadorPrecificador": {
"cor": null,
"pais": null,
"marca": null,
"motor": null,
"chassi": null,
"modelo": null,
"origem": null,
"portas": null,
"regiao": null,
"tracao": null,
"versao": null,
"anoModelo": null,
"categoria": null,
"pesoBruto": null,
"tipoFreio": null,
"tipoMotor": null,
"codigoFipe": null,
"combustivel": null,
"comprimento": null,
"transmissao": null,
"anoFabricacao": null,
"classificacao": null,
"potenciaMotor": null,
"precificadorI": [],
"precificadorII": [],
"tipoCarroceria": null,
"localFabricacao": null,
"quantidadeEixos": null,
"distanciaEntreEixos": null,
"quantidadeIrregularidades": null
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
3033Veículo Total
VeículosRelatório veicular amplo com cadastro, risco, FIPE, restrições, leilão, sinistro, roubo/furto, recall e gravames.
Contrato v1
3033
Veículo Total
VeículosRelatório veicular amplo com cadastro, risco, FIPE, restrições, leilão, sinistro, roubo/furto, recall e gravames.
Parâmetros
placa *Requisição
json
{
"placa": "ABC1D23"
}Resposta de homologação
json
{
"id": "request-id",
"status": "sucesso",
"ambiente": "homologacao",
"produto": {
"codigo": 3033,
"slug": "veiculo-total",
"nome": "Veículo Total",
"versao": "1"
},
"cobranca": {
"valor": 0,
"moeda": "BRL"
},
"processado_em": "2026-09-10T18:30:00.000Z",
"dados": {
"uf": "SP",
"cmt": null,
"pbt": "EXEMPLO",
"eixos": null,
"fotos": [],
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"cidade": null,
"leilao": {
"score": {
"score": null,
"aceitacao": null,
"pontuacao": null,
"percentualSobreRef": null,
"exigenciaVistoriaEspecial": null
},
"descricao": "Informação de exemplo",
"registros": []
},
"qtdPax": null,
"recall": {
"marca": "EXEMPLO",
"chassi": "9BWZZZ377VT004251",
"modelo": "EXEMPLO",
"detalhes": [
{
"risco": "BAIXO",
"defeito": "EXEMPLO",
"gravidade": null,
"codigoProcon": null,
"descricaoCompleta": "Informação de exemplo",
"dataInicioCampanha": "2026-01-15T12:00:00Z",
"telefoneConfirmacao": null,
"sujeitoConfirmacaoPelaMontadora": null
}
],
"anoModelo": "EXEMPLO",
"recallsPendente": [
{
"situacao": "REGULAR",
"descricao": "Informação de exemplo",
"identificador": "EXEMPLO",
"dataDoRegistro": "2026-01-15"
}
],
"descricaoRetorno": "Informação de exemplo"
},
"anuncio": {
"km": null,
"data": null,
"fotos": [],
"placa": null,
"valor": null,
"opcionais": [],
"observacao": null
},
"gravame": [],
"renavam": "12345678901",
"revisao": {
"veiculosFipe": []
},
"numMotor": "EXEMPLO",
"potencia": "EXEMPLO",
"anoModelo": "EXEMPLO",
"categoria": null,
"municipio": "SAO PAULO",
"opcionais": [],
"acessorios": {
"veiculosFipe": []
},
"codigoFipe": [],
"corVeiculo": "EXEMPLO",
"custoMedio": {
"custoTotal": 1,
"custoCada10k": [],
"custoPlanoRevisaoTotal": 2020,
"custoDesgastePecasTotal": 1
},
"registroDi": null,
"restricoes": null,
"rouboFurto": {
"historico": [],
"constaOcorrencia": false,
"indicadorProcedencia": null,
"constaOcorrenciaAtiva": false,
"municipioEmplacamento": null
},
"ufFaturado": "EXEMPLO",
"caixaCambio": "EXEMPLO",
"cestaBasica": {
"registros": [],
"veiculosFipe": []
},
"cilindradas": "EXEMPLO",
"combustivel": "EXEMPLO",
"docFaturado": "12345678000195",
"historicoKm": [],
"marcaModelo": "EXEMPLO",
"numFaturado": null,
"procedencia": "EXEMPLO",
"tipoVeiculo": "EXEMPLO",
"analiseRisco": {
"parecer": "EXEMPLO",
"imageLink": null,
"indiceRisco": "BAIXO"
},
"baseEstadual": {
"uf": "SP",
"cor": "EXEMPLO",
"tipo": "EXEMPLO",
"motor": "EXEMPLO",
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"especie": "EXEMPLO",
"licdata": "2026-01-15",
"pronome": "PESSOA EXEMPLO",
"renavam": "12345678901",
"categoria": "EXEMPLO",
"dataVenda": null,
"debitoDer": null,
"municipio": "SAO PAULO",
"debitoIpva": "EXEMPLO",
"combustivel": "EXEMPLO",
"debitoDersa": null,
"debitoDpvat": "EXEMPLO",
"observacoes": null,
"debitoCetesb": null,
"debitoDetran": null,
"debitoMultas": "EXEMPLO",
"debitoRenainf": null,
"dataEmissaoCrv": "2026-01-15",
"pronomeAnterior": null,
"situacaoVeiculo": "REGULAR",
"comunicacaoVenda": "EXEMPLO",
"debitoMunicipais": "PESSOA EXEMPLO",
"existeDebitoIpva": "EXEMPLO",
"restricaoGuincho": "EXEMPLO",
"restricaoRenajud": "EXEMPLO",
"existeDebitoDpvat": "EXEMPLO",
"existeDebitoMulta": "EXEMPLO",
"outrasRestricoes1": "EXEMPLO",
"outrasRestricoes2": "EXEMPLO",
"outrasRestricoes3": "EXEMPLO",
"outrasRestricoes4": "EXEMPLO",
"restricaoJudicial": "EXEMPLO",
"dataAlteracaoMotor": null,
"restricaoAmbiental": null,
"tipoMarcacaoChassi": "9BWZZZ377VT004251",
"comunicacaoInclusao": null,
"debitoLicenciamento": "EXEMPLO",
"restricaoFinanceira": "EXEMPLO",
"restricaoNomeAgente": null,
"restricaoRouboFurto": "EXEMPLO",
"restricaoTributaria": "EXEMPLO",
"restricaoArrendatario": null,
"restricaoDataInclusao": null,
"exercicioLicenciamento": "EXEMPLO",
"restricaoAdminisrativa": "EXEMPLO",
"restricaoDocArrendatario": null,
"existeDebitoLicenciamento": "EXEMPLO",
"dataLimiteRestricaoTributaria": null,
"dataVigenciaContratoFinanceira": null,
"debitoPoliciaRodoviariaFederal": null,
"dataInclusaoIntencaoTrocaFinanceira": null
},
"baseNacional": {
"di": "",
"uf": "SP",
"cor": "EXEMPLO",
"motor": "EXEMPLO",
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"especie": "EXEMPLO",
"renavam": "12345678901",
"anoModelo": "EXEMPLO",
"categoria": "EXEMPLO",
"municipio": "SAO PAULO",
"ocorrencia": "EXEMPLO",
"restricao1": "EXEMPLO",
"restricao2": "EXEMPLO",
"restricao3": "EXEMPLO",
"restricao4": "EXEMPLO",
"ufFaturado": "EXEMPLO",
"combustivel": "EXEMPLO",
"docFaturado": "12345678000195",
"tipoVeiculo": "EXEMPLO",
"dtEmissaoCrv": null,
"anoFabricacao": "EXEMPLO",
"especieVeiculo": "EXEMPLO",
"situacaoVeiculo": "REGULAR",
"tipoDocFaturado": "EXEMPLO",
"outrasRestricoes1": "EXEMPLO",
"outrasRestricoes2": "EXEMPLO",
"outrasRestricoes3": "EXEMPLO",
"outrasRestricoes4": "EXEMPLO",
"outrasRestricoes5": "EXEMPLO",
"outrasRestricoes6": "EXEMPLO",
"outrasRestricoes7": "EXEMPLO",
"outrasRestricoes8": "EXEMPLO",
"tipoDocImportadora": null,
"tipoMarcacaoChassi": "9BWZZZ377VT004251",
"dtUltimaAtualizacao": "EXEMPLO",
"restricaoNomeAgente": null,
"restricaoDataInclusao": null,
"restricaoFinanciadora": "EXEMPLO",
"restricaoFinanciamento": null,
"restricaoTipoTransacao": "EXEMPLO",
"indicadorRestricaoRenajud": "EXEMPLO",
"indicadorComunicacaoVendas": "EXEMPLO"
},
"capMaxTracao": "EXEMPLO",
"tipoMontagem": "EXEMPLO",
"anoFabricacao": "EXEMPLO",
"nacionalidade": "EXEMPLO",
"numCarroceria": "EXEMPLO",
"especieVeiculo": "EXEMPLO",
"situacaoChassi": "9BWZZZ377VT004251",
"tipoCarroceria": "EXEMPLO",
"valorAnunciado": null,
"capacidadeCarga": "SAO PAULO",
"eixoTraseiroDif": "",
"indicioSinistro": {
"descricao": "Informação de exemplo",
"classificacao": null
},
"numTerceiroEixo": "",
"situacaoVeiculo": "REGULAR",
"tipoDocFaturado": "EXEMPLO",
"identImportadora": null,
"codigoCombustivel": null,
"codigoMarcaModelo": "1",
"historicoAnuncios": [],
"registroEmLocadora": {
"registroEmLocadora": false
},
"tipoDocImportadora": null,
"ultimaDataInclusao": null,
"dtUltimaAtualizacao": null,
"limiteRestricaoTrib": null,
"capacidadePassageiro": "SAO PAULO",
"dadosBasicosDoVeiculo": {
"marca": "EXEMPLO",
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"nacional": "EXEMPLO",
"anoModelo": "EXEMPLO",
"descricao": "Informação de exemplo",
"codigoFipe": "1",
"cilindradas": "EXEMPLO",
"combustivel": "EXEMPLO",
"anoFabricacao": "EXEMPLO",
"informacoesFipe": [
{
"ano": "EXEMPLO",
"marca": "EXEMPLO",
"fipeId": "EXEMPLO",
"modelo": "EXEMPLO",
"versao": "EXEMPLO",
"valorAtual": "EXEMPLO",
"combustivel": "EXEMPLO",
"historicoPreco": [
{
"ano": "EXEMPLO",
"mes": "EXEMPLO",
"valor": "EXEMPLO",
"predicao": false
},
{
"ano": "EXEMPLO",
"mes": "EXEMPLO",
"valor": "EXEMPLO",
"predicao": false
}
]
},
{
"ano": "EXEMPLO",
"marca": "EXEMPLO",
"fipeId": "EXEMPLO",
"modelo": "EXEMPLO",
"versao": "EXEMPLO",
"valorAtual": "EXEMPLO",
"combustivel": "EXEMPLO",
"historicoPreco": [
{
"ano": "EXEMPLO",
"mes": "EXEMPLO",
"valor": "EXEMPLO",
"predicao": false
},
{
"ano": "EXEMPLO",
"mes": "EXEMPLO",
"valor": "EXEMPLO",
"predicao": false
}
]
}
],
"informacoesGerais": [
{
"marca": "EXEMPLO",
"fipeId": "EXEMPLO",
"modelo": "EXEMPLO",
"versao": "EXEMPLO",
"idVersao": "EXEMPLO"
},
{
"marca": "EXEMPLO",
"fipeId": "EXEMPLO",
"modelo": "EXEMPLO",
"versao": "EXEMPLO",
"idVersao": "EXEMPLO"
}
]
},
"municipioEmplacamento": null,
"historicoProprietarios": [
{
"uf": "SP",
"placa": "ABC1D23",
"chassi": "9BWZZZ377VT004251",
"cpfCnpj": "12345678000195",
"renavam": "12345678901",
"municipio": null,
"ocorrencia": null,
"anoExercicio": "EXEMPLO",
"proprietario": "EXEMPLO",
"tipoDocumento": null,
"dataEmplacamento": null,
"dataProcessamento": null,
"motivoTipoAutorizacao": null,
"correlacaoChassiRenavam": false
}
],
"acessoriosCategorizados": {
"acessorios": [],
"categorias": []
},
"comparativoEspecificacoes": {
"opinioesDoDono": [],
"veiculoComparativo": []
},
"decodificadorPrecificador": {
"cor": null,
"pais": null,
"marca": null,
"motor": null,
"chassi": null,
"modelo": null,
"origem": null,
"portas": null,
"regiao": null,
"tracao": null,
"versao": null,
"anoModelo": null,
"categoria": null,
"pesoBruto": null,
"tipoFreio": null,
"tipoMotor": null,
"codigoFipe": null,
"combustivel": null,
"comprimento": null,
"transmissao": null,
"anoFabricacao": null,
"classificacao": null,
"potenciaMotor": null,
"precificadorI": [],
"precificadorII": [],
"tipoCarroceria": null,
"localFabricacao": null,
"quantidadeEixos": null,
"distanciaEntreEixos": null,
"quantidadeIrregularidades": null
}
},
"_links": {
"resultado": "/v1/resultados/ID_DA_EXECUCAO"
}
}Estrutura observada em uma resposta real; valores e identificadores foram substituídos por dados fictícios.
08
Consultar saldo
O saldo disponível já desconsidera valores reservados por chamadas em processamento.
bash
curl 'https://api.cobrativa.com.br/v1/saldo' \
--header 'Authorization: Bearer SUA_CHAVE_COMPLETA_DE_PRODUCAO'json
{
"saldo": {
"disponivel": 250,
"reservado": 4.9,
"moeda": "BRL",
"atualizado_em": "2026-09-10T18:30:00.000Z"
}
}09
Erros HTTP
Erros seguem o mesmo envelope e usam códigos legíveis e estáveis.
json
{
"id": null,
"status": "erro",
"erro": {
"codigo": "SALDO_INSUFICIENTE",
"mensagem": "Saldo insuficiente para esta consulta."
}
}| Código | Quando ocorre | HTTP |
|---|---|---|
| CHAVE_INVALIDA | Chave ausente, inválida ou de outro ambiente | 401 |
| SALDO_INSUFICIENTE | Saldo disponível menor que o preço efetivo | 402 |
| CONSULTA_NAO_ENCONTRADA | Produto inexistente, desativado ou arquivado | 404 |
| PARAMETROS_INVALIDOS | Campo obrigatório ausente ou inválido | 422 |
| RATE_LIMIT_EXCEDIDO | Limite de requisições por minuto atingido | 429 |
| CONSULTA_EM_MANUTENCAO | Produção bloqueada temporariamente | 503 |
| PROVEDOR_TEMPORARIAMENTE_INDISPONIVEL | Falha técnica; saldo não cobrado | 502 |
10
Boas práticas
Use idempotência
Gere uma chave por operação e preserve-a durante retries.
Respeite Retry-After
Em um 202, repita somente o GET do resultado e nunca o POST com outra chave.
Registre o id
O campo id permite correlacionar suporte, histórico e seus logs.
Consulte /status
Antes de alertar sua operação, confira incidentes e manutenções.
Versione seu parser
Interprete dados de acordo com produto.versao.
Proteja dados pessoais
Aplique LGPD, controle de acesso e retenção mínima necessária.