Crédito Único CPF
Pendências financeiras (negativações) do CPF com credor, contrato, data e valor, e dados de localização.
credito-unico-cpfJSONPDFR$ 9,90Dado pessoal
Resumo
| Item | Valor |
|---|---|
| Identificador técnico | credito-unico-cpf |
| Dados exigidos | documento (CPF), finalidade e declaracao_finalidade: true (no catálogo: documento) |
| O que devolve | JSON de pessoa (pendencias_financeiras, identificacao, contatos) + PDF |
| Preço vigente | R$ 9,90. Com a sua chave, GET /v1/servicos traz o seu preço. |
| Prazo | Poucos minutos. |
| Bloco veiculo | Não |
| Observação | Dado de pessoa: exige finalidade declarada e fica registrado quem consultou, quando e para quê. Sem registro na base, nada é cobrado. |
Requisição
Pelo endpoint comum de consultas, POST /v1/consultas. Os valores do exemplo são fictícios.
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-credito-unico-cpf" \
-d '{"servico":"credito-unico-cpf","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 (formato comum das consultas de pessoa)
Os 11 serviços de pessoa entregam o mesmo formato; cada um preenche os blocos que a base dele traz. Bloco null = a base não informou; lista vazia = respondeu e não há ocorrência.
produtostringpode não virExemplo: CREDITO_BIRO_CPF
documentostringpode não virSó dígitos.
Exemplo: 12345678909
tipo_documentostringpode não virValores:
CPFCNPJufstring · aceita nullpode não virExemplo: SP
identificacaoobjeto · aceita nullpode não virCampos de identificacao
nomestring · aceita nullpode não virdata_nascimentostring · aceita nullpode não viridadeinteger · aceita nullpode não virsexostring · aceita nullpode não virnome_maestring · aceita nullpode não virrgstring · aceita nullpode não viruf_rgstring · aceita nullpode não virtitulo_eleitorstring · aceita nullpode não virsituacao_cpfstring · aceita nullpode não virExemplo: REGULAR
data_situacao_cpfstring · aceita nullpode não virestado_civilstring · aceita nullpode não virescolaridadestring · aceita nullpode não virdependentesstring · aceita nullpode não virregiao_cpfstring · aceita nullpode não virempresaobjeto · aceita nullpode não virCampos de empresa
razao_socialstring · aceita nullpode não virnome_fantasiastring · aceita nullpode não virsituacaostring · aceita nullpode não virExemplo: ATIVA
data_situacaostring · aceita nullpode não virdata_aberturastring · aceita nullpode não virnatureza_juridicastring · aceita nullpode não vircnaestring · aceita nullpode não viratividade_secundariastring · aceita nullpode não virportestring · aceita nullpode não virfaturamento_presumidostring · aceita nullpode não virfuncionariosstring · aceita nullpode não virsitestring · aceita nullpode não virquantidade_filiaisstring · aceita nullpode não virnirestring · aceita nullpode não virrenda_presumidastring · aceita nullpode não virenderecosarray de EnderecoPessoa · aceita nullpode não virFormato: array de EnderecoPessoa
telefonesarray de objeto · aceita nullpode não virCampos de telefones
numerostringpode não virExemplo: (19) 99999-0000
tipostring · aceita nullpode não virValores:
CelularFixoatualizado_emstring · aceita nullpode não viremailsarray de string · aceita nullpode não virsociosarray de objeto · aceita nullpode não virCampos de socios
nomestring · aceita nullpode não virdocumentostring · aceita nullpode não virqualificacaostring · aceita nullpode não virparticipacaostring · aceita nullpode não virExemplo: 50%
entradastring · aceita nullpode não virsaidastring · aceita nullpode não virrelacaostringpode não virparticipacao = empresa em que o CONSULTADO é sócio.Valores:
socioadministradorparticipacaofiliaisarray de objeto · aceita nullpode não virCampos de filiais
nomestring · aceita nullpode não vircidadestring · aceita nullpode não virscoreobjeto · aceita nullpode não virCampos de score
valorinteger · aceita nullpode não virExemplo: 812
riscostring · aceita nullpode não virExemplo: BAIXO
mensagem_riscostring · aceita nullpode não virprobabilidade_pagamentostring · aceita nullpode não virExemplo: 94%
mensagem_probabilidadestring · aceita nullpode não virrazoesarray de stringpode não virpendencias_financeirasobjeto · aceita nullpode não virCampos de pendencias_financeiras
quantidadeintegerpode não virvalor_totalnumber · aceita nullpode não viritensarray de OcorrenciaFinanceirapode não virFormato: array de OcorrenciaFinanceira
protestosobjeto · aceita nullpode não virCampos de protestos
quantidadeintegerpode não virvalor_totalnumber · aceita nullpode não viritensarray de objetopode não virCampos de itens
cartoriostring · aceita nullpode não vircidadestring · aceita nullpode não virufstring · aceita nullpode não virdatastring · aceita nullpode não virvalornumber · aceita nullpode não virquantidadeinteger · aceita nullpode não vircheques_sem_fundoarray de objeto · aceita nullpode não virCampos de cheques_sem_fundo
bancostring · aceita nullpode não viragenciastring · aceita nullpode não virquantidadeinteger · aceita nullpode não virdatastring · aceita nullpode não virmotivostring · aceita nullpode não viracoes_judiciaisobjeto · aceita nullpode não virCampos de acoes_judiciais
totalinteger · aceita nullpode não vircomo_autorinteger · aceita nullpode não vircomo_reuinteger · aceita nullpode não viroutrasinteger · aceita nullpode não virParticipação que não é autor nem réu (advogado, defensor, perito…): não indica dívida.
segredo_justicainteger · aceita nullpode não virultimos_365_diasinteger · aceita nullpode não virprimeira_emstring · aceita nullpode não virultima_emstring · aceita nullpode não viritensarray de AcaoJudicialPessoapode não virRéu primeiro, depois autor, depois o resto.Formato: array de AcaoJudicialPessoa
resumo_ocorrenciasarray de objeto · aceita nullpode não virCampos de resumo_ocorrencias
descricaostringpode não virquantidadeinteger · aceita nullpode não virvalornumber · aceita nullpode não virconsultas_anterioresobjeto · aceita nullpode não virQuantas vezes empresas consultaram o crédito deste documento.
Campos de consultas_anteriores
ultimos_30_diasinteger · aceita nullpode não virde_31_a_60_diasinteger · aceita nullpode não virde_61_a_90_diasinteger · aceita nullpode não virmais_de_90_diasinteger · aceita nullpode não virdebitos_trabalhistasobjeto · aceita nullpode não virCertidão de Débitos Trabalhistas (TST). O PDF da certidão, quando a base envia, vai anexo ao PDF da consulta.
Campos de debitos_trabalhistas
certidaostring · aceita nullpode não virsituacaostring · aceita nullpode não virValores:
NEGATIVAPOSITIVAPOSITIVA_EFEITO_NEGATIVAemitida_emstring · aceita nullpode não virvalidadestring · aceita nullpode não virnomestring · aceita nullpode não virdivida_ativaobjeto · aceita nullpode não virCampos de divida_ativa
quantidade_ativasintegerpode não virvalor_ativonumber · aceita nullpode não viritensarray de objetopode não virAtivas primeiro.
Campos de itens
inscricaostring · aceita nullpode não virsituacaostring · aceita nullpode não virtipo_situacaostring · aceita nullpode não virregularidadestring · aceita nullpode não virtipo_devedorstring · aceita nullpode não virdevedorstring · aceita nullpode não virunidadestring · aceita nullpode não virprocessostring · aceita nullpode não virvalornumber · aceita nullpode não virextintabooleanpode não virPaga ou cancelada: histórico, não débito em aberto.
cnhobjeto · aceita nullpode não virCampos de cnh
categoriastring · aceita nullpode não virExemplo: AB
numero_registrostring · aceita nullpode não virrenachstring · aceita nullpode não virespelhostring · aceita nullpode não viremissaostring · aceita nullpode não virvalidadestring · aceita nullpode não virExemplo: 16/03/2033
primeira_habilitacaostring · aceita nullpode não virufstring · aceita nullpode não virorgao_expedidorstring · aceita nullpode não virimpedimentostring · aceita nullpode não virbloqueiosarray de stringpode não virobservacoesarray de stringpode não virpontosinteger · aceita nullpode não virinfracoes_12_mesesstring · aceita nullpode não virtoxicologicoobjeto · aceita nullpode não virCampos de toxicologico
coletastring · aceita nullpode não virsituacaostring · aceita nullpode não virvencimentostring · aceita nullpode não virexamesarray de objetopode não vircursosarray de objetopode não virReferência completa no dicionário de campos.
Particularidades
- finalidade e declaracao_finalidade: true são obrigatórios (dado pessoal): sem eles, 400 FINALIDADE_OBRIGATORIA antes de cobrar.
- Cada serviço preenche os blocos que a base dele traz. Bloco null = a base não informou; lista vazia = a base respondeu e não há ocorrência.
- Sem registro do documento na base, a consulta termina em erro com retryable: false e o valor volta ao saldo.
No sandbox
Valida documento, finalidade e declaração como a produção. dados fictício no formato do serviço, sem bloco veiculo. Os cenários TST0404/TST0503 não se aplicam (não há placa): teste o tratamento de erro com um serviço por placa.
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.
Importante:
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.