Sign In

Consulta CNPJ — Score QUOD

Last updated

Retorna a pontuação de crédito vinculada ao CNPJ informado.

Propriedade Valor
Dataset cnpj_score_quod
Método e caminho POST /datasets/cnpj_score_quod/queries
Versão do schema de dados (schema_version) 1.0.0
Entrada CNPJ
Consultas em lote Não suportadas

Requisição

Exemplo de requisição, substituindo <API_KEY> por uma chave válida:

curl --request POST 'https://api.verifica-online.com.br/datasets/cnpj_score_quod/queries' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: cnpj-quod-exemplo-001' \
  --data '{"cnpj":"11222333000181"}'
{
  "cnpj": "11222333000181"
}

O CNPJ é didático; os exemplos são ilustrativos e não representam uma consulta realizada ou uma empresa identificada.

Entrada

Campo Tipo Obrigatório Regra
cnpj string Sim Exatamente 14 caracteres, sem pontuação ou espaços. As primeiras 12 posições aceitam A–Z e 0–9; as duas últimas são dígitos verificadores. Letras devem estar em maiúsculas. O cálculo dos dígitos verificadores é validado.

O corpo aceita somente cnpj; campos adicionais e valores numéricos são rejeitados. Preserve zeros iniciais. A chave de idempotência, quando enviada, deve conter de 8 a 128 caracteres de A–Z, a–z, 0–9, _, ., :, -. Sua reutilização deve seguir as regras de requisições e cobrança.

Dados de resposta

Exemplo do campo data em uma consulta com resultado:

{
  "score": 650
}
Campo em data Tipo Nulo Descrição
score integer Não Pontuação de crédito, inteira e maior ou igual a zero. O contrato não estabelece um teto nem uma classificação de risco derivada da pontuação.

O objeto de resultado contém somente score. O CNPJ não é repetido em data. A pontuação zero é um valor válido e não equivale a ausência de dados.

Ausência de dados, falhas e cobrança

Ausência reconhecida de pontuação resulta em status: "no_data" e data: null, sem cobrança. Uma resposta incoerente, uma pontuação inválida ou uma falha na consulta não é convertida em zero nem em um resultado sem dados. Consultas com resultado válido têm status: "succeeded" e são cobradas pelo preço efetivo da conta. Consulte GET /datasets para verificar preço e disponibilidade.

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.