Criação da Proposta Crédito CLT

Este endpoint é utilizado para criar uma proposta de Consignado Privado a partir de uma simulação válida. Centraliza a coleta e validação dos dados cadastrais, documentais e bancários do tomador para formalização e desembolso (ex.: PIX).

Endpoint para criar operação crédito CLT

URL: https://bff.v8sistema.com/private-consignment/operation)

Método HTTP: POST

Autenticação: Requer token JWT válido no header

Body da Requisição

{
  "borrower": {
    "name": "string",
    "email": "string",
    "phone": {
      "area_code": "string",
      "country_code": "string",
      "number": "string"
    },
    "political_exposition": true,
    "address": {
      "city": "string",
      "state": "string",
      "number": "string",
      "street": "string",
      "complement": "string",
      "postal_code": "string",
      "neighborhood": "string"
    },
    "birth_date": "2025-09-16",
    "mother_name": "string",
    "nationality": "string",
    "document_issuer": "string",
    "gender": "male",
    "person_type": "natural",
    "marital_status": "single",
    "individual_document_number": "string",
    "document_identification_date": "2025-09-16",
    "document_identification_type": "rg",
    "document_identification_number": "string",
    "bank": {
      "transfer_method": "pix",
      "pix_key": "string",
      "pix_key_type": "cpf"
    }
  },
  "simulation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "provider": "QI"
}

Parâmetros da Requisição

• simulation_id: string(UUID)
  id gerado na etapa anterior ao realizar a simulação de saldo.

• provider : string

  Averbador responsável pela contratação.

• name : string
  Nome completo (conforme documento oficial).

• email : string
  E-mail do titular do contrato.

• phone : string

  Telefone de contato.
  – country_code: string

  DDI. Formato: string numérica (1–3 dígitos). Ex.: 55.
  – area_code: string

  DDD. Formato: string numérica (2 dígitos BR). Ex.: 11.
  – number: string

  Número sem DDI/DDD. Formato: string numérica (8–9 dígitos BR). Ex.: 999999999.

• political_exposition: boolean

  Indica se é PEP (Pessoa Exposta Politicamente) ou possui vínculo com PEP.

• address: Endereço residencial.
  – street: string
  Logradouro. Ex.: Av. Paulista.
  – number: string

  Número (ou S/N). Ex.: 1000.
  – complement: string
  Complemento (opcional). Ex.: Apto 1203.
  – neighborhood: string
  Bairro. Ex.: Bela Vista.
  – city: string
  Cidade. Ex.: São Paulo.
  – state: string
  UF (2 letras). Ex.: SP.
  – postal_code: string
  CEP sem máscara (8 dígitos). Ex.: 01311000.

• birth_date: string
  Data de nascimento.

• mother_name: string
  Nome completo da mãe.

• nationality: string
  Nacionalidade do tomador.

• document_issuer: string

  Órgão emissor do documento de identidade.

• gender: string
  Gênero declarado informar como male, female.

• person_type: string
  Tipo de pessoa informar como natural

• marital_status: string
  Estado civil.
  Valores: single, married, divorced, widowed

• individual_document_number:string
  CPF sem máscara.
  – Exemplo: 03898739007.

• document_identification_date: string
  Data de emissão do documento de identidade.

• document_identification_type: string
  Tipo de documento de identidade.
  – Valores: rg, cnh.

• document_identification_number: string
  Número do documento de identidade (conforme tipo) caso não possua informar como 000000.

• bank: Dados para recebimento/desembolso.
  – transfer_method: string
  Método de transferência, informar como pix.
  – pix_key: string
  Chave PIX (obrigatória quando transfer_method = pix).
  – pix_key_type: string
  Tipo da chave PIX.
  Valores: cpf, email, phone, chave aleatória.
  * Regras por tipo:
  · cpf: 11 dígitos com DV;
  · email: formato RFC 5322;
  · phone: E.164 (ex.: +5511999999999);
  · chave aleatória: UUID (chave aleatória).

Resposta

Em caso de sucesso (código HTTP 200), a resposta será a seguinte

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "formalization_url": "string"
}

Parâmetros da Response

• id: string
  identificador da operação.

• formalization_url: string
  link para formalização do contrato de emprestimo CLT