Consulta CPF — Score Boa Vista
Last updated
Retorna scores Boa Vista e informações de crédito vinculadas ao CPF: identificação, endereço, renda presumida, protestos, resumo de débitos, ações cíveis, participações empresariais e histórico de consultas, conforme disponibilidade de cada grupo.
| Propriedade | Valor |
|---|---|
| Dataset | cpf_score_boa_vista |
| Método e caminho | POST /datasets/cpf_score_boa_vista/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_boa_vista/queries' \
--header 'Authorization: Bearer <API_KEY>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: exemplo-cpf-score-boa-vista-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. Nomes, pontuações, valores, participações, ocorrências e demais dados abaixo são sintéticos; não representam crédito, restrição ou processo real, uma resposta garantida ou comprovação de titularidade. O exemplo contém um item em cada lista para demonstrar a estrutura. O envelope comum descreve os campos externos a data.
{
"cpf": "52998224725",
"identification": {
"name": "Pessoa de Exemplo",
"mother_name": "Mãe de Exemplo",
"birth_date": "1990-04-15",
"registration_status": "Regular"
},
"address": {
"street": "Rua Exemplo",
"number": "100",
"complement": "Sala de Exemplo",
"district": "Bairro de Exemplo",
"city": "São Paulo",
"state": "SP",
"postal_code": "00000000"
},
"scores": [
{
"score": 750,
"name": "Score de Exemplo",
"rating": "B",
"default_probability_percent": 5.5,
"description": "Descrição de exemplo para a pontuação.",
"observation": "Observação de exemplo."
}
],
"presumed_income": [
{
"description": "Faixa de renda de exemplo",
"explanation": "Descrição sintética de uma estimativa de renda."
}
],
"protests": {
"total": 1,
"total_amount_cents": 125050,
"items": [
{
"date": "2026-09-10",
"amount_cents": 125050,
"registry_office": "Cartório de Exemplo",
"city": "São Paulo",
"state": "SP"
}
]
},
"debt_summary": {
"debtor_count": 0,
"guarantor_count": 0,
"total_amount_cents": 0
},
"civil_actions": {
"total": 1,
"items": [
{
"case_number": "0000000-00.2026.0.00.0000",
"case_type": "Ação de Exemplo",
"judicial_district": "Comarca de Exemplo",
"plaintiff": "Parte de Exemplo",
"filed_date": "2026-02-10",
"value_cents": 1500000
}
]
},
"company_participations": [
{
"document": null,
"company_name": "Empresa de Exemplo",
"participation_percent": 25,
"joined_date": "2020-01-10"
}
],
"query_history": {
"total": 1,
"items": [
{
"queried_at": "2026-09-15T12:30:00.000Z",
"requester": "Solicitante de Exemplo",
"occurrence_type": "Consulta de Exemplo"
}
]
}
}
Contrato de data
data é um objeto ou null. Quando há dados, todas as propriedades de cada objeto existente estão presentes, sem propriedades adicionais. Grupos anuláveis podem ser null; listas podem ser []. Campos textuais não anuláveis podem ser "". null significa informação ausente ou desconhecida e não deve ser substituído por zero.
Todos os arrays têm no máximo 1.000 itens. Inteiros são seguros; contagens e valores monetários são não negativos. Valores com sufixo _cents estão em centavos de BRL, sem separador decimal: 125050 representa R$ 1.250,50. Percentuais estão na escala de 0 a 100: 5.5 significa 5,5%, e não 550%.
Textos são retornados sem caracteres de controle. Salvo os limites específicos abaixo, textos têm até 500 unidades UTF-16. Datas usam YYYY-MM-DD; queried_at usa timestamp ISO 8601 em UTC. Uma data civil não sofre conversão de fuso.
Grupos principais
| Campo | Tipo | Descrição |
|---|---|---|
cpf |
string |
CPF consultado, com 11 dígitos sem pontuação. |
identification |
object ou null |
Identificação da pessoa. |
address |
object ou null |
Endereço informado na consulta de crédito. |
scores |
array<object> |
Pontuações e informações associadas; pode conter mais de um score. |
presumed_income |
array<object> |
Descrições de renda presumida. Não equivale a comprovação de renda. |
protests |
object ou null |
Resumo e itens de protestos. |
debt_summary |
object ou null |
Resumo de registros de débito como devedor ou avalista. |
civil_actions |
object ou null |
Resumo e itens de ações cíveis. |
company_participations |
array<object> |
Participações empresariais informadas. |
query_history |
object ou null |
Resumo e histórico de consultas de crédito disponíveis. Não é o histórico de requisições da conta nesta API. |
Identificação e endereço
| Campo | Tipo | Descrição |
|---|---|---|
identification.name |
string |
Nome informado. |
identification.mother_name |
string ou null |
Nome da mãe, quando informado. |
identification.birth_date |
string ou null |
Data de nascimento em YYYY-MM-DD. |
identification.registration_status |
string |
Situação cadastral, sem enumeração fixa. |
address.street |
string |
Logradouro, incluindo seu tipo quando disponível. |
address.number |
string |
Número preservado como texto. |
address.complement |
string |
Complemento. |
address.district |
string |
Bairro. |
address.city |
string |
Município. |
address.state |
string |
UF no formato informado. |
address.postal_code |
string |
CEP conforme informação disponível; pode preservar máscara ou estar incompleto. |
Scores e renda presumida
| Campo | Tipo | Descrição e limites |
|---|---|---|
scores[].score |
integer ou null |
Pontuação não negativa. O contrato não fixa teto de 1.000 nem escala única. Zero é um valor válido. |
scores[].name |
string |
Nome ou modalidade da pontuação. |
scores[].rating |
string |
Classificação alfabética informada, sem enumeração fixa. |
scores[].default_probability_percent |
number ou null |
Probabilidade de inadimplência informada, entre 0 e 100%. |
scores[].description |
string |
Descrição da pontuação; até 2.000 unidades. |
scores[].observation |
string |
Observação associada; até 2.000 unidades. |
presumed_income[].description |
string |
Descrição da renda presumida; até 2.000 unidades. |
presumed_income[].explanation |
string |
Explicação da estimativa; até 2.000 unidades. |
Um resultado com dados não exige um score numérico: outros campos e grupos podem conter informação útil. Itens de score ou renda presumida sem qualquer informação aproveitável não integram suas respectivas listas.
Protestos e débitos
| Campo | Tipo | Descrição |
|---|---|---|
protests.total |
integer ou null |
Quantidade total de protestos informada, não negativa. |
protests.total_amount_cents |
integer ou null |
Valor total informado para protestos, em centavos de BRL. |
protests.items |
array<object> |
Até 1.000 registros de protesto disponíveis. |
protests.items[].date |
string ou null |
Data do protesto em YYYY-MM-DD. |
protests.items[].amount_cents |
integer ou null |
Valor do protesto em centavos de BRL. |
protests.items[].registry_office |
string |
Identificação do cartório informada. |
protests.items[].city |
string |
Município informado para o protesto. |
protests.items[].state |
string |
UF informada para o protesto. |
debt_summary.debtor_count |
integer ou null |
Quantidade de registros como devedor, não negativa. |
debt_summary.guarantor_count |
integer ou null |
Quantidade de registros como avalista, não negativa. |
debt_summary.total_amount_cents |
integer ou null |
Valor acumulado informado para os débitos, em centavos de BRL. |
Ações cíveis e participações empresariais
| Campo | Tipo | Descrição |
|---|---|---|
civil_actions.total |
integer ou null |
Quantidade total de ações informada, não negativa. |
civil_actions.items |
array<object> |
Até 1.000 ações disponíveis. |
civil_actions.items[].case_number |
string |
Número do processo conforme informação disponível; sem padrão único garantido. |
civil_actions.items[].case_type |
string |
Tipo da ação. |
civil_actions.items[].judicial_district |
string |
Comarca ou foro informado. |
civil_actions.items[].plaintiff |
string |
Autor da ação informado. |
civil_actions.items[].filed_date |
string ou null |
Data de distribuição em YYYY-MM-DD. |
civil_actions.items[].value_cents |
integer ou null |
Valor informado para a ação, em centavos de BRL. |
company_participations[].document |
string ou null |
Documento da empresa informado, com pontos, hífens, barras e espaços removidos. Não há garantia de validação de dígitos ou formato completo. |
company_participations[].company_name |
string |
Razão social informada. |
company_participations[].participation_percent |
number ou null |
Percentual de participação, entre 0 e 100%. |
company_participations[].joined_date |
string ou null |
Data de entrada na sociedade em YYYY-MM-DD. |
Histórico de consultas
| Campo | Tipo | Descrição |
|---|---|---|
query_history.total |
integer ou null |
Quantidade total de consultas informada, não negativa. |
query_history.items |
array<object> |
Até 1.000 registros de consultas disponíveis. |
query_history.items[].queried_at |
string ou null |
Data e hora da consulta em timestamp UTC, como 2026-09-15T12:30:00.000Z. |
query_history.items[].requester |
string |
Solicitante ou informante da consulta. |
query_history.items[].occurrence_type |
string |
Tipo de ocorrência informado, sem enumeração fixa. |
Os totais dos grupos são informações de resumo e não precisam ser iguais ao comprimento dos respectivos arrays. Não há ordenação ou remoção de duplicidades garantida para essas listas. A consulta de ações cíveis nesta página não substitui o contrato específico de processos.
Ausência de dados e cobrança
Ausência reconhecida de informação aproveitável em todos os grupos produz status: "no_data" e data: null, sem cobrança. Grupos individuais ausentes podem ser null ou listas vazias em um resultado com dados. Informações zeradas, como ausência informada de débitos, são dados úteis; não equivalem a no_data.
Em uma consulta comum com status: "succeeded", aplica-se o preço efetivo da conta, inclusive quando os resumos indicam zero ocorrências ou não há score numérico, mas há outros dados. Uma resposta incoerente ou valores presentes incompatíveis com o contrato resultam em erro, sem cobrança; não são convertidos silenciosamente em zero.
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_boa_vista/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.