Tote
InícioComece aquiAnalisaIntegra
InícioComece aquiAnalisaIntegra
  1. Empréstimo Pessoal
  • Visão geral
  • O QUE HÁ DE NOVO
    • Release Notes
      • Horizon
  • GUIAS
    • Manuais
      • Diretrizes Básicas
      • Como se autenticar
      • Respostas e status
      • Nossas APIs
      • Webhook
      • FAQ
  • ESPECIFICAÇÕES
    • APIs
      • Autenticação
        • Gerar token de acesso
      • Acheron
        • Pagamento
          • Cadastrar um pagamento
          • Cancelar um pagamento
          • Criar intenção de pagamento
          • Confirmar intenção de pagamento
          • Cancelar intenção de pagamento
          • Listar intenções de pagamento
          • Criar pagamento via PIX
        • Venda
          • Criar venda com cartão
          • Cancelar venda com cartão
          • Criar venda com portador
          • Cancelar venda com portador
          • Estornar uma venda
        • E-Commerce
          • Criar venda e-commerce
          • Confirmar pagamento e-commerce
          • Listar pagamento e-commerce
          • Cancelar venda e-commerce
          • Gerar token de e-commerce
        • VTEX
          • Criar venda VTEX
          • Confirmar venda VTEX
          • Estornar venda VTEX
          • Cancelar venda VTEX
        • Simulação
          • Criar simulação
        • Pré-autorização
          • Listar pré-autorização
          • Listar valor reservado
        • BNPL
          • Confirmar estorno de venda
          • Estornar venda
          • Simular venda
          • Confirmar venda
          • Sensibilizar venda
      • Agenda lojista
        • Agenda
          • Cadastrar recebimento em agenda
          • Cadastrar agenda manual
          • Listar agenda por loja
          • Consultar agenda específica
          • Listar transações pelo ID da agenda ou loja
        • Configurações de Agendas
          • Cadastrar configuração
          • Listar configurações da agenda
          • Alterar configuração de uma loja
        • Modalidade
          • Cadastrar modalidades
          • Listar modalidades
          • Listar modalidade por lançamento
          • Alterar tipo de modalidade
        • Lançamentos
          • Listar lançamentos por loja
          • Cadastrar lançamentos
          • Cadastrar lançamento de ajuste
        • Tipo de ajuste
          • Cadastrar um tipo de ajuste
          • Listar tipo de ajuste
      • Banking
        • Conciliação bancária
          • Gerar saldo para um emissor
          • Gerar extrato para um emissor
          • Gerar arquivos de conciliação
        • Contas
          • Listar contas digitais
        • Pix
          • Transferir pix
          • Listar status do pix
          • Listar transferências Pix
          • Listar informações de chave
      • Biometria
        • Biometria
        • Handshake fortface
          • Iniciar o processo de autenticação biométrica SDK
          • Iniciar o processo de autenticação biométrica Backoffice
        • Biometria
          • Identificar um rosto
          • Cadastrar uma face utilizando o SDK Fortface
          • Cadastrar uma face através do Backoffice da Fortface
      • Broker
        • Enviar mensagem SMS
      • Cartões
        • Portadores
          • Buscar cartão pelo titular
          • Cadastrar portador adicional
          • Listar cartões do adicional
          • Gerar cartão adicional
        • CVV Virtual
          • Ativar CVV Virtual do titular
          • Inativar CVV Virtual
          • Atualizar data de expiração do CVV
        • Senha
          • Cadastrar senha
          • Alterar senha
          • Autenticar senha do cartão
          • Gerar senha e enviar por SMS
        • Bloqueios e Desbloqueios
          • Bloquear um cartão temporariamente
          • Bloquear permanentemente
          • Listar histórico de bloqueios
          • Listar tipos de bloqueio
          • Desbloquear cartão
        • Cartões
          • Solicitar segunda via
          • Trocar cartão pendente
          • Buscar cartão criptografado
          • Listar histórico de cancelamento
          • Listar tipos de cancelamento
          • Gerar um cartão virtual
          • Listar cartão virtual
          • Buscar cartão pelo id
          • Buscar cartão pelo número
          • Buscar cartão pelo CPF
          • Buscar cartão bandeirado
          • Token Merci
          • Trocar cartão do portador
          • Cadastrar Pessoa Jurídica
          • Solicitar troca do cartão
          • Listar BIN
        • No Name
          • Listar lotes de cartão
          • Criar lote de cartões
          • Destruir cartão
          • Vincular cartão ao titular
          • Vincular cartão adicional
          • Destruir lote de cartões
          • Embossar cartões por lote
          • Listar cartões
        • Vipagem
          • Listar cartões bandeirados
          • Emitir segunda via
      • Embossing
        • Cartões
          • Embossing de cartão
          • Bloquear cartão por falha
          • Listar cartões pendentes
        • Impressoras
          • Inativar impressora
          • Ativar impressora
      • Empréstimo
        • Empréstimo Pessoal
          • Cadastrar clientes para empréstimo
            POST
          • Solicitar crédito para empréstimo
            POST
        • Empréstimo Pix Card
          • Enviar arquivo
          • Alterar dados bancários
          • Transferir via Pix
          • Cadastrar pessoa física
          • Simular empréstimo
          • Confirmar empréstimo
          • Aprovar crédito
          • Criar contrato
          • Consultar pessoa
        • Empréstimo FGTS
          • Simular saldo
          • Obter saldo
          • Cadastrar pessoa física
          • Cadastrar operação
          • Submeter para aprovação
          • Consultar informações
          • Listar produto
          • Consultar pessoa
          • Listar operações
          • Acompanhar operação
          • Listar estado civil
          • Listar bancos
        • Empréstimo Simplificado
          • Listar bancos
          • Consultar informações de contrato
          • Consultar contratos de empréstimo
      • Faturamentos
        • Parcelamento de fatura
          • Antecipar uma parcela do parcelamento
          • Antecipar todo o parcelamento
          • Buscar parcelamento pendente
          • Buscar parcelamento ativo
          • Simular antecipação
          • Parcelar faturas
        • Ciclos de fatura
          • Consultar ciclos de vencimento
          • Alterar o ciclo de vencimento
        • Consulta de faturas
          • Consultar lançamentos futuros
          • Consultar faturas por período
          • Consultar faturas futuras
          • Consultar última fatura fechada
          • Consultar fatura detalhada
          • Consultar fatura atual
          • Visualizar saldo detalhado
        • Faturas digitais
          • Receber fatura em PDF
          • Aderir à fatura digital
          • Cancelar fatura digital
          • Aderir à fatura por SMS
          • Cancelar fatura por SMS
      • Financiamentos
        • Parcelamento total
          • Simular parcelamento devedor total
        • Parcelamento manual
          • Simular parcelamento manual
      • Gestão de contas
        • Cadastrar cartão físico para titular
      • Lançamentos
        • Ajustes
          • Lançar um ajuste financeiro
          • Listar um ajuste financeiro
          • Lançar ajustes a débito
          • Lançar ajustes a crédito
          • Listar tipos de ajustes
          • Listar faturas ajustadas
          • Lançar um ajuste na fatura
        • Vendas
          • Antecipar venda total
          • Antecipar venda avulsa
        • Antecipação
          • Listar compras passíveis de antecipação
        • Baixas bancárias
          • Estornar lançamento de baixa bancária
          • Lançar baixa báncaria
          • Lançar baixa bancária de pagamento
          • Estornar pagamento de baixa bancária
      • Loja
        • Formas de Pagamentos
          • Listar formas de pagamento
          • Cadastrar forma de pagamento
          • Atualizar forma de pagamento
          • Consultar parcelas de uma loja
        • Tarifas
          • Listar tarifas
          • Cadastrar tarifa
          • Associar tarifa a uma loja
          • Cancelar tarifas com a loja
          • Listar tarifas por loja
          • Consultar uma tarifa
          • Alterar cadastro de uma tarifa
        • Lojas
          • Cadastrar uma loja
          • Consultar uma loja
          • Consultar loja por id externo
          • Listar loja pelo CNPJ
          • Listar lojas
          • Alterar uma loja
      • Pacote SMS
        • Contratar um pacote SMS
        • Cancelar um pacote SMS
        • Consultar pacotes do portador
        • Habilitar celular para adesão do pacote
        • Habilitar celular para receber bônus
        • Consultar pacotes disponíveis
        • Consultar pacotes contratados
      • Parâmetros
        • Listar parâmetros cadastrados
        • Listar parâmetros exibíveis
      • Pix
        • Pix Imediato
          • Listar chaves Pix Imediato
          • Gerar Pix Imediato
          • Listar uma chave Pix Imediato
      • Pix Card
        • PixCard
          • Transferir via Pix
          • Consultar CPF
          • Cadastrar cliente
          • Simular operação
          • Confirmar operação
          • Cadastrar documento do portador
        • Assinatura
          • Listar as assinaturas
          • Cadastrar assinatura
          • Verificar assinaturas para cobrança
          • Listar assinaturas válidas
          • Listar planos
          • Alterar assinatura pelo CPF
        • Conta Digital
          • Listar termos obrigatórios
          • Cadastrar termo obrigatório
          • Cadastrar documento do portador
          • Criar uma conta digital
          • Criar uma conta alias
          • Listar contas pelo identificador
          • Listar informações do portador
        • Transferência
          • Agendar transferência
          • Efetuar transferência
          • Listar status de transferência
          • Listar devoluções
          • Listar transferências
          • Listar agendamentos de transferências
        • Relatórios
          • Listar operações
          • Listar relatórios de assinaturas
          • Listar adesões
        • QR Code
          • Criar QR Code estático
          • Decodificar QR Code
        • Chaves
          • Confirmar reivindicações
          • Fazer reivindicação
          • Cadastrar chave
          • Deletar chave
          • Listar chaves
          • Consultar chaves pelo identificador
          • Listar reivindicações
        • Limites
          • Criar limite de horário
          • Associar conta a grupo de serviço
          • Listar destinos confiáveis
          • Alterar limite do destino confiável
          • Listar limites de horários
          • Listar requisições
          • Remover destino confiável
      • Portadores
        • Gestão de portadores
          • Listar status do portador pelo CPF
          • Listar portadores
          • Alterar dados do portador
          • Alterar status de ativo problemático
          • Listar informações do portador
          • Alterar o limite do portador
          • Bloquear um portador
          • Desbloquear um portador
          • Listar adicionais pelo CPF
          • Listar portadores em lote
          • Listar contas pelo CPF (simplificado)
          • Listar contas pelo CNPJ
          • Alterar produto do portador
          • Listar contas pelo documento
          • Listar contas pelo RG
          • Listar contas pelo nome
          • Alterar vipagem
          • Consultar ciclo do portador
          • Listar contas pelo CPF (completo)
        • Gestão de dependentes
          • Listar dependentes pelo titular
          • Cadastrar dependentes
        • Gestão de telefones
          • Listar telefones
          • Cadastrar telefone
          • Deletar telefone
          • Receber SMS
        • Visualização de histórico
          • Listar histórico do portador
          • Listar ocorrências
          • Listar inadimplências pelo portador
          • Listar o histórico de limites
        • Gestão de senhas
          • Enviar senha por SMS
          • Alterar senha do portador
        • Cadastro de contas
          • Cadastrar uma conta PJ
          • Cadastrar uma conta PF
        • Informações da base de dados
          • Listar tipos de bloqueio
          • Listar escolaridades
          • Listar ocupações
        • BNPL
          • Consultar informações do portador
      • Portuno
        • Conta
          • Listar conta
          • Criar uma conta
          • Trocar o segredo da conta
        • Integração
          • Listar integrações
          • Alterar tempo de expiração de uma integração
      • Produtos
        • Produtos
          • Consultar produtos
          • Consultar um produto
        • Serviços financeiros
          • Listar serviços financeiros
      • Regulatório
        • Listar informações
      • Recompensa
        • Aderir à anuidade bonificada
        • Cancelar anuidade bonificada
        • Listar anuidades do produto
        • Listar anuidade do portador
        • Listar anuidades
        • Listar as anuidades
        • Cadastrar anuidades
      • Serviços Bancários
        • Registrar um boleto online
        • Listar pagamentos
        • Listar boleto completo
        • Listar contas habilitadas
      • Seguros
        • Seguros
          • Cancelar adesão do titular
          • Aderir seguro para o titular
          • Aderir seguro para dependente
          • Cancelar adesão do dependente
          • Listar seguros de dependentes
          • Listar seguros disponíveis
          • Cancelar um seguro
          • Listar seguros do portador
          • Listar campos de adesão ao seguro
          • Listar campos de adesão do portador
          • Listar seguros cancelados
        • Bilhetes de Seguro
          • Listar bilhetes de um portador
          • Listar o modelo de operação
          • Listar um bilhete de adesão
        • Cobranças e Pagamentos
          • Fazer estímulo de cobrança
        • Termos da Adesão
          • Listar termos de adesão
          • Listar modelos do código de operação
          • Listar termos de um seguro
      • SMS Notice
        • Processamento
          • Listar os eventos
          • Criar um evento
          • Alterar um evento
          • Listar as variáveis
          • Criar variáveis
          • Listar as transações
          • Criar mensagem para fila
        • Serviços
          • Criar um serviço de SMS
          • Listar serviços cadastrados
          • Alterar um serviço de SMS
          • Listar um serviço específico
        • Pacote de SMS
          • Listar os pacotes de sms
          • Cadastrar pacote SMS
          • Listar um pacote específico
          • Alterar um pacote específico
          • Aderir a um pacote SMS
          • Cancelar uma adesão
          • Listar adesões de um portador
          • Alterar o telefone do pacote
  1. Empréstimo Pessoal

