Tote
InícioComece aquiAnalisaIntegra
InícioComece aquiAnalisaIntegra
  1. Empréstimo Simplificado
  • 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
          • Solicitar crédito para empréstimo
        • 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
            GET
          • Consultar informações de contrato
            GET
          • Consultar contratos de empréstimo
            GET
      • 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 Simplificado

Consultar informações de contrato

Sandbox
https://horizon-api-sb.app.rpe.tech
Sandbox
https://horizon-api-sb.app.rpe.tech
GET
https://horizon-api-sb.app.rpe.tech
/api/v1/emprestimos/pessoal/simplificado/contrato/{idContrato}
Use este endpoint para consultar informações de um contrato de empréstimo a partir do seu identificador.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/emprestimos/pessoal/simplificado/contrato/RPEINTEGRA2001?fields=nome,taxa&allFields=true' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NTI2MTg2NTEsImlhdCI6MTc1MjYwMDY1MiwianRpIjoiNmRhODY0OGQtOTM3Yy00M2E1LTk0MDUtOGE3YWE4MjRlNDJhIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6ImQ5NTMzYjhlLTI1ZjEtNGYyNi04YjgxLTY0NjJhNjJkNTFhOCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6ImQ5NTMzYjhlLTI1ZjEtNGYyNi04YjgxLTY0NjJhNjJkNTFhOCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.4w5lAlGrOSJbZ7U2lQx7UyrAopFOCFUYArFpLk0ReCHwbekdrqu_hJxIRq6HDOhzYPtrCsQyCP98TRHAFwOJ4Q' \
--header 'Accept: */*' \
--header 'User-Funcao: OF0aX2xTB47P' \
--header 'Content-Type: application/json'
Response Response Example
200 - Sucesso
{
  "id": "C256297BQADPXS",
  "localizador": "C256297BQADPXS",
  "status": "cancelado",
  "dataPrimeiroVencimento": "2025-08-04",
  "financeira": {
    "id": "AM6wkTEWLSNP",
    "nomeFantasia": "Vuun",
    "razaoSocial": "Vuun Sociedade de Crédito Direto S/A",
    "cnpj": "57.523.215/0001-04",
    "antecipacaoDecrescente": false,
    "sacEmail": "[email protected]",
    "sacTelefone": "(11) 3003-2850",
    "limiteDiasAtrasoAntecipacao": 0,
    "centroDeCustoPorConvenio": false,
    "sufixoContratoPorConvenio": false,
    "configuraCarimboPorConvenio": false
  },
  "clienteInfoNoContrato": {
    "cpf": "087.439.663-81",
    "email": "[email protected]",
    "nome": "Maria Fernanda",
    "sobrenome": "Rodrigues",
    "dataNascimento": "1997-03-18",
    "nascimentoUf": "MA",
    "sexo": "F",
    "documento": {
      "tipo": "RG",
      "numero": "0786533020231",
      "dataEmissao": "2014-05-10",
      "emissor": "SSP/MA",
      "uf": "MA",
      "foto": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII="
    },
    "endereco": {
      "cep": "65071-383",
      "logradouro": "Avenida Neiva Moreira",
      "numero": "400",
      "complemento": "Apto 1204, Bloco A",
      "bairro": "Calhau",
      "uf": "MA",
      "cidade": "São Luís",
      "pais": "BR",
      "residenciaTipo": "propria",
      "residenciaTempo": 10,
      "foto": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII="
    },
    "nacionalidade": "Brasileiro",
    "estadoCivil": "casado",
    "nomePai": "José Carlos Rodrigues",
    "nomeMae": "Marjoice Pestana Rodrigues",
    "telefoneCelular": "+5598984769292",
    "telefoneFixo": "+559832488090",
    "pagamento": {
      "banco": "033",
      "instituicao": "cRUUJDy3PhNj",
      "conta": "01012091",
      "contaDac": "6",
      "agencia": "2307",
      "agenciaDac": "0",
      "cpfResponsavel": "087.439.663-81",
      "cnpjResponsavel": "57.523.215/0001-04",
      "tipo": "corrente",
      "nomeTitular": "Maria Fernanda Rodrigues",
      "clienteDesde": "2018-03-20",
      "praca": "São Luís",
      "individualOuConjunta": "individual",
      "bancoNome": "BANCO SANTANDER (BRASIL) S.A.",
      "telefone": "(98) 3235-5000",
      "nomeGerente": "Ana Clara Lima",
      "tipoChavePix": "cpf",
      "chavePix": "087.439.663-81"
    },
    "cargo": "Analista TI",
    "salario": 12500,
    "salarioBruto": 12500,
    "salarioLiquido": 9550,
    "escolaridade": "pos_graduacao",
    "conjuge": {
      "nome": "Mariazinha",
      "cpf": "852.298.220-15",
      "dataNascimento": "1999-08-24",
      "empregoCp": {
        "tipo": "autonomo",
        "empresa": {
          "nomeFantasia": "myTech",
          "cnpj": "77.890.560/0001-93",
          "telefone": "+5583991873707",
          "razaoSocial": "my Teste"
        },
        "atividade": "teste2",
        "salario": 200,
        "dataAdmissao": "2018-01-24",
        "classeProfissional": "teste1"
      }
    },
    "resourcetype": "ContratoCP"
  },
  "taxaContrato": 5.19,
  "taxaContratoAno": 83.52,
  "taxaIrr": 5.190011429508,
  "taxaCetMes": 5.61,
  "taxaCetAno": 92.41,
  "taxaIof": 3,
  "taxaIofComplementar": 0.38,
  "taxaMulta": 2,
  "diasCobrancaMulta": 1,
  "valorLiberado": 1000,
  "valorIof": 11.8,
  "valorTarifas": 0,
  "valorJuros": 167.9,
  "valorRecebivel": 235.94,
  "valorSeguro": 0,
  "prazo": 5,
  "dataSolicitacao": "2025-07-04",
  "valorFinanciado": 1011.8,
  "modalidade": "pessoal",
  "pagamento": {
    "banco": "033",
    "instituicao": "cRUUJDy3PhNj",
    "conta": "01012091",
    "contaDac": "6",
    "agencia": "2307",
    "agenciaDac": "0",
    "cpfResponsavel": "087.439.663-81",
    "cnpjResponsavel": "57.523.215/0001-04",
    "tipo": "corrente",
    "nomeTitular": "Maria Fernanda Rodrigues",
    "clienteDesde": "2018-03-20",
    "praca": "São Luís",
    "individualOuConjunta": "individual",
    "bancoNome": "BANCO SANTANDER (BRASIL) S.A.",
    "telefone": "(98) 3235-5000",
    "nomeGerente": "Ana Clara Lima",
    "tipoChavePix": "cpf",
    "chavePix": "087.439.663-81"
  },
  "origem": "novo-contrato",
  "metadados": {
    "origem_lead": "campanha_google_ads_q3"
  },
  "nomeOperador": "José Gomes",
  "cpfOperador": "498.557.378-73",
  "comissao": 0,
  "migradoEm": "2025-07-04T12:06:21.470273-03:00",
  "agenteCertificado": "teste",
  "renegociacaoExterna": false,
  "dataPrevistaCredito": "2025-07-04",
  "alteradoEm": "2025-07-05T23:00:00.784552-03:00",
  "criadoEm": "2025-07-04T12:06:21.470273-03:00",
  "utilizaValorJusto": true,
  "cliente": "1Gqon7wsZ85u",
  "cpf": "087.439.663-81",
  "email": "[email protected]",
  "sobrenome": "Rodrigues",
  "nome": "Maria Fernanda",
  "dataNascimento": "1997-03-18",
  "nascimentoUf": "MA",
  "sexo": "F",
  "nacionalidade": "Brasileiro",
  "estadoCivil": "casado",
  "nomePai": "José Carlos Rodrigues",
  "nomeMae": "Marjoice Pestana Rodrigues",
  "telefoneCelular": "+5598984769292",
  "telefoneFixo": "+559832488090",
  "cargo": "Analista TI",
  "salarioBruto": 12500,
  "salarioLiquido": 9550,
  "escolaridade": "pos_graduacao",
  "documentacaoComprovacao": {
    "identidadeFrente": {
      "documento": "https://onidata-creditorapi-vuun-hmg-storage.s3.amazonaws.com/onidata-creditorapi-storage/Yl6W2r5RXpBK/documentos_clientes/image_17_zSBtTZU.png?...",
      "tipo": "identidade_frente",
      "statusDocumento": "aprovado",
      "dataAprovacao": "2025-05-30",
      "alteradoEm": "2025-05-30T10:44:45.722774-03:00",
      "id": "32"
    },
    "identidadeVerso": {
      "documento": "https://onidata-creditorapi-vuun-hmg-storage.s3.amazonaws.com/onidata-creditorapi-storage/Yl6W2r5RXpBK/documentos_clientes/image_17_kSrIZIi.png?...",
      "tipo": "identidade_verso",
      "statusDocumento": "aprovado",
      "dataAprovacao": "2025-05-30",
      "alteradoEm": "2025-05-30T10:44:45.973754-03:00",
      "id": "31"
    },
    "residencia": {
      "documento": "https://onidata-creditorapi-vuun-hmg-storage.s3.amazonaws.com/onidata-creditorapi-storage/Yl6W2r5RXpBK/documentos_clientes/image_17_goG8IFX.png?...",
      "tipo": "residencia",
      "statusDocumento": "aprovado",
      "dataAprovacao": "2025-05-30",
      "alteradoEm": "2025-05-30T10:44:45.883990-03:00",
      "id": "30"
    },
    "renda": {
      "documento": "https://onidata-creditorapi-vuun-hmg-storage.s3.amazonaws.com/onidata-creditorapi-storage/Yl6W2r5RXpBK/documentos_clientes/image_17.png?...",
      "tipo": "renda",
      "statusDocumento": "aprovado",
      "dataAprovacao": "2025-05-30",
      "alteradoEm": "2025-05-30T10:44:45.722474-03:00",
      "id": "29"
    }
  },
  "canal": {
    "nome": "VUN BANK",
    "id": "Yl6W2ru5RXpBK"
  },
  "statusAlteradoEm": "2025-07-05T23:00:00.734344-03:00",
  "dataUltimoVencimento": "2025-12-04",
  "proposta": "P256297BQADPXS",
  "geradoEm": "2025-07-04T12:06:21.449532-03:00",
  "taxaPermanencia": 1,
  "assinaturaInfo": {
    "ip": "189.50.110.22",
    "data": "2025-07-04T12:05:40.000000-03:00",
    "browser": "Chrome/125.0.0.0",
    "localizacao": {
      "coordenadas": {
        "precisao": 10683.574382881354,
        "latitude": -8.1201525,
        "longitude": -34.8955087
      },
      "timestamp": 0
    }
  },
  "valorParcela": 235.94,
  "saldoDevedor": 0,
  "protocoloDigitalPdf": "https://storage.vuun.hmg.tec.br/protocolos/C256297BQADPXS.pdf",
  "ccbOriginalHtml": "https://storage.vun.hmg.tec.br/ccb/C256297BQADPXS.html",
  "ccbOriginalPdf": "https://onidata-creditorapi-vun-hmg-storage.s3.amazonaws.com/AM6wkTEWLSNP/ccb/original/ccb_C256297BQADPXS_original.pdf?...",
  "canalAtendimento": "canal",
  "parcelasInfo": {
    "emAtraso": {
      "recebiveis": [
        "teste",
        "xablau"
      ],
      "total": 0
    },
    "pendentes": {
      "recebiveis": [],
      "total": 0
    },
    "pagas": {
      "recebiveis": [],
      "total": 0
    }
  },
  "financeiraValorAPagar": 1000,
  "promotora": "Não informado",
  "statusDescricao": "pre-efetivacao",
  "renegociadoPor": [
    {
      "id": "C259839UJPBYUY",
      "status": "renegociado",
      "statusAlteradoEm": "2025-09-23T14:55:34.218556-03:00"
    }
  ],
  "suspensaoCobranca": false,
  "suspensaoEm": "2025-07-04T12:06:21.471308-03:00",
  "suspensaoPor": "2025-07-04T12:06:21.471308-03:00",
  "dataCancelamento": "2025-07-07",
  "dataEfetivacao": "2025-07-05T11:00:00.000000-03:00",
  "estornadoEm": "2025-07-08T10:15:30.000000-03:00",
  "valorALiquidar": 0
}

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Path
idContrato
string 
requerido
Identificador do contrato a ser pesquisado.
Exemplo:
RPEINTEGRA2001
Parâmetros Query
fields
string 
opcional
Campos a serem retornados na pesquisa, separados por vírgula e sem espaço.
Exemplo:
nome,taxa
allFields
boolean 
opcional
Indica se deve retornar todos os campos.
Padrão:
true
Exemplo:
true
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.eyJleHAiOjE3NTI2MTg2NTEsImlhdCI6MTc1MjYwMDY1MiwianRpIjoiNmRhODY0OGQtOTM3Yy00M2E1LTk0MDUtOGE3YWE4MjRlNDJhIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6ImQ5NTMzYjhlLTI1ZjEtNGYyNi04YjgxLTY0NjJhNjJkNTFhOCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6ImQ5NTMzYjhlLTI1ZjEtNGYyNi04YjgxLTY0NjJhNjJkNTFhOCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.4w5lAlGrOSJbZ7U2lQx7UyrAopFOCFUYArFpLk0ReCHwbekdrqu_hJxIRq6HDOhzYPtrCsQyCP98TRHAFwOJ4Q
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 
opcional
Chave de função fornecida pelo parceiro.
Exemplo:
OF0aX2xTB47P

