4.1. Consultar por Documento¶
Especificação — em construção
Os serviços descritos nesta área ainda não estão disponíveis.
🔗 Endpoint¶
| Método | URL |
|---|---|
/credito/tomadores/{documento} |
🧾 Descrição¶
Consulta um tomador já cadastrado pelo CPF ou CNPJ. Serve para pré-preencher a criação da proposta e evitar pedir ao cliente dados que a plataforma já tem.
Responde 204 No Content quando o documento não existe — o que é uma resposta normal, não um erro: significa que o tomador é novo e você deve montar a ficha completa.
🔹 Path Parameter¶
| Parâmetro | Tipo | Descrição |
|---|---|---|
| documento | string | CPF ou CNPJ, somente dígitos, sem máscara |
🧪 Exemplo de cURL¶
curl -X GET "https://api.vehub.com.br/credito/tomadores/12345678900" \
-H "Authorization: Bearer {seu_token}" \
-H "GrupoEconomico: {seu_grupo_economico}"
📥 Responses¶
✅ 200 OK — Pessoa física¶
{
"id": 7788,
"tipo": 1,
"nome": "João da Silva",
"documento": "12345678900",
"data": "1988-04-12",
"rg": "123456789",
"telefone": "47999998888",
"email": "joao@exemplo.com",
"paisNacionalidade": "Brasil",
"sexo": 1,
"nomeMae": "Maria da Silva",
"pessoaPoliticamenteExposta": false,
"estadoCivil": 2,
"conjuge": { "nome": "Ana da Silva", "cpf": "98765432100" },
"escolaridade": 5,
"cnh": 2,
"vinculoEmpregaticio": {
"situacaoRenda": 1,
"empresa": { "cnpj": "12345678000199", "razaoSocial": "Empresa X LTDA" },
"dataAdmissao": "2020-03-01",
"cargo": 252105,
"salario": 6500.00
},
"endereco": {
"cep": "89010000",
"endereco": "Rua das Flores",
"numero": "120",
"complemento": "Apto 302",
"bairro": "Centro",
"cidade": "Blumenau",
"uf": "SC",
"tipoEndereco": 1
}
}
✅ 200 OK — Pessoa jurídica¶
Os campos de PJ substituem os de PF, e pessoas traz os sócios e representantes legais:
{
"id": 9012,
"tipo": 2,
"nome": "Comércio Silva LTDA",
"documento": "12345678000199",
"data": "2012-05-20",
"telefone": "4733334444",
"email": "financeiro@silva.com.br",
"nomeFantasia": "Silva Materiais",
"quantidadeFilial": 2,
"quantidadeFuncionario": 35,
"inscricaoMunicipal": "123456",
"inscricaoEstadual": "2547896321",
"faturamento": [ { "data": "2026-07-01", "valor": 480000.00 } ],
"cnae": [ { "codigo": "4744001", "principalAtividade": true } ],
"pessoas": [
{
"tipo": 1,
"nome": "José Silva",
"documento": "11122233344",
"socio": true,
"socioPercentualParticipacao": 60.00,
"representanteLegal": true,
"socioDesde": "2012-05-20"
}
],
"endereco": { }
}
🧾 Detalhamento dos Campos comuns¶
| Campo | Tipo | Descrição |
|---|---|---|
| id | integer | Identificador do tomador na plataforma |
| tipo | integer | 1 pessoa física, 2 pessoa jurídica |
| nome | string | Nome completo (PF) ou razão social (PJ) |
| documento | string | CPF ou CNPJ, sem máscara |
| data | string | Data de nascimento (PF) ou de fundação (PJ) |
| telefone | string | Somente dígitos, com DDD |
| string | E-mail de contato | |
| endereco | object | Endereço completo — ver 4.2 |
Os campos específicos de cada tipo estão detalhados em 4.2. Pessoa Física e Situação de Renda e 4.3. Pessoa Jurídica e Representantes.
⚪ 204 No Content¶
Tomador não cadastrado. Monte a ficha completa na criação da proposta.
🧭 Como usar no fluxo¶
⚠️ Observações¶
- Confirme os dados com o cliente antes de reaproveitar. O cadastro pode estar desatualizado (endereço, telefone, renda), e o que você enviar na criação da proposta sobrescreve o que existia.
- Documentos já enviados por esse tomador e ainda dentro da validade são reaproveitados na proposta nova. Por isso uma proposta pode nascer com itens marcados como enviados — ver 6.6. Documentos.
- A consulta é restrita ao grupo econômico da sua credencial.