Solicitar crédito para empréstimo

Sandbox
https://horizon-api-sb.app.rpe.tech
Sandbox
https://horizon-api-sb.app.rpe.tech
POST
https://horizon-api-sb.app.rpe.tech
/api/v1/emprestimos/pessoal/operacao
Use este endpoint para solicitar crédito para empréstimo pessoal.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/emprestimos/pessoal/operacao' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \
--header 'Accept: */*' \
--header 'User-Funcao: OF0aX2xTB47P' \
--header 'Content-Type: application/json' \
--data-raw '{
  "valorSolicitado": 1000,
  "prazo": 4,
  "cliente": "13510375017",
  "valorMaximoLiberado": 10000,
  "porcentagemDescontoTaxa": 0.0,
  "valorComissao": 0,
  "valorTarifa": 10,
  "dataPrimeiroVencimento": "2025-06-30",
  "linhaCredito": "string"
}'
Response Response Example
201 - Sucesso
{
  "id": "P259753RDXFRG7",
  "localizador": "P259753RDXFRG7",
  "status": "analise-credito",
  "dataPrimeiroVencimento": "2025-07-10",
  "autorizadorMsg": "",
  "ultimoVencimento": "2025-07-10",
  "financeira": {
    "id": "AM6wkTEWLSNP",
    "nomeFantasia": "HPAY",
    "razaoSocial": "Horizon Pay Soluçoes de Crédito",
    "cnpj": "57.123.456/0000-00",
    "antecipacaoDecrescente": false,
    "sacEmail": "[email protected]",
    "sacTelefone": "(11) 9000-0000",
    "limiteDiasAtrasoAntecipacao": 0,
    "centroDeCustoPorConvenio": true,
    "sufixoContratoPorConvenio": false,
    "configuraCarimboPorConvenio": false
  },
  "clienteInfoNoContrato": {
    "cpf": "123.456.789-10",
    "email": "[email protected]",
    "nome": "Maria Teste",
    "sobrenome": "Teste",
    "dataNascimento": "2000-03-01",
    "nascimentoUf": null,
    "sexo": "F",
    "documento": {
      "tipo": "RG",
      "numero": "123456789",
      "dataEmissao": null,
      "emissor": "",
      "uf": "MA",
      "foto": null
    },
    "endereco": {
      "cep": "65000-000",
      "logradouro": "Avenida Paraiso",
      "numero": "400",
      "complemento": null,
      "bairro": "Teste",
      "uf": "SP",
      "cidade": "São Paulo",
      "pais": "BR",
      "residenciaTipo": "nao-informado",
      "residenciaTempo": "0",
      "foto": null
    },
    "nacionalidade": "Brasileiro",
    "estadoCivil": null,
    "nomePai": null,
    "nomeMae": "Mae Teste",
    "telefoneCelular": "+559996563254",
    "telefoneFixo": null,
    "pagamento": {
      "banco": "000",
      "instituicao": "cAWSHGFHGNj",
      "conta": "00000000",
      "contaDac": "6",
      "agencia": "0300",
      "agenciaDac": "0",
      "cpfResponsavel": null,
      "cnpjResponsavel": null,
      "tipo": "corrente",
      "nomeTitular": null,
      "clienteDesde": null,
      "praca": null,
      "individualOuConjunta": "individual",
      "bancoNome": "BANCO SANTANDER (BRASIL) S.A.",
      "telefone": null,
      "nomeGerente": null,
      "tipoChavePix": "cpf",
      "chavePix": "123.456.789-10"
    },
    "cargo": "Analista TI",
    "salario": null,
    "salarioBruto": 12500,
    "salarioLiquido": null,
    "escolaridade": "",
    "conjuge": null,
    "resourcetype": "PropostaCP"
  },
  "taxaContrato": 6,
  "taxaContratoAno": 101.22,
  "taxaIrr": 6.000256702923,
  "taxaCetMes": 6.67,
  "taxaCetAno": 116.98,
  "taxaIof": 3,
  "taxaIofComplementar": 0.38,
  "taxaMulta": 2,
  "diasCobrancaMulta": 1,
  "valorLiberado": 1000,
  "valorIof": 6.3,
  "valorTarifas": 0,
  "valorJuros": 60.38,
  "valorRecebivel": 1066.68,
  "valorSeguro": 0,
  "prazo": 1,
  "dataSolicitacao": "2025-06-10",
  "valorSolicitado": 1000,
  "valorFinanciado": 1006.3,
  "modalidade": "pessoal",
  "pagamento": {
    "banco": "033",
    "instituicao": "cRUUJDy3PhNj",
    "conta": "00000000",
    "contaDac": "6",
    "agencia": "0000",
    "agenciaDac": "0",
    "cpfResponsavel": null,
    "cnpjResponsavel": null,
    "tipo": "corrente",
    "nomeTitular": null,
    "clienteDesde": null,
    "praca": null,
    "individualOuConjunta": "individual",
    "bancoNome": "BANCO SANTANDER (BRASIL) S.A.",
    "telefone": null,
    "nomeGerente": null,
    "tipoChavePix": "cpf",
    "chavePix": "123.456.789-10"
  },
  "geradoPor": "",
  "mesaCredito": null,
  "origem": "novo-contrato",
  "recebiveis": [
    {
      "vp": 1006.3,
      "juros": 60.38,
      "valor": 1066.68,
      "numParcela": 0,
      "dataVencimento": "2025-07-10",
      "valorPrincipal": 1006.3
    }
  ],
  "crivoPDF": null,
  "metadados": {},
  "nomeOperador": "José Gomes",
  "cpfOperador": "123.456.789-10",
  "convenio": {
    "id": "Nql4VL3zDYLg",
    "localizador": "270284",
    "validacaoDocumentos": "basica"
  },
  "comissao": 0,
  "migradoEm": null,
  "agenteCertificado": null,
  "renegociacaoExterna": false,
  "dataPrevistaCredito": "2025-06-10",
  "alteradoEm": "2025-06-10T17:56:18.861631-03:00",
  "criadoEm": "2025-06-10T17:56:18.831084-03:00",
  "utilizaValorJusto": true,
  "cliente": "1Gqon7wsZ85u",
  "cpf": "123.456.789-10",
  "email": "[email protected]",
  "sobrenome": "Teste",
  "nome": "Teste Fernanda",
  "dataNascimento": "1997-03-18",
  "nascimentoUf": null,
  "sexo": "F",
  "nacionalidade": "Brasileiro",
  "estadoCivil": null,
  "nomePai": null,
  "nomeMae": "Teste Mae Teste",
  "telefoneCelular": "+55986375232",
  "telefoneFixo": null,
  "cargo": "Analista TI",
  "salarioBruto": 12500,
  "salarioLiquido": null,
  "escolaridade": "",
  "documentacaoComprovacao": {
    "identidadeFrente": {
      "documento": "https://onidata-creditorapi-vuon-hmg-storage.s3.amazonaws.com/onidata-creditorapi-storage/Yl6W2r5RXpBK/documentos_clientes/image_17_zSBtTZU.png?AWSAccessKeyId=ASIA6FMPYFMA3IRHPVMR&Signature=Dw3YyLC8dwyTeF52XcqQHFlJ3To%3D&x-amz-security-token=IQoJb3JpZ2luX2VjEO3%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJGMEQCICNjiHNtkqf00J1is2o%2B4NVRlZlyyWn4eiOK6lz0asf3AiB1xXuBhcdE8bukpTBZkGwFVvNZtVw45kHGtA1NWg22MyrwAwjG%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAMaDDk3MzY0ODQ0MDA2NSIMfUZekSjCFEViNai6KsQDThKYITL%2FtYsHMKC8raUy2yXWmE8QA3qD41fhUCre4M6jsfNBNEuIo%2FNcWUScuPsNUxY6gPrcRhzvltu%2BvEdVsUdpQCSuvC74WMi7QvSGB10ScyXUGua6F1o2a8cVg%2FCHPrF4mjhIm3i376m6XceHr9PGVOB2J5e0qA6mbkhpCenEYPYXrwsoa3VjpAxyDKqyJ%2BTLFYixcsU8cmfKEXiPQfJRhGwQVdih85EVzh92%2BlmIGQUuL7teY6maph0RxC7BIArIE7kqv3R9SfzGyojH7FxeZZZidy2WKgUHG9by2ekZvZC9Mhf%2FcFmr4XG7E6Wp5FlUpEADbIdIWf%2FtkY1kdMgyktIAI817nMgLn4n9xWBEhmLQy%2BJN%2B0yxrZJM%2BkKF0rrpfMU70uRVYXjOynIY12zwezsiW5U%2B3NBDrxuxfBpq2wfPBTYjKiBCsfvAvDCHuB%2B9szfpECV8rQFF6fnS13duvqMPITI1kSbzJSBMxBQJjs28bUXvpMpF0ExW3mLZmjNTjpIZ4VHtDIh5J6u7lvRqk1OelhYdkoHF2jzHehSSj8Qmje6BpPSZURJDp83MsEu0iBQfWdEQ38AVeK31831zL4cwx7OiwgY6pgEH6r1o%2BrPPRynBbLiJnZYqQx393NrFi8nl5tAWtfByBEd%2BKSJwvclfZkwv3X64rWOSkkrYHRRQDAAZBlYApsAjw3zNCAATzOVQJ857KZgmMz66TtgUWN9vZlAbcZV2N2My92FtBIMUaTxR%2FZBkj4pMT2nKQ68p2nGD76tBNn6b5NBwixGA1eSKVJas%2BM98vBZJjyoU6VGw8Mzr%2FIgASbxOVs6Rcyi4&Expires=1749592579",
      "tipo": "identidade_frente",
      "statusDocumento": "aprovado",
      "motivoNegado": null,
      "dataAprovacao": "2025-05-30",
      "alteradoEm": "2025-05-30T10:44:45.722774-03:00",
      "id": "32"
    },
    "identidadeVerso": {
      "documento": "https://onidata-creditorapi-vuon-hmg-storage.s3.amazonaws.com/onidata-creditorapi-storage/Yl6W2r5RXpBK/documentos_clientes/image_17_kSrIZIi.png?AWSAccessKeyId=ASIA6FMPYFMA3IRHPVMR&Signature=gme6CYjyI3sLOudy5UjN4j9sNlc%3D&x-amz-security-token=IQoJb3JpZ2luX2VjEO3%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJGMEQCICNjiHNtkqf00J1is2o%2B4NVRlZlyyWn4eiOK6lz0asf3AiB1xXuBhcdE8bukpTBZkGwFVvNZtVw45kHGtA1NWg22MyrwAwjG%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAMaDDk3MzY0ODQ0MDA2NSIMfUZekSjCFEViNai6KsQDThKYITL%2FtYsHMKC8raUy2yXWmE8QA3qD41fhUCre4M6jsfNBNEuIo%2FNcWUScuPsNUxY6gPrcRhzvltu%2BvEdVsUdpQCSuvC74WMi7QvSGB10ScyXUGua6F1o2a8cVg%2FCHPrF4mjhIm3i376m6XceHr9PGVOB2J5e0qA6mbkhpCenEYPYXrwsoa3VjpAxyDKqyJ%2BTLFYixcsU8cmfKEXiPQfJRhGwQVdih85EVzh92%2BlmIGQUuL7teY6maph0RxC7BIArIE7kqv3R9SfzGyojH7FxeZZZidy2WKgUHG9by2ekZvZC9Mhf%2FcFmr4XG7E6Wp5FlUpEADbIdIWf%2FtkY1kdMgyktIAI817nMgLn4n9xWBEhmLQy%2BJN%2B0yxrZJM%2BkKF0rrpfMU70uRVYXjOynIY12zwezsiW5U%2B3NBDrxuxfBpq2wfPBTYjKiBCsfvAvDCHuB%2B9szfpECV8rQFF6fnS13duvqMPITI1kSbzJSBMxBQJjs28bUXvpMpF0ExW3mLZmjNTjpIZ4VHtDIh5J6u7lvRqk1OelhYdkoHF2jzHehSSj8Qmje6BpPSZURJDp83MsEu0iBQfWdEQ38AVeK31831zL4cwx7OiwgY6pgEH6r1o%2BrPPRynBbLiJnZYqQx393NrFi8nl5tAWtfByBEd%2BKSJwvclfZkwv3X64rWOSkkrYHRRQDAAZBlYApsAjw3zNCAATzOVQJ857KZgmMz66TtgUWN9vZlAbcZV2N2My92FtBIMUaTxR%2FZBkj4pMT2nKQ68p2nGD76tBNn6b5NBwixGA1eSKVJas%2BM98vBZJjyoU6VGw8Mzr%2FIgASbxOVs6Rcyi4&Expires=1749592579",
      "tipo": "identidade_verso",
      "statusDocumento": "aprovado",
      "motivoNegado": null,
      "dataAprovacao": "2025-05-30",
      "alteradoEm": "2025-05-30T10:44:45.973754-03:00",
      "id": "31"
    },
    "residencia": {
      "documento": "https://onidata-creditorapi-vuon-hmg-storage.s3.amazonaws.com/onidata-creditorapi-storage/Yl6W2r5RXpBK/documentos_clientes/image_17_goG8IFX.png?AWSAccessKeyId=ASIA6FMPYFMA3IRHPVMR&Signature=K9uLWuiAYecwWN%2BixLszPgw1zF8%3D&x-amz-security-token=IQoJb3JpZ2luX2VjEO3%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJGMEQCICNjiHNtkqf00J1is2o%2B4NVRlZlyyWn4eiOK6lz0asf3AiB1xXuBhcdE8bukpTBZkGwFVvNZtVw45kHGtA1NWg22MyrwAwjG%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAMaDDk3MzY0ODQ0MDA2NSIMfUZekSjCFEViNai6KsQDThKYITL%2FtYsHMKC8raUy2yXWmE8QA3qD41fhUCre4M6jsfNBNEuIo%2FNcWUScuPsNUxY6gPrcRhzvltu%2BvEdVsUdpQCSuvC74WMi7QvSGB10ScyXUGua6F1o2a8cVg%2FCHPrF4mjhIm3i376m6XceHr9PGVOB2J5e0qA6mbkhpCenEYPYXrwsoa3VjpAxyDKqyJ%2BTLFYixcsU8cmfKEXiPQfJRhGwQVdih85EVzh92%2BlmIGQUuL7teY6maph0RxC7BIArIE7kqv3R9SfzGyojH7FxeZZZidy2WKgUHG9by2ekZvZC9Mhf%2FcFmr4XG7E6Wp5FlUpEADbIdIWf%2FtkY1kdMgyktIAI817nMgLn4n9xWBEhmLQy%2BJN%2B0yxrZJM%2BkKF0rrpfMU70uRVYXjOynIY12zwezsiW5U%2B3NBDrxuxfBpq2wfPBTYjKiBCsfvAvDCHuB%2B9szfpECV8rQFF6fnS13duvqMPITI1kSbzJSBMxBQJjs28bUXvpMpF0ExW3mLZmjNTjpIZ4VHtDIh5J6u7lvRqk1OelhYdkoHF2jzHehSSj8Qmje6BpPSZURJDp83MsEu0iBQfWdEQ38AVeK31831zL4cwx7OiwgY6pgEH6r1o%2BrPPRynBbLiJnZYqQx393NrFi8nl5tAWtfByBEd%2BKSJwvclfZkwv3X64rWOSkkrYHRRQDAAZBlYApsAjw3zNCAATzOVQJ857KZgmMz66TtgUWN9vZlAbcZV2N2My92FtBIMUaTxR%2FZBkj4pMT2nKQ68p2nGD76tBNn6b5NBwixGA1eSKVJas%2BM98vBZJjyoU6VGw8Mzr%2FIgASbxOVs6Rcyi4&Expires=1749592579",
      "tipo": "residencia",
      "statusDocumento": "aprovado",
      "motivoNegado": null,
      "dataAprovacao": "2025-05-30",
      "alteradoEm": "2025-05-30T10:44:45.883990-03:00",
      "id": "30"
    },
    "renda": {
      "documento": "https://onidata-creditorapi-vuon-hmg-storage.s3.amazonaws.com/onidata-creditorapi-storage/Yl6W2r5RXpBK/documentos_clientes/image_17.png?AWSAccessKeyId=ASIA6FMPYFMA3IRHPVMR&Signature=be5rxd4NENv4JDiqmkUjOmxQRL0%3D&x-amz-security-token=IQoJb3JpZ2luX2VjEO3%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJGMEQCICNjiHNtkqf00J1is2o%2B4NVRlZlyyWn4eiOK6lz0asf3AiB1xXuBhcdE8bukpTBZkGwFVvNZtVw45kHGtA1NWg22MyrwAwjG%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAMaDDk3MzY0ODQ0MDA2NSIMfUZekSjCFEViNai6KsQDThKYITL%2FtYsHMKC8raUy2yXWmE8QA3qD41fhUCre4M6jsfNBNEuIo%2FNcWUScuPsNUxY6gPrcRhzvltu%2BvEdVsUdpQCSuvC74WMi7QvSGB10ScyXUGua6F1o2a8cVg%2FCHPrF4mjhIm3i376m6XceHr9PGVOB2J5e0qA6mbkhpCenEYPYXrwsoa3VjpAxyDKqyJ%2BTLFYixcsU8cmfKEXiPQfJRhGwQVdih85EVzh92%2BlmIGQUuL7teY6maph0RxC7BIArIE7kqv3R9SfzGyojH7FxeZZZidy2WKgUHG9by2ekZvZC9Mhf%2FcFmr4XG7E6Wp5FlUpEADbIdIWf%2FtkY1kdMgyktIAI817nMgLn4n9xWBEhmLQy%2BJN%2B0yxrZJM%2BkKF0rrpfMU70uRVYXjOynIY12zwezsiW5U%2B3NBDrxuxfBpq2wfPBTYjKiBCsfvAvDCHuB%2B9szfpECV8rQFF6fnS13duvqMPITI1kSbzJSBMxBQJjs28bUXvpMpF0ExW3mLZmjNTjpIZ4VHtDIh5J6u7lvRqk1OelhYdkoHF2jzHehSSj8Qmje6BpPSZURJDp83MsEu0iBQfWdEQ38AVeK31831zL4cwx7OiwgY6pgEH6r1o%2BrPPRynBbLiJnZYqQx393NrFi8nl5tAWtfByBEd%2BKSJwvclfZkwv3X64rWOSkkrYHRRQDAAZBlYApsAjw3zNCAATzOVQJ857KZgmMz66TtgUWN9vZlAbcZV2N2My92FtBIMUaTxR%2FZBkj4pMT2nKQ68p2nGD76tBNn6b5NBwixGA1eSKVJas%2BM98vBZJjyoU6VGw8Mzr%2FIgASbxOVs6Rcyi4&Expires=1749592579",
      "tipo": "renda",
      "statusDocumento": "aprovado",
      "motivoNegado": null,
      "dataAprovacao": "2025-05-30",
      "alteradoEm": "2025-05-30T10:44:45.722474-03:00",
      "id": "29"
    }
  },
  "canal": {
    "nome": "VUON BANK",
    "id": "Yl6W2r5RXpBK"
  }
}

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Header
Authorization
string 
opcional
Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer.
Exemplo:
Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ
Content-Type
string 
opcional
Tipo de mídia do corpo da solicitação.
Exemplo:
application/json
Accept
string 
opcional
Tipo do conteúdo aceito.
Exemplo:
*/*
User-Funcao
string 
requerido
Chave de função fornecida pelo parceiro.
Exemplo:
OF0aX2xTB47P
Parâmetros Bodyapplication/json
valorParcela
number 
opcional
Valor desejado das parcelas. Não pode ser enviado junto com valorSolicitado.
>= 0.1
Exemplo:
100
valorSolicitado
number 
opcional
Valor solicitado para empréstimo. Não pode ser enviado junto com valorParcela.
Exemplo:
1000
prazo
integer <int32>
requerido
Prazo para pagamento do empréstimo, em meses.
Exemplo:
0
cliente
string 
requerido
CPF do cliente realizando o empréstimo, com 11 dígitos.
Exemplo:
99999999999
valorMaximoLiberado
number 
opcional
Valor máximo liberado para empréstimo.
Exemplo:
0.1
porcentagemDescontoTaxa
number 
opcional
Porcentagem da taxa de desconto.
Exemplo:
0
valorTaxaMes
number 
opcional
Valor da taxa ao mês.
Exemplo:
0
valorComissao
number 
opcional
Valor da comissão.
Exemplo:
0
valorTarifa
number 
opcional
Valor da tarifa.
Exemplo:
10
dataPrimeiroVencimento
string <date>
opcional
Data do primeiro vencimento, nos formatos YYYY-MM-DD, DD/MM/YYYY ou DD-MM-YYYY.
Exemplo:
2025-06-03
optarPorSeguro
boolean 
opcional
Indica se o cliente optou por seguro.
Exemplo:
true
linhaCredito
string 
opcional
Linha de crédito utilizada no limite máximo do financiamento.
Exemplo:
1
localizadorExterno
string 
opcional
Localizador externo para identificar a proposta ou contrato.
Exemplo:
9eyr9-98ud9212-djhfa994j
Examples

