Tote
InícioComece aquiAnalisaIntegra
InícioComece aquiAnalisaIntegra
  1. Empréstimo FGTS
  • 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
            POST
          • Obter saldo
            POST
          • Cadastrar pessoa física
            POST
          • Cadastrar operação
            POST
          • Submeter para aprovação
            POST
          • Consultar informações
            GET
          • Listar produto
            GET
          • Consultar pessoa
            GET
          • Listar operações
            GET
          • Acompanhar operação
            GET
          • Listar estado civil
            GET
          • Listar bancos
            GET
        • 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 FGTS

Cadastrar pessoa física

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/fgts/pessoa/fisica
Utilize este endpoint para cadastrar uma pessoa física.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/emprestimos/fgts/pessoa/fisica' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Jose da Silva",
    "email": "[email protected]",
    "registrationNumber": "08293380470",
    "pep": true,
    "documentIssuer": "SSPRG",
    "documentDate": "2022-10-13",
    "documentExpiration": "2022-10-13",
    "nationality": "Brasileira",
    "birthDate": "2022-10-13",
    "civilStatus": "Single",
    "gender": "Male",
    "mothersName": "Maria da Silva",
    "fathersName": "Josue da Silva",
    "placeOfBirthState": "Brasileira",
    "placeOfBirthCountry": "Brasil",
    "address": {
        "zipCode": "58.052-295",
        "addressName": "Rua da Silva",
        "number": "999",
        "complement": "Ao lado de la",
        "district": "Centro",
        "city": "Taubate",
        "uf": "BA"
    },
    "typeOfResidence": "Owner",
    "phone": "61997741284",
    "phoneExtension": "5020",
    "phone2": "Taubate",
    "phone2Extension": "Taubate",
    "upTo6YearsOld": 1,
    "between7And15YearsOld": 2,
    "over15YearsOld": 3,
    "workplace": "RPE",
    "workplaceCompanyRegistrationNumber": "00000000000000",
    "economicActivityCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "natureOfOccupation": "PrivateEmployee",
    "occupation": "Professor",
    "netSalary": 3000,
    "otherIncome": 300,
    "admissionDate": "2022-10-13",
    "spouseIndividualRegistrationNumber": "99999999999",
    "spouseName": "Mariana da Silva",
    "spouseWorkplace": "99999999999999",
    "spouseOccupation": "Administradora",
    "spouseCommercialPhone": "99999999999",
    "spouseCommercialPhoneExtension": "0000",
    "spouseBirthDate": "2022-10-13",
    "spouseNetSalary": 6000,
    "spouseOtherIncome": 300,
    "allowContactWhatsApp": true,
    "allowUpdatesWhatsApp": true,
    "uploads": [
        {
            "fileType": "Document",
            "fileName": "CNH - 20221014",
            "displayName": "CNH"
        }
    ],
    "documentNumber": "99999999",
    "documentType": "RG",
    "bankAccounts": [
        {
            "bankCode": "Banco_do_Brasil_SA",
            "account": "9999",
            "accountDigit": "9",
            "agency": "99999",
            "agencyDigit": "9",
            "type": "NaturalCheckingAccount",
            "jointAccount": true,
            "operationTypeValue": "Transfer",
            "pixKeyTypeValue": "Phone",
            "keyPix": "99999999999"
        }
    ]
}'
Response Response Example
200 - Example 1
{
    "id": "1a02ca8f-71b3-4bdf-a2f7-ca0db16355f4"
}

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:
application/json
Parâmetros Bodyapplication/json
Parâmetros para cadastrar uma pessoa física.
name
string 
requerido
Nome da pessoa física.
Exemplo:
Jose da Silva
email
string 
requerido
E-mail da pessoa física.
Exemplo:
[email protected]
registrationNumber
string 
requerido
Número do documento.
Exemplo:
08293380470
pep
boolean 
opcional
Pessoa exposta publicamente.
Exemplo:
true
documentIssuer
string 
opcional
Orgão de expedição.
Exemplo:
SSPRG
documentDate
string 
opcional
Data de expedição.
Exemplo:
2022-10-13
documentExpiration
string 
opcional
Data de vencimento.
Exemplo:
2022-10-13
nationality
string 
requerido
Nacionalidade.
Exemplo:
Brasileira
birthDate
string 
requerido
Data de nascimento.
Exemplo:
2022-10-13
civilStatus
enum<string> 
requerido
Estado civil.
Valores permitidos:
MarriedWidowedSeparatedDivorcedSingle
Exemplo:
Single
gender
enum<string> 
opcional
Gênero.
Valores permitidos:
NotInformedMaleFemale
Exemplo:
Female
mothersName
string 
opcional
Nome da mãe.
Exemplo:
Maria da Silva
fathersName
string 
opcional
Nom do pai.
Exemplo:
Josue da Silva
placeOfBirthState
string 
requerido
UF de nascimento.
Exemplo:
Brasileira
placeOfBirthCountry
string 
opcional
País de nascimento.
Exemplo:
Brasil
address
object (Endereco) 
requerido
Parâmetros para cadastrar um endereço.
zipCode
string 
requerido
CEP.
Exemplo:
58.052-295
addressName
string 
requerido
Endereço.
Exemplo:
Rua da Silva
number
string 
requerido
Número.
Exemplo:
999
complement
string 
opcional
Complemento.
Exemplo:
Ao lado de la
district
string 
requerido
Distrito.
Exemplo:
Centro
city
string 
requerido
Cidade.
Exemplo:
Taubate
uf
enum<string> 
requerido
UF.
Valores permitidos:
NaoSelecionadoACALAPAMBACEDFESGOMAMTMSMGPAPBPRPEPIRJRNRSRORRSCSPSETO
Exemplo:
BA
typeOfResidence
enum<string> 
opcional
Tipo de residência.
Valores permitidos:
OwnerRent
Exemplo:
Owner
phone
string 
requerido
Número de telefone.
Exemplo:
61997741284
phoneExtension
string 
opcional
Ramal.
Exemplo:
5020
phone2
string 
opcional
Número de telefone.
Exemplo:
Taubate
phone2Extension
string 
opcional
Ramal.
Exemplo:
Taubate
upTo6YearsOld
integer <int32>
opcional
Idade: até 6 anos de idade.
Exemplo:
1
between7And15YearsOld
integer <int32>
opcional
Idade: entre 7 e 15 anos de idade.
Exemplo:
2
over15YearsOld
integer <int32>
opcional
Idade: maior de 15 anos de idade.
Exemplo:
3
workplace
string 
opcional
Local de trabalho.
Exemplo:
RPE
workplaceCompanyRegistrationNumber
string 
opcional
CNPJ do local de trabalho.
Exemplo:
00000000000000
economicActivityCodeId
string 
opcional
Classificação Nacional de Atividades Econômicas
Exemplo:
3fa85f64-5717-4562-b3fc-2c963f66afa6
natureOfOccupation
enum<string> 
opcional
Natureza da ocupação.
Valores permitidos:
PrivateEmployeePublicEmployeeEmployerCapitalistMilitaryAutonomousOther
Exemplo:
PrivateEmployee
occupation
string 
requerido
Ocupação.
Exemplo:
Professor
netSalary
number <double>
opcional
Renda líquida.
Exemplo:
3000
otherIncome
number <double>
opcional
Outras rendas.
Exemplo:
300
admissionDate
string 
opcional
Data de admissão.
Exemplo:
2022-10-13
spouseIndividualRegistrationNumber
string 
opcional
Número do documento da(o) cônjuge.
Exemplo:
99999999999
spouseName
string 
opcional
Nome da(o) cônjuge.
Exemplo:
Mariana da Silva
spouseWorkplace
string 
opcional
Local de trabalho da(o) cônjuge.
Exemplo:
99999999999999
spouseOccupation
string 
opcional
Ocupação da(o) cônjuge.
Exemplo:
Administradora
spouseCommercialPhone
string 
opcional
Telefone comercial da(o) cônjuge.
Exemplo:
99999999999
spouseCommercialPhoneExtension
string 
opcional
Ramal da(o) cônjuge.
Exemplo:
0000
spouseBirthDate
string 
opcional
Data de nascimento da(o) cônjuge.
Exemplo:
2022-10-13
spouseNetSalary
number <double>
opcional
Renda líquida da(o) cônjuge.
Exemplo:
6000
spouseOtherIncome
number <double>
opcional
Outras rendas da(o) cônjuge.
Exemplo:
300
allowContactWhatsApp
boolean 
opcional
Permitir contato via WhatsApp.
Exemplo:
true
allowUpdatesWhatsApp
boolean 
opcional
Permitir atualizações via WhatsApp.
Exemplo:
true
uploads
array[object (UploadDocumentos) {3}] 
opcional
Lista de documentos carregados
fileType
enum<string> 
requerido
Tipo do arquivo.
Valores permitidos:
DocumentAuthorizationDriversLicenseWorkCardResidenceProofCompanyResidenceProofPartnersDraftSocialContractRegistrationNumberIdentificationDocumentWithPhotoBankStatementManagerialBillingRegistrationFormOthersSelfieSelfieWithIdentityCardLastDeclarationSignedContractSigningStampContractCreditReportAssignmentAdditionFiduciaryAssignmentP7SZipedFilesCNABInvoice
Exemplo:
Document
fileName
string 
requerido
Nome do arquivo.
Exemplo:
CNH - 20221014
displayName
string 
opcional
Nome temporário do arquivo.
Exemplo:
CNH
documentNumber
string 
opcional
Número do documento.
Exemplo:
99999999
documentType
enum<string> 
opcional
Tipo do documento.
Valores permitidos:
RGCPFCNHCTPS
Exemplo:
RG
bankAccounts
array[object (ContaBancaria) {10}] 
requerido
Lista de contas bancárias
bankCode
enum<string> 
opcional
Banco da conta.
Valores permitidos:
Banco_do_Brasil_SABanco_da_Amazonia_SABanco_do_Nordeste_do_Brasil_SABanco_Nacional_de_Desenvolvimento_Economico_e_Social_BNDESCredicoamoCSuisse_Hedging_Griffo_Cv_SA_Credit_SuisseBanco_Inbursa_SANatixis_Brasil_SA_Banco_MultiploCcm_Desp_Trans_Sc_E_RsBNY_Mellon_Banco_SABanco_Tricury_SABANESTES_SA_Banco_do_Estado_do_Espirito_SantoBanco_BANDEPE_SABanco_Alfa_SABanco_Itau_Consignado_SABanco_Santander_Brasil_SABanco_Bradesco_BBI_SABanco_do_Estado_do_Para_SABanco_Cargill_SABanco_do_Estado_do_Rio_Grande_do_Sul_SABanco_do_Estado_de_Sergipe_SABanco_de_Desenvolvimento_do_Espirito_Santo_SAConfidence_Cc_SAHipercard_Banco_Multiplo_SABanco_Bradescard_SAGoldman_Sachs_do_Brasil_Banco_Multiplo_SABanco_Andbank_Brasil_SABanco_Morgan_Stanley_SABanco_Crefisa_SABRB_Banco_de_Brasilia_SABanco_J_Safra_SABanco_ABN_AMRO_SABanco_KDB_SABanco_Inter_SAHaitong_Banco_de_Investimento_do_Brasil_SABanco_Original_do_Agronegocio_SABET_Cc_LtdaBancoSeguro_SABanco_Topazio_SABanco_da_China_Brasil_SAUniprime_Norte_do_Parana_Coop_de_Economia_eCredito_Mutuo_dos_Medicos_Profissionais_das_CienciasCooperativa_Central_de_Credito_Urbano_CECREDCcr_Reg_MogianaUnicred_Central_RsBrickell_SA_Credito_Financiamento_e_InvestimentoPolocred_Scmepp_LtdaBanco_Finaxis_SATravelex_Banco_de_Cambio_SABanco_B3_SACooperativa_Central_de_Credito_Noroeste_Brasileiro_LtdaCredialianca_CcrUNIPRIME_Central_Central_Interestadual_de_Cooperativas_de_Credito_LtdaPlanner_Corretora_De_Valores_SARenascenca_Dtvm_LtdaXp_Investimentos_SACaixa_Economica_FederalLecca_Credito_Financiamento_e_Investimento_SABanco_BOCOM_BBM_SAPortocred_SABanco_Oliveira_Trust_Dtvm_SAMagliano_SACentral_Cooperativa_De_Credito_No_Estado_Do_Espirito_SantoAdvanced_Cc_LtdaStandard_Chartered_Bank_Brasil_SA_Bco_InvestBanco_Western_Union_do_Brasil_SABanco_Rodobens_SABanco_Agibank_SABanco_Bradesco_BERJ_SABanco_Woori_Bank_do_Brasil_SAPlural_SA_Banco_MultiploBR_Partners_Banco_de_Investimento_SACodepe_Cvc_SAMS_Bank_SA_Banco_de_CambioUBS_Brasil_Banco_de_Investimento_SACaruana_ScfiTullett_Prebon_Brasil_Cvc_LtdaICBC_do_Brasil_Banco_Multiplo_SACresol_ConfederacaoBgc_Liquidez_Dtvm_LtdaMultimoney_Cc_LtdaGet_Money_Cc_LtdaIntesa_Sanpaolo_Brasil_SA_Banco_MultiploEasynvest_Titulo_Cv_SABroker_Brasil_Cc_LtdaTreviso_Corretora_de_Cambio_SABEXS_Banco_de_Cambio_SALevycam_Ccv_LtdaGuitta_Corretora_de_Cambio_LtdaFacta_SA_CfiIcap_Do_Brasil_Ctvm_LtdaCasa_Credito_SACommerzbank_Brasil_SA_Banco_MultiploBanco_Ole_Bonsucesso_Consignado_SAAlbatross_Ccv_SABRL_Trust_Distribuidora_de_Titulos_e_Valores_Mobiliarios_SAPernambucanas_Financ_SAGuide_Investimentos_SA_Corretora_de_ValoresCm_Capital_Markets_Cctvm_LtdaDacasa_Financeira_SASocred_SABanco_Itau_BBA_SAAtiva_Investimentos_SAHS_Financeira_SA_Credito_Financiamento_e_InvestimentosServicoopNova_Futura_Corretora_de_Titulos_e_Valores_Mobiliarios_LtdaParmetal_Distribuidora_de_Titulos_e_Valores_Mobiliarios_LtdaBanco_Fair_Corretora_de_Cambio_SAStone_Pagamentos_SABanco_Bradesco_Cartoes_SABanco_BTG_Pactual_SABanco_Original_SABanco_Arbi_SABanco_John_Deere_SABanco_BS2_SABanco_Credit_Agricole_Brasil_SABanco_Fibra_SABanco_Cifra_SABanco_Bradesco_SABanco_Classico_SABanco_Maxima_SABanco_ABC_Brasil_SABanco_Investcred_Unibanco_SABCV_Banco_de_Credito_e_Varejo_SABexs_Corretora_de_Cambio_SAParana_Banco_SANu_Pagamentos_SA_NubankBanco_Fator_SABanco_Cedula_SABarigui_Companhia_HipotecariaHSBC_Brasil_SA_Banco_de_InvestimentoSagitur_Corretora_de_Cambio_LtdaIB_Corretora_de_Cambio_Titulos_e_Valores_Mobiliarios_SACooperativa_de_Credito_Rural_de_Sao_Miguel_do_Oeste_SulcrediSao_MiguelBMP_MONEY_PLUSSenff_SA_Credito_Financiamento_e_InvestimentoGenial_Investimentos_Corretora_de_Valores_Mobiliarios_SACooperativa_de_Credito_Rural_de_Primavera_Do_LesteAvista_SA_Credito_Financiamento_e_InvestimentoRb_Capital_Investimentos_Dtvm_LtdaFrente_Corretora_de_Cambio_LtdaCooperativa_de_Credito_Rural_De_OuroCarol_Distribuidora_de_Titulos_e_Valor_Mobiliarios_LtdaPagseguro_Internet_SABS2_Distribuidora_de_Titulos_e_Valores_Mobiliarios_SALastro_RDV_Distribuidora_de_Titulos_e_Valores_Mobiliarios_LtdaVips_Cc_LtdaSorocred_Credito_Financiamento_e_Investimento_SABanco_de_La_Nacion_ArgentinaBpp_Instituicao_De_Pagamentos_SAVortx_Distribuidora_de_Titulos_e_Valores_Mobiliarios_LtdaBanco_BMG_SAChina_Construction_Bank_Brasil_Banco_Multiplo_SAMercado_Pago_Conta_Do_Mercado_LivreParati_Credito_Financiamento_e_Investimento_SABanco_Digio_SABanco_C6_SA_C6_BankSuper_Pagamentos_e_Administracao_de_Meios_Eletronicos_SAItau_Unibanco_SABanco_Xp_SABanco_Societe_Generale_Brasil_SABanco_CarrefourBanco_Mizuho_do_Brasil_SABanco_J_P_Morgan_SAPicPayBanco_Mercantil_do_Brasil_SABanco_Bradesco_Financiamentos_SAKirton_Bank_SA_Banco_MultiploBanco_CoraBanco_Capital_SABanco_Safra_SAPlannerBanco_MUFG_Brasil_SAUY3Banco_Sumitomo_Mitsui_Brasileiro_SABanco_Caixa_Geral_Brasil_SACitibank_NABanco_ItauBank_SADeutsche_Bank_SA_Banco_AlemaoJPMorgan_Chase_Bank_National_AssociationING_Bank_NVBanco_de_La_Republica_Oriental_del_UruguayBanco_de_La_Provincia_de_Buenos_AiresBanco_Credit_Suisse_Brasil_SASenso_Ccvm_SABanco_Luso_Brasileiro_SABanco_Industrial_do_Brasil_SABanco_VR_SABanco_Paulista_SABanco_Guanabara_SAOmni_Banco_SABanco_PAN_SABanco_Ficsa_SABanco_Smartbank_SABanco_Rendimento_SABanco_Triangulo_SABanco_Sofisa_SABanco_Alvorada_SABanco_Pine_SAItau_Unibanco_Holding_SABanco_Indusval_SABanco_AJRenner_SABanco_Votorantim_SABanco_Porto_Real_de_Investimentos_SABanco_Daycoval_SABanco_Ourinvest_SABanco_Maxinvest_SABanco_Cetelem_SABanco_Ribeirao_Preto_SABanco_Semear_SABanco_Citibank_SABanco_Modal_SABanco_Rabobank_International_Brasil_SABanco_Cooperativo_Sicredi_SAScotiabank_Brasil_SA_Banco_MultiploBanco_BNP_Paribas_Brasil_SANovo_Banco_Continental_SA_Banco_MultiploBanco_Sistema_SABank_of_America_Merrill_Lynch_Banco_Multiplo_SABanco_Cooperativo_do_Brasil_SA_BANCOOBBanco_KEB_HANA_do_Brasil_SACooperativa_Central_de_Economia_e_Credito_Mutuo_das_Unicredsde_Santa_Catarina_e_ParanaCooperativa_de_Credito_Rural_da_Regiao_da_MogianaUnicred_Central_do_Rio_Grande_do_SulCREDIALIANcA_COOPERATIVA_DE_CReDITO_RURALCentral_das_Cooperativas_de_Economia_e_Credito_Mutuo_do_Estado_do_Espirito_Santo_Ltda
Exemplo:
Banco_do_Brasil_SA
account
string 
opcional
Número da conta.
Exemplo:
9999
accountDigit
string 
opcional
Dígito da conta.
Exemplo:
9
agency
string 
opcional
Agência.
Exemplo:
99999
agencyDigit
string 
opcional
Dígito da agência.
Exemplo:
9
type
enum<string> 
opcional
Tipo da conta.
Valores permitidos:
NaturalCheckingAccountNaturalSimpleAccountLegalCheckingAccountPublicEntitiesFinancialInstitutionsDepositsNaturalSavingsAccountLegalSavingsAccountRealEstateSavingsAccountLotteryDepositsEscrowAccount
Exemplo:
NaturalCheckingAccount
jointAccount
boolean 
opcional
Conta conjunta.
Exemplo:
true
operationTypeValue
enum<string> 
requerido
Tipo da operação.
Valores permitidos:
TransferPix
Exemplo:
Transfer
pixKeyTypeValue
enum<string> 
opcional
Tipo da chave Pix.
Valores permitidos:
NaturalRegistrationNumberLegalRegistrationNumberPhoneEmailAutomaticAgencyAndAccount
Exemplo:
Phone
keyPix
string 
opcional
Número da chave Pix.
Exemplo:
99999999999
Examples

Respostas

🟢200OK
application/json
default response
Body
Retorno do cadastro de uma pessoa física.
id
string 
opcional
Identificador.
Exemplo:
1a02ca8f-71b3-4bdf-a2f7-ca0db16355f4
🟠400Pedido inválido
🟠401Não autorizado
🟠403Proibido
🟠404Registro não encontrado
🔴500Erro do servidor
Página anterior
Obter saldo
Próxima página
Cadastrar operação