API Criação de Proposta

1. Visão geral  # #

Esta API tem como objetivo receber os dados completos de uma proposta de crédito, incluindo informações do produto, cliente, dados bancários, contrato,
documentos e assinatura, para criação e processamento de uma proposta de empréstimo. O consumidor da API deve enviar o payload conforme especificado
nesta documentação.

2. Autenticação e Headers Obrigatórios  # #

A API utiliza autenticação via headers obrigatórios, que devem ser enviados em todas as requisições.

Header	Exemplo	Descrição
client_id	d9d4657b-a235-4943-8fff-181f1eea9553	Identificador da aplicação/cliente consumidor da API
access_token	5af89110-5e6a-484a-8268-169a9d29fdf	Token de acesso para autorização
Content-Type	application/json	Formato do corpo da requisição.
Accept	application/json	Formato esperado da resposta

3. Estrutura Geral do Payload  # #

{
 "product": {},
 "client": {},
 "benefit": {},
 "bank_data": {},
 "contract": {},
 "signature": {},
 "documents": [],
 "loan_intake_agent": {},
 "corban": {}
}

4. product  # #

Informações do produto financeiro contratado.

Campo	Tipo	Obrigatório	Descrição
id	string (UUID)	Não	Identificador único do produto
name	string	Não	Nome do produto

5. client  # #

Dados completos do cliente.

5.1. address  # #

Campo	Tipo	Obrigatório	Descrição
street	string	Sim	Logradouro
number	string	Sim	Número
complement	string	Não	Complemento
neighborhood	string	Sim	Bairro
city	string	Sim	Cidade
state	string	Sim	UF
postal_code	string	Sim	CEP

5.2. personal_data  # #

Campo	Tipo	Obrigatório	Descrição
name	string	Sim	Nome completo
cpf	string	Sim	CPF
state	string	Sim	UF emissora do documento
expedition_date	string	Sim	Data de emissão do documento
marital_status	string	Sim	Estado civil
birth_date	string	Sim	Data de nascimento
is_politically_exposed_person	boolean	Sim	Indica PEP
birth_city	string	Sim	Cidade de nascimento
nationality	string	Sim	Nacionalidade
gender	string	Sim	Sexo
education_level	string	Sim	Escolaridade
income	number	Sim	Renda mensal
mother_name	string	Sim	Nome da mãe
fathers_name	string	Não	Nome do pai
position	string	Sim	Profissão
literate	boolean	Sim	Alfabetizado
spouse	string	Não	Nome do cônjuge
spouse_document	string	Não	Documento do cônjuge

5.3. employment_data  # #

Campo	Tipo	Obrigatório	Descrição
employer_name	string	Não	Nome do empregador
employer_cnpj	string	Não	CNPJ do empregador

5.4. contact  # #

Campo	Tipo	Obrigatório	Descrição
email	string	Sim	E-mail
cell_phone	string	Sim	Celular
phone	string	Não	Telefone fixo

6. benefit  # #

Informações do benefício do cliente.

Campo	Tipo	Obrigatório	Descrição
benefit_number	string	Sim	Número do benefício
benefit_type_code	string	Sim	Código do benefício
benefit_description	string	Sim	Descrição do benefício

7. bank_data  # #

Dados bancários para crédito.

Campo	Tipo	Obrigatório	Descrição
account_number	string	Sim	Número da conta
account_type	string	Sim	Tipo da conta
branch_number	string	Sim	Agência
ispb	string	Não	ISPB do banco
bank_code	string	Sim	Código do banco
account_digit	string	Sim	Dígito da conta
document_number	string	Sim	Documento do titular
transfer_method	string	Sim	Método de transferência

8. contract  # #

Informações financeiras do contrato.

Campo	Tipo	Obrigatório	Descrição
id	string (UUID)	Sim	Identificador do contrato
simulation_id	string (UUID)	Sim	Id da simulação gerada
ccb_number	string	Sim	Número da CCB
installment_value	number	Sim	Valor da parcela
number_of_installments	number	Sim	Quantidade de parcelas
total_amount	number	Sim	Valor total
amount	number	Sim	Valor liberado
monthly_interest_rate	number	Sim	Juros mensal
annual_interest_rate	number	Sim	Juros anual
monthly_cet	number	Sim	CET mensal
annual_cet	number	Sim	CET anual
first_due_date	string	Sim	Primeiro vencimento
last_due_date	string	Sim	Último vencimento
disbursement_date	string	Sim	Data de liberação
iof	number	Sim	IOF
insurance	number	Não	Seguro
daily_rate	number	Sim	Taxa diária
paying_fund	string	Sim	Fundo pagador

9. signature  # #

Informações de aceite e assinatura.

Campo	Tipo	Obrigatório	Descrição
biometry_analysis_reference	string	Sim	Referência biométrica
ip_address	string	Sim	IP
score	number	Sim	Score
date	string	Sim	Data/hora
geolocation.latitude	string	Não	Latitude
geolocation.longitude	string	Não	Longitude
hash	string	Sim	Hash de validação

10. documents  # #

A lista de documentos discutida para inclusão na proposta inclui: #

– RG (Frente e Verso)

• Formato do arquivo: JPG
• enumerator: rg_identificacao_frente e rg_identificacao_verso

– CCB (Cédula de Crédito Bancário)

• Formato do arquivo: PDF
• enumerator: ccb

– Selfie do proponente

• Formato do arquivo: JPG
• enumerator: selfie_proponente

– Termo de autorização da IN100

• Formato do arquivo: PDF
• enumerator: termo_autorizacao_in100

– CET (detalhamento das taxas da proposta) — sujeito à confirmação de disponibilidade

• Formato do arquivo: PDF
• enumerator: cet

Campo	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do documento
enumerator	string	Sim	Tipo/enumerador
url	string	Sim	URL do arquivo

11. loan_intake_agent  # #

Campo	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do operador
cpf	string	Sim	CPF do operador

12. corban  # #

Campo	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do correspondente
cnpj	string	Sim	CNPJ

13. Observações Gerais  # #

• Campos numéricos devem ser enviados exclusivamente como number (não é permitido envio como string)
• Campos do tipo string devem conter apenas texto
• Datas devem respeitar o formato ISO ou YYYY-MM-DD conforme o campo
• O bloco extra_data é obrigatório e validado integralmente

14. Exemplos de retorno  # #

Sucesso:

{ 
"proposalNumber": "2026020200010"
}

Erro (400):

[ 
  { 
   "Code": 40000, 
   "Title": "Client.PersonalData.Cpf", 
   "Detail": "O CPF do cliente é obrigatório." 
  }
]