Skip to main content
POST
Criar uma nova proposta
Cria a proposta a partir da opção de simulação escolhida pelo cliente. A análise de crédito começa em seguida. Exemplo:
Use um id_simulacao de uma simulação feita com cnpjLoja, e o cliente precisa estar com o cadastro completo (endereço, ocupação e renda). Senão, a API retorna Simulation.Access.NotFromStore ou Customer.Account.Incomplete.
Cada id_simulacao gera uma única proposta. Reutilizar um simulacaoId já usado retorna 422 com Proposal.SimulationAlreadyActivated; uma simulação expirada retorna Proposal.SimulationAlreadyExpired.
Assim, um timeout não cria duas propostas. Veja Erros e idempotência.
Acompanhe a proposta pelo webhook de proposta ou pela consulta.

Authorizations

Authorization
string
header
required

Cabeçalho de autenticação Bearer no formato Bearer <token> onde <token> é seu TOKEN de autenticação

Headers

Idempotency-Key
string

Chave opcional (1 a 200 caracteres) para repetir a requisição com segurança. Reenviar a mesma chave com o mesmo conteúdo devolve o resultado original sem duplicar o registro; reutilizá-la com outro conteúdo retorna erro.

Maximum string length: 200
Example:

"6f1c9a2e-3b7d-4e2a-9c51-0d8f3a7b2e10"

Body

application/json
cpf
string
required

CPF do cliente, com ou sem pontuação (11 dígitos). Os dígitos verificadores são validados.

Minimum string length: 11
Example:

"12345678909"

simulacaoId
string<uuid>
required

Identificador da simulação escolhida (retornado em id_simulacao)

Example:

"bea8d060-f93d-48eb-b6c4-45f64483cdd9"

Response

Proposta criada com sucesso

id_proposta
string<uuid>

Identificador único da proposta

Example:

"bea8d060-f93d-48eb-b6c4-45f64483cdd9"