Respostas

🟢200Success
application/json
Body
id
string 
opcional
Identificador da proposta financeira.
Exemplo:
C256297BQADPXS
localizador
string 
opcional
Localizador da proposta financeira.
Exemplo:
C256297BQADPXS
status
enum<string> 
opcional
Status do contrato.
Valores permitidos:
rascunhoanalise-creditonegadaaprovadacanceladoerromesa-credito
Exemplo:
cancelado
dataPrimeiroVencimento
string <date>
opcional
Data do primeiro vencimento, no formato YYYY-MM-DD.
Exemplo:
2025-08-04
autorizadorMsg
string 
opcional
Mensagem do autorizador.
Exemplo:
Mensagem de autorização
financeira
object 
opcional
Informações sobre a entidade financeira.
id
string 
opcional
Identificador da entidade financeira.
Exemplo:
AM6wkTEWLSNP
nomeFantasia
string 
opcional
Nome fantasia da entidade.
Exemplo:
Vuun
razaoSocial
string 
opcional
Razão social da entidade.
Exemplo:
Vuun
cnpj
string 
opcional
CNPJ da entidade, com 14 dígitos.
Exemplo:
57.523.215/0001-04
antecipacaoDecrescente
boolean 
opcional
Indica se a antecipação é decrescente.
Padrão:
false
sacEmail
string 
opcional
E-mail para atendimento ao consumidor.
Exemplo:
[email protected]
sacTelefone
string 
opcional
Telefone para atendimento ao consumidor, com DDD obrigatório.
Exemplo:
(11) 3003-2850
limiteDiasAtrasoAntecipacao
integer <int32>
opcional
Limite de dias de atraso permitidos para antecipação.
Exemplo:
0
centroDeCustoPorConvenio
boolean 
opcional
Indica se o centro de custo é configurado por convênio.
Padrão:
false
sufixoContratoPorConvenio
boolean 
opcional
Indica se o sufixo do contrato é configurado por convênio.
Padrão:
false
configuraCarimboPorConvenio
boolean 
opcional
Indica se o carimbo é configurado por convênio.
Padrão:
false
clienteInfoNoContrato
object 
opcional
Informações de cliente no contrato.
cpf
string 
opcional
CPF, com 11 dígitos.
Exemplo:
087.439.663-81
email
string 
opcional
E-mail válido.
Exemplo:
[email protected]
nome
string 
opcional
Nome.
Exemplo:
Maria
sobrenome
string 
opcional
Sobrenome.
Exemplo:
Rodrigues
dataNascimento
string <date>
opcional
Data de nascimento, no formato YYYY-MM-DD.
Exemplo:
1997-03-19
nascimentoUf
string 
opcional
Unidade federativa (estado) de nascimento.
Exemplo:
1997-03-18
sexo
enum<string> 
opcional
Sexo.
Valores permitidos:
MF
Exemplo:
F
documento
object 
opcional
Documento oficial para proposta.
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:
casado
nomePai
string 
opcional
Nome do pai do cliente.
Exemplo:
João Silva
nomeMae
string 
opcional
Nome da mãe do cliente.
Exemplo:
Maria Rodrigues
telefoneCelular
string 
opcional
Telefone celular do cliente, com 9 dígitos e DDD obrigatório.
Exemplo:
+5598984769292
telefoneFixo
string 
opcional
Telefone fixo do cliente, com 8 dígitos e DDD obrigatório.
Exemplo:
+559832488090
pagamento
object 
opcional
Informações de pagamento do empréstimo.
cargo
string 
opcional
Cargo do cliente.
Exemplo:
Analista TI
salario
number <double>
opcional
Salário do cliente.
Exemplo:
12500
salarioBruto
number <double>
opcional
Salário bruto do cliente.
Exemplo:
12500
salarioLiquido
number <double>
opcional
Salário líquido do cliente.
Exemplo:
9550
escolaridade
string 
opcional
Grau de escolaridade do cliente.
Exemplo:
pos_graduacao
conjuge
object 
opcional
Informações do cônjuge.
resourcetype
string 
opcional
Tipo de recurso.
Exemplo:
Contrato CP
taxaContrato
number 
opcional
Taxa de contrato.
Exemplo:
5.19
taxaContratoAno
number 
opcional
Taxa de contrato ao ano.
Exemplo:
83.52
taxaIrr
number 
opcional
Taxa de IRR (Interal Rate of Return).
Exemplo:
5.1999001
taxaCetMes
number 
opcional
Taxa CET ao mês.
Exemplo:
5.61
taxaCetAno
number 
opcional
Taxa CET ao ano.
Exemplo:
92.41
taxaIof
number 
opcional
Taxa IOF.
Exemplo:
3
taxaIofComplementar
number 
opcional
Taxa IOF complementar.
Exemplo:
0.38
taxaMulta
number 
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:
11.8
valorTarifas
number 
opcional
Valor das tarifas.
Exemplo:
10
valorJuros
number 
opcional
Valor de juros.
Exemplo:
167.9
valorRecebivel
number 
opcional
Valor total a ser recebido.
Exemplo:
235.94
valorSeguro
number 
opcional
Valor do seguro.
Exemplo:
0
prazo
integer <int32>
opcional
Prazo do contrato, em meses.
Exemplo:
5
dataSolicitacao
string <date>
opcional
Data de solicitação, no formato YYYY-MM-DD.
Exemplo:
2025-07-04
valorSolicitado
number 
opcional
Valor solicitado para empréstimo.
Exemplo:
10500
valorFinanciado
number 
opcional
Valor financiado.
Exemplo:
1011.8
modalidade
string 
opcional
Modalidade do contrato.
Exemplo:
pessoal
origem
enum<string> 
opcional
Origem do contrato.
Valores permitidos:
novo-contratorenegociacaoportabilidade
Exemplo:
novo-contrato
metadados
object 
opcional
Informações em formato JSON, retornado quando o contrato é efetivado ou assinado.
origem_lead
string 
opcional
Origem do lead para o contrato.
Exemplo:
campanha_google_ads_q3
nomeOperador
string 
opcional
Nome do operador.
Exemplo:
José Gomes
cpfOperador
string 
opcional
CPF do operador, com 11 dígitos.
Exemplo:
999.999.999-99
convenio
object 
opcional
Informações sobre o convênio.
id
string 
opcional
Identificador da entidade.
Exemplo:
Nql4VL3zDYLg
localizador
string 
opcional
Localizador da proposta ou da operação.
Exemplo:
270284
validacaoDocumentos
enum<string> 
opcional
Tipo de validação dos documentos.
Valores permitidos:
basicaexterna_por_envioexterna_por_recebimentosem_verificacao
Exemplo:
basica
comissao
number 
opcional
Valor da comissão.
>= 0
Exemplo:
0
migradoEm
string <date-time>
opcional
Data da migração do cliente, no formato YYYY-MM-DD.
Exemplo:
2025-07-04T12:06:21.470273-03:00
agenteCertificado
string 
opcional
Nome do agente responsável pela certificação, se houver.
Exemplo:
Teste
renegociacaoExterna
boolean 
opcional
Indica se uma renegociação foi feita fora do sistema.
Padrão:
false
dataPrevistaCredito
string <date>
opcional
Data prevista para crédito em conta, no formato YYYY-MM-DD.
Exemplo:
2025-07-04
alteradoEm
string <date-time>
opcional
Data e hora da última alteração nos registros.
Exemplo:
2025-07-05T23:00:00.784552-03:00
criadoEm
string <date-time>
opcional
Data e hora de criação dos registros.
Exemplo:
2025-07-04T12:06:21.470273-03:00
utilizaValorJusto
boolean 
opcional
Indica se a operação utiliza valor justo.
Padrão:
true
cliente
string 
opcional
Identificador único do cliente.
Exemplo:
1Gqon7wsZ85u
cpf
string 
opcional
CPF do cliente, com 11 dígitos.
Exemplo:
087.439.663-81
email
string 
opcional
E-mail do cliente.
Exemplo:
[email protected]
sobrenome
string 
opcional
Sobrenome do cliente.
Exemplo:
Rodrigues
nome
string 
opcional
Nome do cliente.
Exemplo:
Maria
dataNascimento
string <date>
opcional
Data de nascimento do cliente, no formato YYYY-MM-DD.
Exemplo:
1997-03-18
nascimentoUf
string 
opcional
Unidade federativa de nascimento do cliente.
Exemplo:
MA
sexo
enum<string> 
opcional
Sexo do cliente.
Valores permitidos:
MF
Exemplo:
F
nacionalidade
string 
opcional
Nacionalidade do cliente.
Exemplo:
Brasileiro
estadoCivil
string 
opcional
Estado civil do cliente.
Exemplo:
casado
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:
+5598984769292
telefoneFixo
string 
opcional
Telefone fixo do cliente, com 8 dígitos e DDD obrigatório.
Exemplo:
+559832488090
cargo
string 
opcional
Cargo do cliente.
Exemplo:
Analista TI
salarioBruto
number 
opcional
Salário bruto do cliente.
Exemplo:
12500
salarioLiquido
number 
opcional
Salário líquido do cliente.
Exemplo:
9500
escolaridade
string 
opcional
Grau de escolaridade do cliente.
Exemplo:
pos_graduacao
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
Informações sobre o canal para empréstimo.
Exemplo:
Vuun Bank
id
string 
opcional
Identificador único da entidade.
Exemplo:
Yl6W2r5RXpBK
statusAlteradoEm
string <date-time>
opcional
Data de alteração do status.
Exemplo:
2025-07-05T23:00:00.734344-03:00
dataUltimoVencimento
string <date>
opcional
Data do último vencimento.
Exemplo:
2025-12-04
proposta
string 
opcional
Identificador da proposta.
Exemplo:
P256297BQADPXS
geradoEm
string <date-time>
opcional
Data de geração do contrato.
Exemplo:
2025-07-04T12:06:21.449532-03:00
taxaPermanencia
number 
opcional
Valor da taxa de permanência.
Exemplo:
1
assinaturaInfo
object 
opcional
Informações sobre a assinatura do contrato.
ip
string 
opcional
Endereço IP.
Exemplo:
189.50.110.22
data
string <date-time>
opcional
Data de assinatura.
Exemplo:
2025-07-04T12:05:40.000000-03:00
browser
string 
opcional
Navegador utilizado.
Exemplo:
Chrome/125.0.0.0
localizacao
object 
opcional
Localização geográfica.
valorParcela
number 
opcional
Valor da parcela.
Exemplo:
235.94
saldoDevedor
number 
opcional
Valor do saldo devedor.
Exemplo:
0
protocoloDigitalPdf
string 
opcional
Link do arquivo .pdf do protocolo digital.
Exemplo:
https://storage.vuun.hmg.tec.br/protocolos/C256297BQADPXS.pdf
ccbOriginalHtml
string 
opcional
Link do documento em HTML.
Exemplo:
https://storage.vuun.hmg.tec.br/ccb/C256297BQADPXS.html
ccbOriginalPdf
string 
opcional
Link do documento em .PDF.
Exemplo:
https://onidata-creditorapi-vuun-hmg-storage.s3.amazonaws.com/AM6wkTEWLSNP/ccb/original/ccb_C256297BQADPXS_original.pdf?...
canalAtendimento
string 
opcional
Canal de atendimento.
Exemplo:
Canal de atendimento
parcelasInfo
object 
opcional
Informações sobre parcelamento.
emAtraso
object 
opcional
Sobre parcelas em atraso.
pendentes
object 
opcional
Sobre parcelas pendentes.
pagas
object 
opcional
Sobre parcelas pagas.
financeiraValorAPagar
number 
opcional
Valor a pagar pela financeira.
Exemplo:
1000
promotora
string 
opcional
Nome da promotora de crédito.
Exemplo:
Sem informações
statusDescricao
enum<string> 
opcional
Descrição do status do contrato.
Valores permitidos:
pre-efetivacaodesistencia-pre-pagamentodesistencia-pos-pagamentofraudequitacaorenegociacaotransferencia-gestao
renegociadoPor
array [object {3}] 
opcional
Informações da renegociação de origem.
id
string 
opcional
Identificador da renegociação de origem.
Exemplo:
C259839UJPBYUY
status
string 
opcional
Status da renegociação de origem.
Exemplo:
renegociado
statusAlteradoEm
string <date-time>
opcional
Data e hora da alteração de status.
Exemplo:
2025-09-23T14:55:34.218556-03:00
suspensaoCobranca
boolean 
opcional
Indica se houve suspensão de cobrança.
Padrão:
false
suspensaoEm
string <date-time>
opcional
Data e hora da suspensão.
Exemplo:
2025-07-04T12:06:21.471308-03:00
suspensaoPor
string 
opcional
Nome de quem executou a suspensão.
Exemplo:
Maria Silva
dataCancelamento
string <date>
opcional
Data do cancelamento do contrato.
Exemplo:
2025-07-07
dataEfetivacao
string <date-time>
opcional
Data da efetivação.
Exemplo:
2025-07-05T11:00:00.000000-03:00
estornadoEm
string <date-time>
opcional
Data e hora do estorno.
Exemplo:
2025-07-05T11:00:00.000000-03:00
valorALiquidar
number 
opcional
Valor do contrato a ser liquidado.
Exemplo:
0
🟠400Pedido inválido
🟠401Não autorizado
🟠403Proibido
🟠404Registro não encontrado
🔴500Erro do servidor
Página anterior
Listar bancos
Próxima página
Consultar contratos de empréstimo