Consulta CPF — Score QUOD
Last updated
Retorna a pontuação de crédito QUOD associada ao CPF informado. O contrato desta consulta contém apenas a pontuação: identificação, classificação de risco e demais informações cadastrais não integram data.
| Propriedade | Valor |
|---|---|
| Dataset | cpf_score_quod |
| Método e caminho | POST /datasets/cpf_score_quod/queries |
Versão do schema de dados (schema_version) |
1.0.0 |
| Entrada | CPF |
| Consultas em lote | Não suportadas |
Requisição
curl --request POST 'https://api.verifica-online.com.br/datasets/cpf_score_quod/queries' \
--header 'Authorization: Bearer <API_KEY>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: exemplo-cpf-score-quod-001' \
--data '{"cpf":"52998224725"}'
{
"cpf": "52998224725"
}
| Campo | Tipo | Obrigatório | Regras |
|---|---|---|---|
cpf |
string |
Sim | Exatamente 11 dígitos, sem pontuação ou espaços, com dígitos verificadores válidos. Sequências de um único dígito repetido são rejeitadas. |
O corpo aceita somente cpf; campos adicionais e CPF numérico são rejeitados. Não são aceitos parâmetros de consulta na URL. Validar os dígitos não comprova existência, identidade ou titularidade do documento.
Veja autenticação e requisições, idempotência e cobrança.
Exemplo de data
O CPF é didático e a pontuação abaixo é sintética. O exemplo não garante resposta, pontuação real ou titularidade do documento. O envelope comum identifica a operação fora de data.
{
"score": 750
}
Contrato de data
data é um objeto ou null. Quando o objeto existe, score é obrigatório e não há propriedades adicionais.
| Campo | Tipo | Descrição e limites |
|---|---|---|
score |
integer |
Pontuação de crédito, como inteiro seguro não negativo. O contrato não estabelece teto de 1.000 nem uma escala fixa de classificação. |
score: 0 é uma pontuação válida, diferente de ausência de score. A pontuação não é um valor monetário nem uma porcentagem. O retorno não inclui cpf, nome, classificação alfabética ou probabilidade de inadimplência no objeto data.
Ausência de dados e cobrança
Ausência reconhecida de informação de score produz status: "no_data" e data: null, sem cobrança. Um score inválido, negativo ou não inteiro resulta em erro, sem cobrança; esse caso não é convertido em zero. Não é necessário que o score seja positivo para a consulta terminar com dados.
Em uma consulta comum com status: "succeeded", aplica-se o preço efetivo da conta, inclusive para score: 0. Consulte GET /datasets para disponibilidade, schema e preço vigentes, e billing para a cobrança da operação. Veja resultados e erros.
Consultas em lote
Este dataset não aceita lotes. POST /datasets/cpf_score_quod/batches retorna o erro batch_not_supported. O contrato geral e a relação de disponibilidade em batch.enabled estão descritos em consultas em lote.