Respostas

🟢201Criado
application/json
Body
id
string 
opcional
Identificador da proposta de crédito.
Exemplo:
P259753RDXFRG7
localizador
string 
opcional
Localizar da proposta na financeira.
Exemplo:
P259753RDXFRG7
status
enum<string> 
opcional
Status do contrato.
Valores permitidos:
rascunhoanalise-creditonegadaaprovadacanceladaerromesa-credito
Exemplo:
analise-credito
dataPrimeiroVencimento
string <date>
opcional
Data do primeiro vencimento, no formato YYYY-MM-DD.
Exemplo:
2025-07-10
autorizadorMsg
string 
opcional
Mensagem após autorização da proposta, apontando erro ou aprovação.
Exemplo:
Mensagem de autorização.
ultimoVencimento
string <date>
opcional
Data do último vencimento, no formato YYYY-MM-DD.
Exemplo:
2025-07-10
financeira
object 
opcional
Informações sobre a financeira.
id
string 
opcional
Identificador da entidade financeira.
Exemplo:
AM6wkTEWLSNP
nomeFantasia
string 
opcional
Nome fantasia da entidade financeira.
Exemplo:
HPAY
razaoSocial
string 
opcional
Razão social da entidade financeira.
Exemplo:
Horizon Pay Soluções de Crédito
cnpj
string 
opcional
CNPJ da entidade financeira, com 14 dígitos.
Exemplo:
57.123.456/0000-00
antecipacaoDecrescente
boolean 
opcional
Indica se a antecipação é decrescente.
Exemplo:
true
sacEmail
string 
opcional
E-mail do SAC.
Exemplo:
[email protected]
sacTelefone
string 
opcional
Telefone do SAC, com 8 dígitos e DDD.
Exemplo:
(11) 9000-0000
limiteDiasAtrasoAntecipacao
integer 
opcional
Número de dias de atraso permitidos para atencipação.
Exemplo:
0
centroDeCustoPorConvenio
boolean 
opcional
Indica se o centro de custo é configurado por convênio.
Exemplo:
true
sufixoContratoPorConvenio
boolean 
opcional
Indica se o sufixo de contrato é configurado por convênio.
Exemplo:
false
configuraCarimboPorConvenio
boolean 
opcional
Indica se o carimbro é configurado por convênio.
Exemplo:
false
clienteInfoNoContrato
object 
opcional
Informações do cliente no contrato.
cpf
string 
opcional
CPF do cliente, com 11 dígitos.
Exemplo:
123.456.789.10
email
string 
opcional
E-mail do cliente.
Exemplo:
[email protected]
nome
string 
opcional
Nome do cliente.
Exemplo:
Maria João
sobrenome
string 
opcional
Sobrenome do cliente.
Exemplo:
Sousa
dataNascimento
string <date>
opcional
Data de nascimento, no formato YYYY-MM-DD.
Exemplo:
2000-03-01
nascimentoUf
string 
opcional
Unidade federativa de nascimento.
Exemplo:
PB
sexo
string 
opcional
Sexo do cliente.
Exemplo:
F
documento
object 
opcional
Informações de documento do cliente.
endereco
object 
opcional
Informações de endereço do cliente.
nacionalidade
string 
opcional
Nacionalidade do cliente.
Exemplo:
Brasileiro
estadoCivil
string 
opcional
Estado civil do cliente.
Exemplo:
Solteiro
nomePai
string 
opcional
Nome do pai do cliente.
Exemplo:
João Sousa
nomeMae
string 
opcional
Nome da mãe do cliente.
Exemplo:
Maria Sousa
telefoneCelular
string 
opcional
Telefone celular do cliente, com 9 dígitos e DDD.
Exemplo:
+55999347782
telefoneFixo
string 
opcional
Telefone fixo do cliente, com 8 dígitos e DDD.
Exemplo:
8133215567
pagamento
object 
opcional
Informações para pagamento do empréstimo pessoal.
cargo
string 
opcional
Cargo do cliente.
Exemplo:
Analista
salario
number <double>
opcional
Salário do cliente.
Exemplo:
12000
salarioBruto
number <double>
opcional
Salário bruto do cliente.
Exemplo:
12500
salarioLiquido
number <double>
opcional
Salário líquido do cliente.
Exemplo:
11000
escolaridade
string 
opcional
Grau de escolaridade do cliente.
Exemplo:
Superior Completo
conjuge
string 
opcional
Nome do cônjuge do cliente.
Exemplo:
João Matos
resourcetype
string 
opcional
Tipo do recurso.
Exemplo:
PropostaCP
taxaContrato
number 
opcional
Taxa do contrato.
Exemplo:
6
taxaContratoAno
number 
opcional
Taxa de contrato ao ano.
Exemplo:
101.22
taxaIrr
number 
opcional
Taxa de IRR (Internal Rate of Return).
Exemplo:
6.000256702923
taxaCetMes
number 
opcional
Taxa de CET ao mês.
Exemplo:
6.67
taxaCetAno
number 
opcional
Taxa de CET ao ano.
Exemplo:
116.98
taxaIof
integer 
opcional
Taxa IOF.
Exemplo:
3
taxaIofComplementar
number 
opcional
Taxa IOF complementar.
Exemplo:
0.38
taxaMulta
integer 
opcional
Taxa de multa.
Exemplo:
2
diasCobrancaMulta
integer <int32>
opcional
Quantidade de dias para cobrança de multa.
Exemplo:
1
valorLiberado
number 
opcional
Valor liberado para empréstimo.
Exemplo:
1000
valorIof
number 
opcional
Valor IOF.
Exemplo:
6.3
valorTarifas
integer 
opcional
Valor de tarifas.
Exemplo:
0
valorJuros
number 
opcional
Valor de juros.
Exemplo:
60.38
valorRecebivel
number 
opcional
Valor recebível.
Exemplo:
1066.68
valorSeguro
number 
opcional
Valor do seguro.
Exemplo:
0
prazo
integer 
opcional
Prazo para pagamento, em meses.
Exemplo:
1
dataSolicitacao
string <date>
opcional
Data de solicitação do empréstimo, no formato YYYY-MM-DD.
Exemplo:
2025-06-10
valorSolicitado
number 
opcional
Valor solicitado para empréstimo.
Exemplo:
1000
valorFinanciado
number 
opcional
Valor financiado.
Exemplo:
1006.3
modalidade
string 
opcional
Modalidade do contrato.
Exemplo:
pessoal
pagamento
object 
opcional
Informações para pagamento do empréstimo pessoal.
banco
string 
opcional
Código da instituição bancária.
Exemplo:
000
instituicao
string 
opcional
Instituição bancária.
Exemplo:
cAWSHGFHGNj
conta
string 
opcional
Número da conta.
Exemplo:
0101010101
contaDac
string 
opcional
Dígito da conta relacionado ao Domicílio de Arrecadação de Crédito.
Exemplo:
6
agencia
string 
opcional
Número da agência.
Exemplo:
001
agenciaDac
string 
opcional
Dígito da agência relacionado ao Domicílio de Arrecadação de Crédito.
Exemplo:
1
cpfResponsavel
string 
opcional
CPF do responsável pela conta, com 11 dígitos.
Exemplo:
123.456.789-11
cnpjResponsavel
string 
opcional
CNPJ do responsável pela conta. com 14 dígitos.
Exemplo:
96.545.677/0001-84
tipo
enum<string> 
opcional
Tipo da conta corrente.
Valores permitidos:
correntesalariopoupanca
Exemplo:
poupanca
nomeTitular
string 
opcional
Nome do titular da conta bancária.
Exemplo:
Maria Sousa
clienteDesde
string <date>
opcional
Data inicial da relação bancária, no formato YYYY-MM-DD.
Exemplo:
2020-04-03
praca
string 
opcional
Praça bancária.
Exemplo:
28639
individualOuConjunta
enum<string> 
opcional
Conta individual ou conjunta.
Valores permitidos:
individualconjunta
Exemplo:
individual
bancoNome
string 
opcional
Nome da instituição bancária.
Exemplo:
Banco 01
telefone
string 
opcional
Número de telefone da instituição, com 8 dígitos e DDD.
Exemplo:
8133892675
nomeGerente
string 
opcional
Nome do gerente da instituição bancária.
Exemplo:
João Silva
tipoChavePix
enum<string> 
opcional
Tipo da chave Pix.
Valores permitidos:
cpfcnpjemailtelefone_celularaleatoria
Exemplo:
email
chavePix
string 
opcional
Chave Pix associada à conta bancária.
Exemplo:
[email protected]
geradoPor
string 
opcional
Nome do responsável pela geração do contrato.
Exemplo:
Maria Silva
mesaCredito
string 
opcional
Nome da mesa de crédito.
Exemplo:
Mesa de crédito
origem
enum<string> 
opcional
Origem do contrato.
Valores permitidos:
novo-contratorenegociacaoportabilidade
Exemplo:
portabilidade
recebiveis
array [object {6}] 
opcional
Informações sobre recebíveis.
vp
number 
opcional
Valor presente (VP) da parcela.
Exemplo:
1006.3
juros
number 
opcional
Valor dos juros da parcela.
Exemplo:
60.38
valor
number 
opcional
Valor total da parcela.
Exemplo:
1066.68
numParcela
integer <int32>
opcional
Número da parcela, onde 0 = parcela única ou à vista.
Exemplo:
2
dataVencimento
string <date>
opcional
Data de vencimento da parcela, no formato YYYY-MM-DD.
Exemplo:
2025-07-12
valorPrincipal
number 
opcional
Valor principal da parcela, sem valor de juros.
Exemplo:
1006.3
crivoPDF
string 
opcional
Arquivo .pdf contendo informações do contrato.
Exemplo:
.pdf
metadados
object 
opcional
Informações em formato JSON, retornado quando o contrato é efetivado ou assinado.
nomeOperador
string 
opcional
Nome do operador.
Exemplo:
José Gomes
cpfOperador
string 
opcional
CPF do operador, com 11 dígitos.
Exemplo:
123.456.789-10
convenio
object 
opcional
Informações do convênio.
id
string 
opcional
Identificador do convênio.
Exemplo:
Nql4VL3zDYLg
localizador
string 
opcional
Código localizador da proposta ou da operação.
Exemplo:
270284
validacaoDocumentos
string 
opcional
Tipo de validação aplicada aos documentos do cliente.
Exemplo:
basica
comissao
number 
opcional
Valor da comissão.
Exemplo:
0
migradoEm
string <date>
opcional
Data da migração do cliente, no formato YYYY-MM-DD.
Exemplo:
2025-07-10
agenteCertificado
string 
opcional
Nome do agente responsável pela certificação, se houver.
Exemplo:
João Sousa
renegociacaoExterna
boolean 
opcional
Indica se uma renegociação foi feita fora do sistema.
Exemplo:
true
dataPrevistaCredito
string <date>
opcional
Data prevista para crédito em conta, no formato YYYY-MM-DD.
Exemplo:
2025-07-12
alteradoEm
string <date-time>
opcional
Data e hora da última alteração nos registros.
Exemplo:
2025-06-10T17:56:18.861631-03:00
criadoEm
string <date-time>
opcional
Data e hora de criação dos registros.
Exemplo:
2025-06-10T17:56:18.831084-03:00
utilizaValorJusto
boolean 
opcional
Indica se a operação utiliza o valor justo.
Exemplo:
true
cliente
string 
opcional
Identificador único do cliente.
Exemplo:
1Gqon7wsZ85u
cpf
string 
opcional
CPF do cliente, com 11 dígitos.
Exemplo:
123.456.789-09
email
string 
opcional
E-mail do cliente.
Exemplo:
[email protected]
sobrenome
string 
opcional
Sobrenome do cliente.
Exemplo:
Sousa
nome
string 
opcional
Nome do cliente.
Exemplo:
Maria João
dataNascimento
string <date>
opcional
Data de nascimento, com formato YYYY-MM-DD.
Exemplo:
2000-03-06
nascimentoUf
string 
opcional
Unidade federativa de nascimento do cliente.
Exemplo:
PB
sexo
string 
opcional
Sexo do cliente.
Exemplo:
F
nacionalidade
string 
opcional
Nacionalidade do cliente.
Exemplo:
Brasileiro
estadoCivil
string 
opcional
Estado civil do cliente.
Exemplo:
Solteiro
nomePai
string 
opcional
Nome do pai do cliente.
Exemplo:
João Sousa
nomeMae
string 
opcional
Nome da mãe do cliente.
Exemplo:
Maria Sousa
telefoneCelular
string 
opcional
Telefone celular do cliente, com 9 dígitos e DDD obrigatório.
Exemplo:
83987654930
telefoneFixo
string 
opcional
Telefone fixo do cliente, com 8 dígitos e DDD obrigatório.
Exemplo:
8334567283
cargo
string 
opcional
Cargo do cliente.
Exemplo:
Analista
salarioBruto
number 
opcional
Salário bruto do cliente.
Exemplo:
6000
salarioLiquido
number 
opcional
Salário líquido do cliente.
Exemplo:
6200
escolaridade
string 
opcional
Nível de escolaridade do cliente.
Exemplo:
Superior completo
documentacaoComprovacao
object 
opcional
Documento do cliente para comprovação do empréstimo pessoal.
identidadeFrente
object 
opcional
Informações contidas na frente do documento.
identidadeVerso
object 
opcional
Informações contidas no verso do documento.
residencia
object 
opcional
Informações de comprovação de residência.
renda
object 
opcional
Informações para comprovação de renda.
canal
object 
opcional
Informações sobre o canal para empréstimo.
nome
string 
opcional
Nome da instituição ou entidade financeira.
Exemplo:
VUOL BANK
id
string 
opcional
Identificador único da entidade.
Exemplo:
Yl6W2r5RXpBK
🟠400Pedido inválido
🟠401Não autorizado
🟠403Proibido
🟠404Registro não encontrado
🔴500Erro do servidor
Página anterior
Cadastrar clientes para empréstimo
Próxima página
Enviar arquivo