Consulta CNPJ — Score Boa Vista
Last updated
Retorna informações de crédito da empresa, incluindo scores, identificação cadastral, protestos, resumos de restrições e histórico de consultas, conforme disponibilidade.
| Propriedade | Valor |
|---|---|
| Dataset | cnpj_score_boa_vista |
| Método e caminho | POST /datasets/cnpj_score_boa_vista/queries |
Versão do schema de dados (schema_version) |
1.0.0 |
| Entrada | CNPJ |
| Consultas em lote | Não suportadas |
Requisição
<API_KEY> representa uma chave válida da conta:
curl --request POST 'https://api.verifica-online.com.br/datasets/cnpj_score_boa_vista/queries' \
--header 'Authorization: Bearer <API_KEY>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: cnpj-boa-vista-exemplo-001' \
--data '{"cnpj":"11222333000181"}'
{
"cnpj": "11222333000181"
}
O CNPJ é didático. Empresa, endereço e ocorrências dos exemplos são ilustrativos e fictícios e não indicam vínculo real com o documento.
Entrada
| Campo | Tipo | Obrigatório | Regra |
|---|---|---|---|
cnpj |
string | Sim | Exatamente 14 caracteres, sem pontuação ou espaços: 12 posições de A–Z ou 0–9, seguidas de dois dígitos verificadores. Letras devem estar em maiúsculas; os dígitos verificadores são conferidos. |
O corpo aceita somente cnpj; números e campos adicionais são rejeitados. Preserve zeros iniciais. A chave de idempotência, quando enviada, aceita de 8 a 128 caracteres de A–Z, a–z, 0–9, _, ., :, -; consulte requisições e cobrança.
Dados de resposta
Exemplo completo do campo data:
{
"cnpj": "11222333000181",
"company": {
"legal_name": "Empresa Exemplo Ltda.",
"trade_name": "Empresa Exemplo",
"registration_status": "Ativa",
"registration_status_date": "2024-01-10",
"started_at": "2018-05-20",
"legal_nature": {
"code": "2062",
"description": "Sociedade Empresária Limitada"
},
"primary_activity": {
"code": "6201501",
"description": "Desenvolvimento de programas de computador sob encomenda"
}
},
"address": {
"street": "Rua de Exemplo",
"number": "100",
"complement": "Sala 1",
"district": "Bairro Exemplo",
"city": "Cidade Exemplo",
"state": "SP",
"postal_code": "00000000"
},
"scores": [
{
"score": 650,
"name": "Score empresarial de exemplo",
"rating": "B",
"default_probability_percent": 4.5,
"description": "Classificação ilustrativa",
"observation": "Informação de exemplo"
}
],
"protests": {
"total": 1,
"total_amount_cents": 125000,
"items": [
{
"date": "2025-04-15",
"due_date": "2025-03-20",
"amount_cents": 125000,
"registry_office": "1",
"city": "Cidade Exemplo",
"state": "SP"
}
]
},
"restrictions": {
"debt_records": {
"total": 1,
"last_date": "2025-05-12",
"total_amount_cents": 50000
},
"bad_checks": null,
"stopped_checks": null,
"civil_actions": null,
"recoveries": null,
"bankruptcies": null
},
"query_history": {
"total": 1,
"items": [
{
"queried_at": "2025-06-01T12:30:00.000Z",
"requester": "Organização Exemplo",
"requester_cnpj": null
}
]
}
}
Os objetos podem ser null nas posições indicadas; quando presentes, incluem todos os seus campos. Campos textuais não nulos podem ser "". Listas vazias indicam ausência de itens naquele bloco; cada lista possui no máximo 1.000 itens. Datas são YYYY-MM-DD; horários são ISO 8601 em UTC. Valores com sufixo _cents são centavos de BRL. Zero não equivale a desconhecido: null indica informação ausente.
Campo em data |
Tipo | Nulo | Descrição |
|---|---|---|---|
cnpj |
string | Não | CNPJ consultado. |
company |
object | Sim | Identificação cadastral da empresa. |
company.legal_name |
string | Não | Razão social. |
company.trade_name |
string | Sim | Nome fantasia. |
company.registration_status |
string | Não | Situação cadastral informada. |
company.registration_status_date |
string | Sim | Data da situação cadastral. |
company.started_at |
string | Sim | Data de início ou fundação. |
company.legal_nature |
object | Não | Natureza jurídica. |
company.legal_nature.code |
string | Não | Código da natureza jurídica. |
company.legal_nature.description |
string | Não | Descrição da natureza jurídica. |
company.primary_activity |
object | Sim | Atividade econômica principal. |
company.primary_activity.code |
string | Não | Código da atividade. |
company.primary_activity.description |
string | Não | Descrição da atividade. |
address |
object | Sim | Endereço disponível. |
address.street |
string | Não | Logradouro. |
address.number |
string | Não | Número, preservado como texto. |
address.complement |
string | Não | Complemento. |
address.district |
string | Não | Bairro. |
address.city |
string | Não | Município. |
address.state |
string | Não | UF. |
address.postal_code |
string | Não | CEP, preservado como texto. |
scores |
array de object | Não | Scores disponíveis, até 1.000. Pode estar vazia mesmo quando outros blocos contêm dados. |
scores[].score |
integer | Sim | Pontuação maior ou igual a zero. O contrato não define teto comum nem faixas de risco. |
scores[].name |
string | Não | Nome do score. |
scores[].rating |
string | Não | Classificação informada, sem enumeração fechada. |
scores[].default_probability_percent |
number | Sim | Probabilidade de inadimplência em percentual de 0 a 100; 4.5 representa 4,5%. |
scores[].description |
string | Não | Explicação, até 2.000 caracteres. |
scores[].observation |
string | Não | Observação, até 2.000 caracteres. |
protests |
object | Sim | Resumo e itens de protestos. |
protests.total |
integer | Sim | Quantidade informada, maior ou igual a zero; pode diferir dos detalhes disponíveis. |
protests.total_amount_cents |
integer | Sim | Valor total informado, maior ou igual a zero. |
protests.items |
array de object | Não | Protestos disponíveis, até 1.000. |
protests.items[].date |
string | Sim | Data do protesto. |
protests.items[].due_date |
string | Sim | Data de vencimento. |
protests.items[].amount_cents |
integer | Sim | Valor do protesto, maior ou igual a zero. |
protests.items[].registry_office |
string | Não | Identificação do cartório. |
protests.items[].city |
string | Não | Município do cartório. |
protests.items[].state |
string | Não | UF do cartório. |
restrictions |
object | Sim | Resumos por categoria. Cada categoria abaixo pode ser null. |
restrictions.debt_records |
object | Sim | Registros de débito. |
restrictions.bad_checks |
object | Sim | Cheques sem fundos. |
restrictions.stopped_checks |
object | Sim | Cheques sustados. |
restrictions.civil_actions |
object | Sim | Ações cíveis. |
restrictions.recoveries |
object | Sim | Recuperações. |
restrictions.bankruptcies |
object | Sim | Falências. |
query_history |
object | Sim | Histórico de consultas disponível. |
query_history.total |
integer | Sim | Quantidade informada, maior ou igual a zero; pode diferir de items.length. |
query_history.items |
array de object | Não | Consultas disponíveis, até 1.000. |
query_history.items[].queried_at |
string | Sim | Horário da consulta em UTC. |
query_history.items[].requester |
string | Não | Nome de quem realizou a consulta. |
query_history.items[].requester_cnpj |
string | Sim | CNPJ do solicitante sem pontuação e com letras em maiúsculas, quando informado. |
Cada objeto presente em restrictions.debt_records, restrictions.bad_checks, restrictions.stopped_checks, restrictions.civil_actions, restrictions.recoveries e restrictions.bankruptcies possui os três campos abaixo:
| Campo da categoria | Tipo | Nulo | Descrição |
|---|---|---|---|
total |
integer | Sim | Quantidade de ocorrências, maior ou igual a zero. |
last_date |
string | Sim | Data da última ocorrência, em YYYY-MM-DD. |
total_amount_cents |
integer | Sim | Valor total das ocorrências em centavos de BRL, maior ou igual a zero. |
Ausência de dados, falhas e cobrança
O resultado pode conter alguns blocos e ter outros como null ou listas vazias. A ausência de todos os dados úteis resulta em status: "no_data" e data: null, sem cobrança. Um resumo com quantidade ou valor zero é informação válida. Respostas inválidas e falhas de execução não são apresentadas como inexistência de restrições.
Um resultado válido com dados retorna status: "succeeded" e é cobrado pelo preço efetivo da conta. Preço e disponibilidade são consultados em GET /datasets.
Este dataset não suporta consultas em lote. Consulte a referência de lotes para os datasets que oferecem essa modalidade.
Consulte também autenticação, envelope e recuperação dos resultados e erros.