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

Cadastrar clientes 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/pessoa
Use esse endpoint para cadastrar clientes para um empréstimo.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/emprestimos/pessoal/pessoa' \
--header 'Authorization: Bearer 123' \
--header 'Accept: */*' \
--header 'User-Funcao: OF0aX2xTB47P' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cpf": "676.173.180-14",
    "nome": "Teste RPE",
    "sobrenome": "Teste da silva",
    "canal": "Yl6W2r5RXpBK",
    "sexo": "M",
    "dataNascimento": "2000-08-24",
    "email": "[email protected]",
    "telefoneCelular": "83991873707",
    "observacao": "teste",
    "escolaridade": "escola",
    "acessoExterno": "teste112",
    "dominioAcessoExterno": "teste",
    "validadeCertificado": "2025-06-19",
    "dependentes": 4,
    "naturalidade": "João pessoa",
    "nacionalidade": "Brasileiro",
    "nascimentoUf": "PB",
    "estadoCivil": "solteiro",
    "referenciaTelefone": "83991873708",
    "referenciaNome": "parente",
    "referenciaParentesco": "laboris",
    "nomeMae": "Mae de teste da silva",
    "nomePai": "jose de teste da silva",
    "emailNotificacao": "[email protected]",
    "telefoneFixo": "83991873707",
    "salarioBruto": 5000,
    "salarioLiquido": 4500,
    "saldoDevedor": "50",
    "valorEmprestado": "100",
    "margemDisponivel": "101",
    "limiteTotal": "200",
    "limiteMensalTotal": "202",
    "empregoCp": {
        "tipo": "autonômo",
        "empresa": {
            "nomeFantasia": "YziTech",
            "razaoSocial": "Teste Yzi tech",
            "cnpj": "24.343.934/0001-94",
            "telefone": "83991873707"
        },
        "dataAdmissao": "2019-08-24",
        "classeProfissional": "Analista senior",
        "atividade": "ATIVO",
        "salario": 5000
    },
    "cartaoCredito": {
        "bandeira": "mastercard",
        "limite": 1000
    },
    "contatoReferencia": {
        "nome": "Carlos Henryq",
        "relacionamento": "amigo",
        "telefone": "21998765432"
    },
    "dadosConjuge": {
        "nome": "Maria",
        "cpf": "371.421.250-71",
        "dataNascimento": "1999-08-24",
        "empregoCp": {
            "tipo": "autonomo",
            "empresa": {
                "nomeFantasia": "myTech",
                "razaoSocial": "my Teste",
                "cnpj": "77.890.560/0001-93",
                "telefone": "+5583991873707"
            },
            "dataAdmissao": "2018-01-24",
            "classeProfissional": "teste1",
            "atividade": "teste2",
            "salario": 3000
        }
    },
    "rendaExtra": {
        "salario": 500,
        "descricao": "testeDescricao"
    },
    "dadosBancarios": {
        "tipo": "corrente",
        "individualOuConjunta": "individual",
        "cpfResponsavel": "559.584.820-09",
        "cnpjResponsavel": "24.343.934/0001-94",
        "nomeTitular": "João da Silva",
        "clienteDesde": "2019-08-24",
        "praca": "João Pessoa",
        "telefone": "+5583991873708",
        "nomeGerente": "Maria teste",
        "tipoChavePix": "aleatoria",
        "chavePix": "aaaa",
        "banco": "003",
        "agencia": "1",
        "agenciaDac": "1",
        "conta": "12345",
        "contaDac": "3"
    },
    "endereco": {
        "cep": "37133-640",
        "logradouro": "teste",
        "numero": "400",
        "bairro": "Teste",
        "cidade": "Alfenas",
        "uf": "MG",
        "pais": "Argentina",
        "residenciaTipo": "alugada",
        "residenciaTempo": 8,
        "complemento": "apto 101"
    },
    "documento": {
        "tipo": "RG",
        "dataEmissao": "2000-08-24",
        "emissor": "SSPBSASS",
        "uf": "PB",
        "numero": "2130"
    }
}'
Response Response Example
200 - Sucesso
{
    "id": "Bg9J0lM1UZ0U",
    "cpf": "676.173.180-14",
    "nome": "Teste RPE",
    "sobrenome": "Teste da silva",
    "email": "[email protected]",
    "telefoneCelular": "+5583991873707",
    "emailTemporario": "[email protected]",
    "telefoneCelularTemporario": "+5583991873707",
    "emailVerificado": false,
    "telefoneCelularVerificado": false,
    "ultimoLogin": null,
    "possuiAcesso": false,
    "cadastroAtivo": "primeiro-acesso",
    "acessoExterno": "teste27112",
    "dominioAcessoExterno": "teste",
    "validadeCertificado": "2025-06-19",
    "observacao": "teste",
    "nomeCompleto": "Teste RPE Teste da silva",
    "canal": {
        "nome": "VUON BANK",
        "id": "Yl6W2r5RXpBK",
        "cnpj": "00.000.000/0001-91",
        "nomeFantasia": "VUON BANK",
        "razaoSocial": "VUON SCD",
        "endereco": {
            "cep": "04533-013",
            "logradouro": "Rua Tabapuã",
            "numero": "841",
            "bairro": "Itaim Bibi",
            "uf": "SP",
            "cidade": "São Paulo",
            "pais": "BR",
            "residenciaTipo": "nao-informado",
            "residenciaTempo": 0,
            "complemento": null,
            "foto": null
        }
    },
    "empregoCp": {
        "tipo": "autonomo",
        "empresa": {
            "nomeFantasia": "YziTech",
            "cnpj": "24.343.934/0001-94",
            "telefone": "+5583991873707",
            "razaoSocial": "Teste Yzi tech"
        },
        "atividade": "ATIVO",
        "salario": 500.0,
        "dataAdmissao": "2019-08-24",
        "classeProfissional": "senior"
    },
    "cartaoCredito": {
        "bandeira": "mastercard",
        "limite": 1000.0
    },
    "contatoReferencia": {
        "nome": "Carlos Henryq",
        "relacionamento": "amigo",
        "telefone": "+5521998765432"
    },
    "dadosConjuge": {
        "nome": "Mariazinha",
        "cpf": "457.648.180-01",
        "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.0,
            "dataAdmissao": "2018-01-24",
            "classeProfissional": "teste1"
        }
    },
    "escolaridade": "ixcola",
    "rendaExtra": {
        "salario": 400.0,
        "descricao": "testeDescricao"
    },
    "documentacaoComprovacao": {
        "identidadeFrente": null,
        "identidadeVerso": null,
        "residencia": null,
        "renda": null
    },
    "dadosBancarios": {
        "banco": "003",
        "conta": "12345",
        "contaDac": "3",
        "agencia": "1",
        "individualOuConjunta": "individual",
        "tipo": "corrente",
        "tipoChavePix": "aleatoria",
        "praca": "São Pessoa",
        "telefone": "+5583912345678",
        "agenciaDac": "3",
        "cpfResponsavel": "559.584.820-09",
        "cnpjResponsavel": "24.343.934/0001-94",
        "nomeTitular": "João da Silva",
        "clienteDesde": "2019-08-24",
        "nomeGerente": "Maria teste",
        "chavePix": "aaaa"
    },
    "sexo": "M",
    "dependentes": 4,
    "endereco": {
        "cep": "37133-640",
        "logradouro": "teste",
        "numero": "400",
        "bairro": "Teste",
        "uf": "MG",
        "cidade": "Alfenas",
        "pais": "BR",
        "residenciaTipo": "alugada",
        "residenciaTempo": 8,
        "complemento": "apto 101",
        "foto": null
    },
    "dataNascimento": "2000-08-24",
    "documento": {
        "tipo": "RG",
        "numero": "3415571",
        "emissor": "SSPBSASS",
        "uf": "PB",
        "foto": null,
        "dataEmissao": "2000-08-24"
    },
    "naturalidade": "Brasileiro",
    "nacionalidade": "Chines",
    "nascimentoUf": "PB",
    "estadoCivil": "solteiro",
    "referenciaTelefone": "+5583991873708",
    "referenciaNome": "teste",
    "referenciaParentesco": "parente",
    "nomeMae": "Mae de teste da silva",
    "nomePai": "jose de teste da silva",
    "emailNotificacao": "[email protected]",
    "telefoneFixo": "+5583991873707"
}

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 123
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
Parâmetros Bodyapplication/json
cpf
string 
requerido
CPF do cliente.
Exemplo:
676.173.180-14
nome
string 
requerido
Nome do cliente.
Exemplo:
Teste RPE
sobrenome
string 
requerido
Sobrenome do cliente.
Exemplo:
Teste da silva
canal
string 
requerido
Canal do cliente cadastrado.
Exemplo:
Yl6W2r5RXpBK
sexo
string 
requerido
Sexo do cliente.
Exemplo:
M
dataNascimento
string <date>
requerido
Data de nascimento do cliente.
Exemplo:
2000-08-24
email
string 
opcional
E-mail do cliente.
Exemplo:
[email protected]
telefoneCelular
string 
opcional
Telefone celular do cliente.
Exemplo:
83991873707
observacao
string 
opcional
Observação sobre o cliente.
Exemplo:
teste
escolaridade
string 
opcional
Escolaridade do cliente.
Exemplo:
escola
acessoExterno
string 
opcional
Acesso externo do cliente.
Exemplo:
teste112
dominioAcessoExterno
string 
opcional
Dominio do acesso externo do cliente.
Exemplo:
teste
validadeCertificado
string 
opcional
Validade do certificado do cliente.
Exemplo:
2025-06-19
dependentes
integer <int32>
opcional
Número de dependentes do cliente.
Exemplo:
4
naturalidade
string 
opcional
Naturalidade do cliente.
Exemplo:
João pessoa
nacionalidade
string 
opcional
Nacionalidade do cliente.
Exemplo:
Brasileiro
nascimentoUf
string 
opcional
Estado de nascimento do cliente.
Exemplo:
PB
estadoCivil
string 
opcional
Estado civil do cliente.
Exemplo:
solteiro
referenciaTelefone
string 
opcional
Número de telefone. Obrigatório o uso do DDD.
Exemplo:
83991873708
referenciaNome
string 
opcional
Nome do portador do telefone.
Exemplo:
parente
referenciaParentesco
string 
opcional
Parentesco do cliente.
nomeMae
string 
opcional
Nome da mãe.
Exemplo:
Mae de teste da silva
nomePai
string 
opcional
Nome do pai.
Exemplo:
jose de teste da silva
emailNotificacao
string 
opcional
E-mail notificação.
Exemplo:
[email protected]
telefoneFixo
string 
opcional
Telefone fixo. Obrigatório o uso do DDD.
Exemplo:
83991873707
salarioBruto
integer 
opcional
Salário bruto.
Exemplo:
5000
salarioLiquido
integer 
opcional
Salário líquido.
Exemplo:
4500
saldoDevedor
string 
opcional
Saldo devedor.
Exemplo:
50
valorEmprestado
string 
opcional
Valor emprestado.
Exemplo:
100
margemDisponivel
string 
opcional
Margem dísponivel.
Exemplo:
101
limiteTotal
string 
opcional
Limite total.
Exemplo:
200
limiteMensalTotal
string 
opcional
Limite mensal total.
Exemplo:
202
empregoCp
object 
opcional
Informações sobre o emprego do cliente.
tipo
string 
opcional
Tipo de emprego.
Exemplo:
autonômo
empresa
object 
opcional
dataAdmissao
string <date>
opcional
Data de admissão.
Exemplo:
2019-08-24
classeProfissional
string 
opcional
Classe profissional.
Exemplo:
Analista senior
atividade
string 
opcional
Atividade.
Exemplo:
ATIVO
salario
number <double>
opcional
Salário na empresa.
Exemplo:
5000
cartaoCredito
object 
opcional
Informaçõe sobre o cartão de crédito
bandeira
string 
opcional
Bandeira do cartão.
Exemplo:
mastercard
limite
number <double>
opcional
Limite do cartão.
Exemplo:
1000
contatoReferencia
object 
opcional
Informaçõe sobre o contato de referência.
nome
string 
opcional
Nome do contato de referência.
Exemplo:
Carlos Henryq
relacionamento
string 
opcional
Relação com o contato.
Exemplo:
amigo
telefone
string 
opcional
Telefone do contato. Obrigatório o uso do DDD.
Exemplo:
21998765432
dadosConjuge
object 
opcional
Informaçõe sobre o conjugê.
nome
string 
opcional
Nome do cônjuge.
Exemplo:
Maria
cpf
string 
opcional
CPF do cônjuge.
Exemplo:
371.421.250-71
dataNascimento
string <date>
opcional
Data de nascimento do cônjuge.
Exemplo:
1999-08-24
empregoCp
object 
opcional
Emprego do cônjuge.
rendaExtra
object 
opcional
Informaçõe sobre a renda extra.
salario
number <double>
opcional
Salário extra.
Exemplo:
5000
descricao
string 
opcional
Descrição do salário extra.
Exemplo:
testeDescricao
dadosBancarios
object 
opcional
Informaçõe sobre os dados bancários.
tipo
string 
opcional
Tipo de conta.
Exemplo:
corrente
individualOuConjunta
string 
opcional
Indica se é individual ou conjunta.
Exemplo:
individual
cpfResponsavel
string 
opcional
CPF do responsável.
Exemplo:
559.584.820-09
cnpjResponsavel
string 
opcional
CNPJ do responsável.
Exemplo:
24.343.934/0001-94
nomeTitular
string 
opcional
Nome do titular.
Exemplo:
João da Silva
clienteDesde
string <date>
opcional
Data de início do relacionamento do cliente.
Exemplo:
2019-08-24
praca
string 
opcional
Onde o cliente reside ou está vinculado.
Exemplo:
João Pessoa
telefone
string 
opcional
Telefone para contato. Obrigatório o uso do DDD.
Exemplo:
+5583991873708
nomeGerente
string 
opcional
Nome do gerente.
Exemplo:
Maria teste
tipoChavePix
string 
opcional
Tipo de chave Pix.
Exemplo:
aleatoria
chavePix
string 
opcional
Chave pix.
Exemplo:
aaaa
banco
string 
opcional
Número do banco.
Exemplo:
003
agencia
string 
opcional
Agência do banco.
Exemplo:
1
agenciaDac
string 
opcional
Identificação da agência bancária do Domicílio de Arrecadação de Crédito.
Exemplo:
1
conta
string 
opcional
Número da conta.
Exemplo:
12345
contaDac
string 
opcional
Identificação da conta bancária do Domicílio de Arrecadação de Crédito.
Exemplo:
3
endereco
object 
opcional
Informaçõe sobre o endereço.
cep
string 
opcional
Código de Endereçamento Postal (CEP).
Exemplo:
37133-640
logradouro
string 
opcional
Logradouro.
Exemplo:
teste
numero
string 
opcional
Número do endereço.
Exemplo:
400
bairro
string 
opcional
Bairro.
Exemplo:
Teste
cidade
string 
opcional
Cidade.
Exemplo:
Alfenas
uf
string 
opcional
Unidade Federativa.
Exemplo:
MG
pais
string 
opcional
País que reside.
Exemplo:
Argentina
residenciaTipo
string 
opcional
Tipo de residência.
Exemplo:
alugada
residenciaTempo
integer <int32>
opcional
Tempo de residência.
Exemplo:
8
complemento
string 
opcional
Complemento.
Exemplo:
apto 101
documento
object 
opcional
Informações sobre o documento.
tipo
string 
opcional
Tipo de documento.
Exemplo:
RG
dataEmissao
string <date>
opcional
Data de emissão.
Exemplo:
2000-08-24
emissor
string 
opcional
Emissor.
Exemplo:
SSPBSASS
uf
string 
opcional
Unidade Federativa.
Exemplo:
PB
numero
string 
opcional
Número.
Exemplo:
2130
Examples

Respostas

🟢200Success
application/json
Body
id
string 
opcional
Identificador do cliente.
Exemplo:
Bg9J0lM1UZ0U
cpf
string 
opcional
CPF do cliente.
Exemplo:
676.173.180-14
nome
string 
opcional
Nome do cliente.
Exemplo:
Teste RPE
sobrenome
string 
opcional
Sobrenome do cliente.
Exemplo:
Teste da silva
email
string 
opcional
E-mail do cliente.
Exemplo:
[email protected]
telefoneCelular
string 
opcional
Telefone celular do cliente. Obrigatório o uso do DDD.
Exemplo:
+5583991873707
emailTemporario
string 
opcional
E-mail temporário.
Exemplo:
[email protected]
telefoneCelularTemporario
string 
opcional
Telefone temporário. Obrigatório o uso do DDD.
Exemplo:
+5583991873707
emailVerificado
boolean 
opcional
Indica se o e-mail foi verificado.
Exemplo:
false
telefoneCelularVerificado
boolean 
opcional
Indica se o telefone foi verificado.
Exemplo:
false
ultimoLogin
string 
opcional
Último login.
Exemplo:
null
possuiAcesso
boolean 
opcional
Indica se possui acesso.
Exemplo:
false
cadastroAtivo
string 
opcional
Indica o uso.
Exemplo:
primeiro-acesso
acessoExterno
string 
opcional
Acesso externo do cliente.
Exemplo:
teste27112
dominioAcessoExterno
string 
opcional
Dominio do acesso externo do cliente.
Exemplo:
teste
validadeCertificado
string <date>
opcional
Validade do certificado do cliente.
Exemplo:
2025-06-19
observacao
string 
opcional
Observação do cliente.
Exemplo:
teste
nomeCompleto
string 
opcional
Nome completo do cliente.
Exemplo:
Teste RPE Teste da silva
canal
object 
opcional
Informaçõe sobre o canal do cliente.
nome
string 
opcional
Nome do canal.
Exemplo:
VUON BANK
id
string 
opcional
Identificador do canal.
Exemplo:
Yl6W2r5RXpBK
cnpj
string 
opcional
CNPJ cadastrado no canal.
Exemplo:
00.000.000/0001-91
nomeFantasia
string 
opcional
Nome fantasia.
Exemplo:
VUON BANK
razaoSocial
string 
opcional
Razão social
Exemplo:
VUON SCD
endereco
object 
opcional
empregoCp
object 
opcional
Informações sobre o emprego do cliente.
tipo
string 
opcional
Tipo de emprego.
Exemplo:
autonomo
empresa
object 
opcional
atividade
string 
opcional
Atividade
Exemplo:
ATIVO
salario
integer 
opcional
Salário na empresa.
Exemplo:
500
dataAdmissao
string <date>
opcional
Data de admissão.
Exemplo:
2019-08-24
classeProfissional
string 
opcional
Classe profissional.
Exemplo:
Analista senior
cartaoCredito
object 
opcional
Informações sobre o cartão de crédito
bandeira
string 
opcional
Bandeira do cartão.
Exemplo:
mastercard
limite
number <double>
opcional
Limite do cartão.
Exemplo:
1000
contatoReferencia
object 
opcional
Informações sobre contato de referência.
nome
string 
opcional
Nome do contato de referência.
Exemplo:
Carlos Henryq
relacionamento
string 
opcional
Relação com o contato.
Exemplo:
amigo
telefone
string 
opcional
Telefone do contato. Obrigatório o uso do DDD.
Exemplo:
+5521998765432
dadosConjuge
object 
opcional
Dados do cônjuge.
nome
string 
opcional
Nome do cônjuge.
Exemplo:
Maria
cpf
string 
opcional
CPF do cônjuge.
Exemplo:
371.421.250-71
dataNascimento
string <date>
opcional
Data de nascimento do cônjuge.
Exemplo:
1999-08-24
empregoCp
object 
opcional
Dados do emprego do cônjuge.
escolaridade
string 
opcional
Nível de estudos.
Exemplo:
ensino médio
rendaExtra
object 
opcional
Informações sobre renda extra.
salario
number <double>
opcional
Salário extra.
Exemplo:
400
descricao
string 
opcional
Descrição do salário extra.
Exemplo:
testeDescricao
documentacaoComprovacao
object 
opcional
Informações sobre a comprovação de documentos do cliente.
identidadeFrente
string 
opcional
Comprovante de identidade frente.
Exemplo:
imagem.exemplo
identidadeVerso
string 
opcional
Comprovante de identidade verso.
Exemplo:
imagem.exemplo
residencia
string 
opcional
Comprovante de residência.
Exemplo:
imagem.exemplo
renda
string 
opcional
Comprovante de renda.
Exemplo:
imagem.exemplo
dadosBancarios
object 
opcional
Informações sobre os dados bancários.
banco
string 
opcional
Número do banco.
Exemplo:
003
conta
string 
opcional
Número da conta.
Exemplo:
12345
contaDac
string 
opcional
Identificação da conta bancária do Domicílio de Arrecadação de Crédito.
Exemplo:
3
agencia
string 
opcional
Agência do banco.
Exemplo:
1
individualOuConjunta
string 
opcional
Indica se é individual ou conjunta.
Exemplo:
individual
tipo
string 
opcional
Tipo de conta.
Exemplo:
corrente
tipoChavePix
string 
opcional
Tipo de chave Pix.
Exemplo:
aleatoria
praca
string 
opcional
Onde o cliente reside ou está vinculado.
Exemplo:
João Pessoa
telefone
string 
opcional
Telefone para contato. Obrigatório o uso do DDD.
Exemplo:
+5583912345678
agenciaDac
string 
opcional
Identificação da agência bancária do Domicílio de Arrecadação de Crédito.
Exemplo:
1
cpfResponsavel
string 
opcional
CPF do responsável.
Exemplo:
559.584.820-09
cnpjResponsavel
string 
opcional
CNPJ do responsável.
Exemplo:
24.343.934/0001-94
nomeTitular
string 
opcional
Nome do titular.
Exemplo:
João da Silva
clienteDesde
string <date>
opcional
Data de início do relacionamento do cliente.
Exemplo:
2019-08-24
nomeGerente
string 
opcional
Nome do gerente.
Exemplo:
Maria teste
chavePix
string 
opcional
Chave Pix.
Exemplo:
aaaa
sexo
string 
opcional
Sexo do cliente.
Exemplo:
M
dependentes
integer <int32>
opcional
Número de dependentes
Exemplo:
4
endereco
object 
opcional
Informações sobre o endereço do cliente.
cep
string 
opcional
Código de Endereçamento Postal (CEP).
Exemplo:
37133-640
logradouro
string 
opcional
Logradouro.
Exemplo:
teste
numero
string 
opcional
Número do endereço.
Exemplo:
400
bairro
string 
opcional
Bairro.
Exemplo:
Teste
uf
string 
opcional
Unidade Federativa.
Exemplo:
MG
cidade
string 
opcional
Cidade.
Exemplo:
Alfenas
pais
string 
opcional
País que reside.
Exemplo:
Argentina
residenciaTipo
string 
opcional
Tipo de residência.
Exemplo:
alugada
residenciaTempo
integer 
opcional
Tempo de residência.
Exemplo:
8
complemento
string 
opcional
Complemento.
Exemplo:
apto 101
foto
string 
opcional
Comprovante de endereço.
Exemplo:
imagem.exemplo
dataNascimento
string <date>
opcional
Data de nascimento.
Exemplo:
2000-08-24
documento
object 
opcional
Informações sobre os documentos do cliente.
tipo
string 
opcional
Tipo de documento.
Exemplo:
RG
numero
string 
opcional
Número.
Exemplo:
2130
emissor
string 
opcional
Emissor.
Exemplo:
SSPBSASS
uf
string 
opcional
Unidade Federativa.
Exemplo:
PB
foto
string 
opcional
Foto.
Exemplo:
imagem.exemplo
dataEmissao
string <date>
opcional
Data de emissão.
Exemplo:
2000-08-24
naturalidade
string 
opcional
Naturalidade do cliente.
Exemplo:
João pessoa
nacionalidade
string 
opcional
Nacionalidade do cliente.
Exemplo:
Brasileiro
nascimentoUf
string 
opcional
Estado de nascimento
Exemplo:
PB
estadoCivil
string 
opcional
Estado civil do cliente.
Exemplo:
Solteiro
referenciaTelefone
string 
opcional
Número de telefone.
Exemplo:
83991873708
referenciaNome
string 
opcional
Nome do portador do telefone.
Exemplo:
joão
referenciaParentesco
string 
opcional
Parentesco do cliente.
Exemplo:
amigo
nomeMae
string 
opcional
Nome da mãe.
Exemplo:
Mae de teste da silva
nomePai
string 
opcional
Nome do pai.
Exemplo:
jose de teste da silva
emailNotificacao
string 
opcional
E-mail notificação.
Exemplo:
[email protected]
telefoneFixo
string 
opcional
Telefone fixo. Obrigatório o uso do DDD.
Exemplo:
83991873707
🟠400Pedido inválido
🟠401Não autorizado
🟠403Proibido
🟠404Registro não encontrado
🔴500Erro do servidor
Página anterior
Empréstimo
Próxima página
Solicitar crédito para empréstimo