POST
Cria uma proposta de contratação de empréstimo pessoal
Cria a proposta de empréstimo pessoal a partir de uma simulação: informe o code retornado em Simular e o period (nº de parcelas) escolhido. Criada a proposta, ela vira uma Operação, acompanhe pela aba Operações.

Bloco customer (opcional)

Você pode enviar os dados cadastrais do cliente junto com a contratação. O bloco é opcional: campos preenchidos atualizam o cadastro; campos omitidos preservam o valor existente.
O cadastro do cliente precisa estar completo para a proposta seguir. Se faltar algum campo obrigatório, a API responde com erro nomeando os campos que faltam.
O e-mail do cliente precisa ter formato válido, como nome@dominio.com. A regra vale para o customer.email enviado e também para o e-mail que já estava no cadastro. Um e-mail inválido é recusado com a mensagem “Dados do cliente inválidos: email.”, depois da checagem dos campos que faltam, e a proposta não é criada.
O CPF não vai no bloco customer — ele já está vinculado à operação identificada pelo code.

Diferença para CDC Hub

No Empréstimo Pessoal, os dados bancários (bankAccountBankCode, bankAccountType, bankAccountAgency, bankAccountNumber, bankAccountDigit) são obrigatórios, porque o crédito é depositado na conta do próprio cliente.

Campos de referência

Campos que melhoram a análise de crédito

Os campos profession, companyName, startEmploymentDate e monthlyIncome são opcionais, mas melhoram a análise de crédito. Envie-os sempre que possível.

Forma de pagamento (paymentMethod, opcional)

Disponível apenas para lojas com o pagamento por chave PIX habilitado pela HubCred. Sem a habilitação, uma proposta com paymentMethod igual a 2 é recusada. Fale com o seu contato na HubCred para habilitar.
Qualquer outro valor é recusado. A forma de pagamento é validada antes dos dados do cliente. Com paymentMethod igual a 2:
  • os dados bancários do cliente deixam de ser obrigatórios;
  • o cliente precisa ter uma chave PIX: envie customer.bankPix (até 120 caracteres) na própria chamada, ou omita o campo se a chave já estiver no cadastro. Sem chave, a proposta é recusada;
  • o crédito é pago na chave PIX do cliente.
Exemplo, trocando os campos bankAccount* do bloco customer pela chave:

Assinatura pelo parceiro (externalSignature, opcional)

O Empréstimo Pessoal tem dois fluxos de contratação pela API, e você escolhe por proposta.

Fluxo automático

1

Simular e contratar

Simular e depois Contratar, sem externalSignature.
2

A HubCred faz o resto

Análise, envio ao banco, envio do contrato para a certificadora da empresa, link de assinatura para o cliente e finalização no banco quando o cliente assina.

Fluxo segmentado

1

Simular e contratar

Simular e depois Contratar, com "externalSignature": true.
2

Esperar a CCB

Espere a operação chegar à situação 1 (Enviado): é quando a CCB está pronta. O aviso é o webhook de mudança de status, ou a consulta em Obter detalhes.
3

Obter a CCB

Obter CCB devolve o contrato sem assinatura, em base64.
4

Colher a assinatura

Colha a assinatura do cliente na sua ferramenta.
5

Devolver o PDF assinado

Enviar contrato assinado. A HubCred registra o contrato, envia ao banco e finaliza: a operação vai para a situação 2 (Aprovado), ou 14 (Erro operação) se o banco recusar.
Neste fluxo a HubCred não envia link de assinatura ao cliente, e Obter link de assinatura devolve url igual a null.
No fluxo segmentado, a validade da assinatura e a identificação do cliente são responsabilidade do parceiro. A HubCred não confere a assinatura dentro do PDF nem faz a verificação biométrica do fluxo automático. O PDF devolvido tem de ser a CCB obtida em Obter CCB, assinada; não um documento montado por você.
Exemplo, só com os campos que mudam:

Body

Input com os dados para a proposta e o cadastro do cliente

Dados de entrada para criar uma proposta de empréstimo pessoal.

code
string | null

Código da simulação retornado em Simular.

period
integer<int32>

Quantidade de parcelas escolhida (Period de uma das opções simuladas).

description
string | null

Descrição/observação da proposta.

customer
object

Dados cadastrais do cliente enviados junto da contratação. Todo campo é opcional: o que vier preenchido sobrescreve o cadastro, o que vier vazio preserva o valor atual.

paymentMethod
integer<int32> | null

Forma de pagamento da proposta: 1 (conta bancária) ou 2 (chave PIX). Quando ausente, vale 1, o comportamento de sempre. O valor 2 só é aceito quando o pagamento por chave PIX está habilitado para a empresa; sem isso, a proposta é recusada. Qualquer outro valor é recusado. Com 2, os dados bancários do cliente deixam de ser obrigatórios e o cliente precisa ter chave PIX: envie-a em customer.bankPix, ou ela precisa já constar no cadastro do cliente.

externalSignature
boolean

Assinatura feita pelo parceiro, com a ferramenta dele. Quando ausente ou false, vale o fluxo de sempre: a plataforma envia o contrato para a certificadora da empresa e o link de assinatura ao cliente. Com true, a plataforma não envia nada: quando a operação chega à situação 1 (Enviado), obtenha a CCB em Operacoes/ObterCcb, colha a assinatura do cliente e devolva o PDF assinado em Operacoes/EnviarContratoAssinado. Nesse fluxo a validade da assinatura e a identificação do cliente são responsabilidade do parceiro.

Response

200

OK