Tote
InícioComece aquiAnalisaIntegra
InícioComece aquiAnalisaIntegra
  1. Conta Digital
  • 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
          • 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
            GET
          • Cadastrar termo obrigatório
            POST
          • Cadastrar documento do portador
            POST
          • Criar uma conta digital
            POST
          • Criar uma conta alias
            POST
          • Listar contas pelo identificador
            GET
          • Listar informações do portador
            GET
        • 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. Conta Digital

Criar uma conta digital

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/pixcard/contas/pessoa
Use este endpoint para criar uma conta digital para uma pessoa portadora.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/pixcard/contas/pessoa' \
--header 'Accept: */*' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Seyia de Pegaso",
    "preferredName": "Seyia",
    "motherName": "Saori Kido",
    "birthDate": "1985-12-09",
    "gender": "M",
    "document": "03967703045",
    "emancipatedMinor": false,
    "idNumber": "6537265",
    "printedName": "SEIYA PEGASO",
    "identityIssuingEntity": "SSP",
    "federativeUnit": "SP",
    "issuingDateIdentity": "2000-02-01",
    "idMaritalStatus": 1,
    "idProfession": "1",
    "idOccupationType": 1,
    "idNationality": 1,
    "fatherName": "Matsumada Kido",
    "bankNumber": 999,
    "branchNumber": 29999,
    "accountNumber": "99999999",
    "email": "[email protected]",
    "companyName": "teste",
    "idBusinessSource": 1,
    "idProduct": 1,
    "dueDate": 10,
    "incomeValue": 999,
    "isPep": false,
    "isPepSince": "2019-09-09",
    "address": {
        "id": 3,
        "idAddressType": 1,
        "zipCode": "6800000",
        "street": "Rua da Amizade",
        "number": 23,
        "complement": "apartamento 01",
        "neighborhood": "Patos",
        "city": "João Pessoa",
        "federativeUnit": "PB",
        "country": "Brasil",
        "mailingAddress": false
    },
    "phone": {
        "id": 4,
        "idPhoneType": 1,
        "areaCode": "21",
        "number": "999876543"
    },
    "termsAndConditionsTokens": [
        "e8b90f67-09a8-428e-bab5-d6f271128b5b",
        "0229ad42-2fef-41eb-ba10-d7ebca5f70c0"
    ],
    "deviceIdentification": {
        "fingerprint": "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:12.0) Gecko/20100101 Firefox/12.0#1.160.10.240"
    }
}'
Response Response Example
201 - Example 1
{
    "id": 12,
    "name": "Seyia de Pegaso",
    "preferredName": "Seyia",
    "motherName": "Saori Kido",
    "birthDate": "1985-12-09",
    "document": "03967703045",
    "fatherName": "Matsumada Kido",
    "gender": "M",
    "idNumber": "190525071",
    "identityIssuingEntity": "SSP",
    "federativeUnit": "SP",
    "issuingDateIdentity": "2000-02-01",
    "idMaritalStatus": 1,
    "idProfession": "1",
    "idOccupationType": 1,
    "idNationality": 1,
    "branchNumber": 999,
    "accountNumber": "99999999",
    "email": "[email protected]",
    "companyName": "teste",
    "idBusinessSource": 1,
    "idProduct": 1,
    "idAccount": 1,
    "dueDate": "10",
    "printedName": "Seyia Pegaso",
    "incomeValue": 1000,
    "address": {
        "id": 3,
        "idAddressType": 1,
        "zipCode": "6800000",
        "street": "Rua da Amizade",
        "number": 23,
        "complement": "apartamento 01",
        "neighborhood": "Patos",
        "city": "João Pessoa",
        "federativeUnit": "PB",
        "country": "Brasil",
        "mailingAddress": true
    },
    "phone": {
        "id": 4,
        "idPhoneType": 1,
        "areaCode": "21",
        "number": "999876543"
    },
    "registrationId": "098u909",
    "status": "WAITING_DOCUMENTS",
    "isPep": true,
    "isPepSince": "2019-09-09"
}

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
Accept
string 
requerido
Tipo de conteúdo aceito.
Exemplo:
*/*
Content-Type
string 
opcional
Tipo de mídia do corpo da solicitação.
Exemplo:
application/json
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
Parâmetros Bodyapplication/json
name
string 
requerido
Nome da pessoa portadora.
<= 100 Caracteres
Exemplo:
Seyia de Pegaso
preferredName
string 
requerido
Nome de preferência.
<= 100 Caracteres
Exemplo:
Seyia
motherName
string 
requerido
Nome da mãe.
<= 80 Caracteres
Exemplo:
Saori Kido
birthDate
string <date>
requerido
Data de nascimento, no formato YYYY-MM-DD.
>= 10 Caracteres<= 10 Caracteres
Exemplo:
1985-12-09
gender
enum<string> 
requerido
Gênero.
M = masculino
F = feminino
Valores permitidos:
MF
Exemplo:
M
document
string 
requerido
Documento de identificação cadastrado.
>= 11 Caracteres<= 11 Caracteres
Exemplo:
03967703045
emancipatedMinor
boolean 
requerido
Indica se é uma pessoa menor de idade emancipada.
Padrão:
false
idNumber
string 
opcional
Número do registro civil (RG) do portador.
<= 18 Caracteres
Exemplo:
6537265
printedName
string 
opcional
Nome impresso.
<= 21 Caracteres
Exemplo:
SEIYA PEGASO
identityIssuingEntity
string 
requerido
Entidade emissora do documento.
<= 6 Caracteres
Exemplo:
SSP
federativeUnit
string 
opcional
Unidade federativa.
<= 2 Caracteres
Exemplo:
SP
issuingDateIdentity
string <date>
opcional
Data de emissão do documento, no formato YYYY-MM-DD.
>= 10 Caracteres<= 10 Caracteres
Exemplo:
2000-02-01
idMaritalStatus
enum<integer> 
requerido
Identificador do estado civil.
1 = Pessoa solteira
2 = Pessoa casada
3 = Em separação judicial
4 = Pessoa viúva
5 = Pessoa divorciada
6 = Em união estável
7 = Pessoa separada
Valores permitidos:
1234567
Exemplo:
1
idProfession
string 
requerido
Identificador da profissão.
<= 40 Caracteres
Exemplo:
1
idOccupationType
enum<integer> 
requerido
Identificador do tipo de ocupação.
1 = Pessoa aposentada
2 = Com vínculo empregatício
3 = Profissional liberal
4 = Profissional autônomo(a)
5 = Outros
Valores permitidos:
12345
Exemplo:
1
idNationality
enum<integer> 
requerido
Identificador da nacionalidade.
1= Brasileiro(a)
2 = Estrangeiro(a)
Se documento cadastrado for RNE_FRONT e RNE_VERSE, idNationality = 2.
Valores permitidos:
12
Exemplo:
1
fatherName
string 
requerido
Nome do pai.
<= 100 Caracteres
Exemplo:
Matsumada Kido
bankNumber
integer <int32>
requerido
Número do banco.
Exemplo:
999
branchNumber
integer <int32>
requerido
Número da agência.
<= 32767
Exemplo:
29999
accountNumber
string 
requerido
Número da conta bancária.
<= 15 Caracteres
Exemplo:
99999999
email
string 
requerido
E-mail válido.
<= 50 Caracteres
Exemplo:
[email protected]
companyName
string 
requerido
Nome da empresa.
<= 50 Caracteres
Exemplo:
teste
idBusinessSource
integer <int32>
requerido
Identificador da origem comercial.
Exemplo:
1
idProduct
integer <int32>
requerido
Identificador do produto.
Exemplo:
1
dueDate
integer <int32>
requerido
Data de validade.
Exemplo:
10
incomeValue
integer <int32>
requerido
Valor do salário.
Exemplo:
999
isPep
boolean 
requerido
Indica se é uma pessoa politicamente exposta.
Padrão:
false
isPepSince
string 
requerido
Data que a pessoa se tornou exposta politicamente.
Exemplo:
2019-09-09
address
object 
opcional
Informações sobre endereço.
id
integer <int32>
opcional
Identificador do endereço.
Exemplo:
3
idAddressType
enum<integer> 
opcional
Identificador do tipo de endereço.
1 = Próprio
2 = Alugado
3 = Financiado
4 = Empresa/espaço funcional
Valores permitidos:
1234
Exemplo:
4
zipCode
string 
opcional
Código postal.
<= 8 Caracteres
Exemplo:
6800000
street
string 
opcional
Rua.
>= 1 Caracteres<= 100 Caracteres
Exemplo:
Rua da Amizade
number
integer <int32>
opcional
Número.
<= 0
Exemplo:
23
complement
string 
opcional
Complemento.
<= 30 Caracteres
Exemplo:
apartamento 01
neighborhood
string 
opcional
Bairro.
>= 1 Caracteres<= 80 Caracteres
Exemplo:
Patos
city
string 
opcional
Cidade.
<= 60 Caracteres
Exemplo:
João Pessoa
federativeUnit
string 
opcional
Unidade federativa.
<= 2 Caracteres
Exemplo:
PB
country
string 
opcional
País.
<= 20 Caracteres
Exemplo:
Brasil
mailingAddress
boolean 
opcional
Endereço postal.
Padrão:
false
phone
object 
requerido
Informações sobre telefone.
id
integer <int32>
opcional
Identificador do telefone.
Exemplo:
4
idPhoneType
enum<integer> 
opcional
Identificador do tipo de telefone.
1 = Residencial
2 = Contato
3 = Cônjuge
4 = Referência 1
5 = Referência 2
13 = Número de coleção
17 = Adicional
18 = Celular
Valores permitidos:
12345131718
Exemplo:
1
areaCode
string 
opcional
Código de área.
<= 3 Caracteres
Exemplo:
21
number
string 
opcional
Número de telefone.
>= 8 Caracteres<= 9 Caracteres
Exemplo:
999876543
termsAndConditionsTokens
array[string]
requerido
Tokens dos documentos obrigatórios (política de privacidade e termos de uso).
Exemplo:
["e8b90f67-09a8-428e-bab5-d6f271128b5b","0229ad42-2fef-41eb-ba10-d7ebca5f70c0"]
deviceIdentification
object 
requerido
Identificação do dispositivo.
fingerprint
string 
requerido
Digital do dispositivo.
Exemplo:
Mozilla/5.0 (Windows NT 6.1; WOW64; rv:12.0) Gecko/20100101 Firefox/12.0#1.160.10.240
Examples

