Score de Crédito

Score e dados cadastrais de CPF/CNPJ, mediante finalidade declarada (LGPD).

score-creditoJSONPDFR$ 12,99Dado pessoal

Resumo

Item	Valor
Identificador técnico	`score-credito`
Dados exigidos	documento (CPF ou CNPJ) (no catálogo: `documento`)
O que devolve	JSON do provedor + PDF
Preço vigente	R$ 12,99. Com a sua chave, `GET /v1/servicos` traz o seu preço.
Prazo	Poucos minutos.
Bloco veiculo	Não
Observação	Dado de pessoa (CPF/CNPJ): exige finalidade declarada e fica registrado quem consultou, quando e para quê.

Requisição

Pelo endpoint comum de consultas, POST /v1/consultas. Os valores do exemplo são fictícios.

cURLPOST /v1/consultas (score-credito)

curl -X POST "https://api.zapcarconsulta.com.br/v1/consultas" \
  -H "Authorization: Bearer $ZAPCAR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: pedido-erp-984281-score-credito" \
  -d '{"servico":"score-credito","documento":"12345678909","finalidade":"ANALISE_CREDITO","declaracao_finalidade":true}'

Resposta

O POST devolve 201 com o id e status: "processando". O resultado sai em GET /v1/consultas/{id}, que passa por um destes estados:

status	O que vem
processando	Só o envelope. Consulte de novo em 3 a 5 s.
concluido	`dados` e `pdf_url`.
erro	Valor estornado. `erro_codigo` diz o motivo e `retryable` se vale criar uma consulta nova.

Campo dados

No formato da base consultada (camada de espelho): nomes e preenchimento acompanham a fonte. Para dado com forma garantida, use o bloco veiculo quando o serviço tiver.

JSONExemplo ilustrativo: campo dados (score-credito)

{
  "dados receita federal": {
    "tipo_pessoa": "Física",
    "nome": "FULANO DE TAL",
    "situacao_receita": "REGULAR",
    "data_nascimento_fundacao": "01/01/1990",
    "nome_mae": "CICLANA DE TAL"
  },
  "score": {
    "ocorrencias": [
      { "tipo_score": "score portfolio", "score": "780", "probabilidade_inadimplencia": "3,2" }
    ]
  },
  "email": { "registro_localizado": "S", "informado": "fulano@exemplo.com" },
  "numero_endereco": {
    "dados": [ { "endereco": "RUA EXEMPLO", "numero": "100", "bairro": "CENTRO", "cidade": "SAO PAULO", "uf": "SP", "cep": "01000000" } ]
  },
  "renda_presumida": { "faixa": "R$ 3.000,00 a R$ 5.000,00", "valor_presumido": "R$ 4.200,00 ao mês" }
}

Particularidades

documento aceita CPF ou CNPJ.
finalidade e declaracao_finalidade ficam registradas quando enviadas. Na API a ausência delas não recusa o pedido, mas envie sempre: é dado de pessoa e a finalidade é a base legal do seu uso.

No sandbox

Sem placa, os cenários TST* não se aplicam: a consulta conclui com dados fictício reduzido e, como em produção, sem bloco veiculo.

Cobrança

Debitado no POST, antes do processamento, e estornado automaticamente se a consulta terminar em erro. Pedido recusado na validação (400, 402, 409, 422) não cobra. Ler o resultado e baixar o documento são gratuitos. Ver Cobrança e estorno.

Dado pessoal

Use só para a finalidade declarada e não redistribua o JSON nem o PDF. Ver Segurança e LGPD.

Testar no sandbox: abrir no API Explorer. Base da API: https://api.zapcarconsulta.com.br.