Respostas

🟢201Criado
application/json
Sucesso
Body
id
integer <int32>
opcional
Identificador da pessoa cadastrada.
Exemplo:
12
name
string 
opcional
Nome da pessoa cadastrada.
<= 100 Caracteres
Exemplo:
Seyia de Pegaso
preferredName
string 
opcional
Nome preferencial.
<= 100 Caracteres
Exemplo:
Seyia
motherName
string 
opcional
Nome da mãe.
<= 80 Caracteres
Exemplo:
Saori Kido
birthDate
string <date>
opcional
Data de nascimento.
>= 10 Caracteres<= 10 Caracteres
Exemplo:
1985-12-09
document
string 
opcional
Documento de identificação.
>= 11 Caracteres<= 11 Caracteres
Exemplo:
03967703045
fatherName
string 
opcional
Nome do pai.
<= 100 Caracteres
Exemplo:
Matsumada Kido
gender
string 
opcional
Gênero.
Exemplo:
M
idNumber
string 
opcional
Número do registro civil (RG) do portador.
<= 18 Caracteres
Exemplo:
190525071
identityIssuingEntity
string 
opcional
Entidade emissora do documento.
<= 6 Caracteres
Exemplo:
SSP
federativeUnit
string 
opcional
Unidade federativa.
<= 2 Caracteres
Exemplo:
SP
issuingDateIdentity
string 
opcional
Data de emissão do documento.
>= 10 Caracteres<= 10 Caracteres
Exemplo:
2000-02-01
idMaritalStatus
enum<integer> 
opcional
Identificador do estado civil.
1 = Pessoa solteira
2 = Pessoa casada
3 = Em separação judicial
4 = Pessoa viúva
5 = Pessoa divorciada
6 = Em união estável
7 = Pessoa separada
Valores permitidos:
1234567
Exemplo:
1
idProfession
string 
opcional
Identificador da profissão.
<= 40 Caracteres
Exemplo:
1
idOccupationType
enum<integer> 
opcional
Identificador do tipo de ocupação.
1 = Pessoa aposentada
2 = Com vínculo empregatício
3 = Profissional liberal
4 = Profissional autônomo(a)
5 = Outros
Valores permitidos:
12345
Exemplo:
1
idNationality
enum<integer> 
opcional
Identificador da nacionalidade.
1= Brasileiro(a)
2 = Estrangeiro(a)
Se documento cadastrado for RNE_FRONT e RNE_VERSE, idNationality = 2.
Valores permitidos:
12
Exemplo:
1
branchNumber
integer <int32>
opcional
Número da agência.
<= 5
Exemplo:
999
accountNumber
string 
opcional
Número da conta.
<= 15 Caracteres
Exemplo:
99999999
email
string 
opcional
E-mail válido.
<= 50 Caracteres
Exemplo:
[email protected]
companyName
string 
opcional
Nome da empresa.
Exemplo:
teste
idBusinessSource
integer <int32>
opcional
Identificador da origem comercial.
Exemplo:
1
idProduct
integer <int32>
opcional
Identificador do produto.
Exemplo:
1
idAccount
integer <int32>
opcional
Identificador da conta.
Exemplo:
1
dueDate
string 
opcional
Data de validade.
Exemplo:
10
printedName
string 
opcional
Nome impresso no cartão.
Exemplo:
Seyia Pegaso
incomeValue
integer <int32>
opcional
Valor do salário.
Campo obrigatório se usuário tiver uma conta alias.
Exemplo:
1000
address
object 
opcional
Informações de endereço.
id
integer <int32>
opcional
Identificador do endereço.
Exemplo:
3
idAddressType
enum<integer> 
opcional
Identificador do tipo de endereço.
1 = Próprio
2 = Alugado
3 = Financiado
4 = Empresa/espaço funcional
Valores permitidos:
1234
Exemplo:
4
zipCode
string 
opcional
Código postal.
Exemplo:
6800000
street
string 
opcional
Rua.
Exemplo:
Rua da Amizade
number
integer <int32>
opcional
Número.
Exemplo:
23
complement
string 
opcional
Complemento.
Exemplo:
apartamento 01
neighborhood
string 
opcional
Bairro.
Exemplo:
Patos
city
string 
opcional
Cidade.
Exemplo:
João Pessoa
federativeUnit
string 
opcional
Unidade federativa.
Exemplo:
PB
country
string 
opcional
País.
Exemplo:
Brasil
mailingAddress
boolean 
opcional
Indica se o endereço informado é também o postal.
Exemplo:
true
phone
object 
opcional
Informações sobre telefone.
id
integer <int32>
opcional
Identificador do telefone.
Exemplo:
4
idPhoneType
enum<integer> 
opcional
Identificador do tipo de telefone.
1 = Residencial
2 = Contato
3 = Cônjuge
4 = Referência 1
5 = Referência 2
13 = Número de coleção
17 = Adicional
18 = Celular
Valores permitidos:
12345131718
Exemplo:
1
areaCode
string 
opcional
Código de área.
Exemplo:
21
number
string 
opcional
Número de telefone.
Exemplo:
999876543
registrationId
string 
opcional
Código de cadastro da pessoa portadora.
Exemplo:
098u909
status
enum<string> 
opcional
Status do cadastro da conta.
WAITING_DOCUMENTS = aguardando documentação
WAITING_ANALYSIS = aguardando análise
ACTIVE = conta ativa
DECLINED = conta recusada
CANCELED = conta cancelada
Valores permitidos:
WAITING_DOCUMENTSWAITING_ANALYSISACTIVEDECLINEDCANCELED
Exemplo:
WAITING_DOCUMENTS
isPep
boolean 
opcional
Indica se é uma pessoa exposta politicamente.
Padrão:
true
isPepSince
string <date-time>
opcional
Data que a pessoa se tornou exposta politicamente.
Exemplo:
2022-12-14T12:05:39.502Z
🟠400Pedido inválido
🟠401Não autorizado
🟠403Proibido
🟠404Registro não encontrado
🔴500Erro do servidor
Página anterior
Cadastrar documento do portador
Próxima página
Criar uma conta alias