Tote
InícioComece aquiAnalisaIntegra
InícioComece aquiAnalisaIntegra
  1. BNPL
  • 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
          • 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
            GET
      • 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. BNPL

Consultar informações do portador

Sandbox
https://horizon-api-sb.app.rpe.tech
Sandbox
https://horizon-api-sb.app.rpe.tech
GET
https://horizon-api-sb.app.rpe.tech
/api/v1/portadores/bnpl/consumidores/{cpfCnpj}
Consultar informações do consumidor via BNPL.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/portadores/bnpl/consumidores/?idProduto=1' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Response Response Example
200 - Informações via CPF
{
    "id": 172161,
    "status": "ATIVO",
    "cidadeNatal": "João Pessoa",
    "cpfCnpj": "21564884287",
    "tipo": "FISICA",
    "dataEmissaoRg": "1996-05-12",
    "dataNascimento": "1960-05-16",
    "dataCadastro": "2023-08-20T13:03:57-0300",
    "email": "[email protected]",
    "escolaridade": "Ensino Superior Completo",
    "estadoCivil": "SOLTEIRO",
    "estadoNatal": "PB",
    "profissao": "Engenheiro",
    "nacionalidade": "Brasileiro",
    "nome": "Maria auxiliadora da Silva",
    "nomeMae": "Adelina Santos DA Silva",
    "nomePai": "Silvio Mahoi hihi Santos",
    "ocupacao": "APOSENTADO",
    "orgaoEmissorRG": "SSPPB",
    "renda": 2020,
    "rg": "0389789-3",
    "sexo": "FEMININO",
    "vinculoEmpregaticio": false,
    "observacao": "SMILEGO - 16/11/2023, 10:47:\nCadastro a vulso de consumidor",
    "tributacaoValor": 0,
    "faturamentoValor": 0,
    "limite": 0,
    "limiteParcelas": 0,
    "limiteDisponivel": 0,
    "limiteConsumido": 0,
    "dataValidadeProposta": "2024-07-30T18:19:46-0300",
    "idProdutoAtivo": 1,
    "enderecoResidencial": {
        "id": 172255,
        "bairro": "Centro",
        "cep": "69010000",
        "complemento": "Casa",
        "localidade": "Manaus",
        "logradouro": "Avenida Eduardo Ribeiro",
        "numero": "17",
        "uf": "AM"
    },
    "conjuge": {
        "id": 1,
        "cpf": "08293388870",
        "dataEmissaoRg": "2025-04-22",
        "dataNascimento": "2000-04-22",
        "nome": "Dona Lisbela",
        "orgaoEmissor": "SSPPB",
        "rg": "212956516",
        "sexo": "FEMININO",
        "telefone": {
            "id": 1,
            "area": "83",
            "ramal": "02",
            "telefone": "998660633",
            "tipo": "CELULAR",
            "sms": true
        }
    },
    "telefoneList": [
        {
            "id": 173982,
            "area": "92",
            "telefone": "985901897",
            "tipo": "CELULAR",
            "sms": true
        }
    ],
    "consumidorReferenciaList": [
        {
            "id": 26593,
            "grauParentesco": "IRMA",
            "nome": "LURDE",
            "telefone": {
                "id": 173984,
                "area": "92",
                "telefone": "994114118",
                "tipo": "CELULAR",
                "sms": true
            }
        },
        {
            "id": 214276,
            "grauParentesco": "FILHO",
            "nome": "Andre",
            "telefone": {
                "id": 1249621,
                "area": "92",
                "telefone": "992463277",
                "tipo": "CELULAR",
                "sms": false
            }
        }
    ],
    "consumidorSocioList": [],
    "diasDeAtraso": 0,
    "classificador": {
        "id": 9,
        "descricao": "PLATINUM"
    },
    "dependenteList": [
        {
            "idDependente": 3,
            "nome": "Mariazinha MOCK",
            "cpfDependente": "84743133092",
            "status": "ATIVO",
            "area": "83",
            "telefone": "991873707",
            "cpfConsumidor": "21564884287"
        }
    ]
}

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Path
cpfCnpj
string 
requerido
CPF ou CNPJ do consumidor, sem pontuação.
Exemplo:
2156488428750208762000156
Parâmetros Query
idProduto
integer <int32>
opcional
Identificador do produto.
Exemplo:
1
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

Respostas

🟢200Success
application/json
Body
id
integer <int32>
opcional
Identificador do consumidor.
Exemplo:
2001
status
enum<string> 
opcional
Status do consumidor.
Valores permitidos:
ATIVOBLOQUEADOCANCELADO
Exemplo:
ATIVO
cidadeNatal
string 
opcional
Cidade natal do consumidor. Retornado apenas quando tipo = FISICA.
Exemplo:
João Pessoa
cpfCnpj
string 
opcional
CPF ou CNPJ do consumidor.
Exemplo:
63953837010
tipo
enum<string> 
opcional
Tipo do consumidor (pessoa física ou pessoa jurídica).
Valores permitidos:
FISICAJURIDICA
Exemplo:
FISICA
dataEmissaoRg
string <date>
opcional
Data de emissão da carteira de identidade nacional, no formato YYYY-MM-DD. Retornado apenas quando tipo = FISICA.
Exemplo:
2016-05-02
dataNascimento
string <date>
opcional
Data de nascimento do consumidor, no formato YYYY-MM-DD.
Exemplo:
1996-05-02
dataCadastro
string <date-time>
opcional
Data e hora de cadastro do consumidor.
Exemplo:
2024-07-30T18:19:46-0300
email
string 
opcional
Email para contato com o consumidor.
Exemplo:
[email protected]
escolaridade
string 
opcional
Grau de escolaridade do consumidor. Retornado apenas quando tipo = FISICA.
Exemplo:
Ensino Superior Completo
estadoCivil
enum<string> 
opcional
Estado civil do consumidor. Retornado apenas quando tipo = FISICA.
Valores permitidos:
CASADOSOLTEIROVIUVOSEPARADODIVORCIADOUNIAO_ESTAVELDESQUITADOCONCUBINATOOUTRO
Exemplo:
CASADO
estadoNatal
string 
opcional
Estado natal do consumidor.
Exemplo:
PB
profissao
string 
opcional
Profissão do consumidor. Retornado apenas quando tipo = FISICA.
Exemplo:
Engenheiro
nacionalidade
string 
opcional
Nacionalidade do consumidor. Retornado apenas quando tipo = FISICA.
Exemplo:
Brasileiro
nome
string 
opcional
Nome do consumidor. Retornado apenas quando tipo = FISICA.
Exemplo:
João Silva
nomeMae
string 
opcional
Nome da mãe do consumidor. Retornado apenas quando tipo = FISICA.
Exemplo:
Maria Silva
nomePai
string 
opcional
Nome do pai do consumidor. Retornado apenas quando tipo = FISICA.
Exemplo:
José Silva
ocupacao
string 
opcional
Ocupação do consumidor. Retornado apenas quando tipo = FISICA.
Exemplo:
Professor
orgaoEmissorRG
string 
opcional
Orgão emissor da carteira de identidade nacional. Retornado apenas quando tipo = FISICA.
Exemplo:
SSPPB
renda
number 
opcional
Valor da renda do consumidor. Retornado apenas quando tipo = FISICA.
Exemplo:
1400
rg
string 
opcional
Número da carteira de identidade nacional. Retornado apenas quando tipo = FISICA.
Exemplo:
456700043
sexo
string 
opcional
Sexo do consumidor. Retornado apenas quando tipo = FISICA.
Exemplo:
MASCULINO
vinculoEmpregaticio
boolean 
opcional
Indica se possui vínculo empregatício.
Exemplo:
true
observacao
string 
opcional
Observações sobre o processo de cadastro do consumidor.
Exemplo:
Cadastro sem problemas.
cargoSolicitante
string 
opcional
Cargo do solicitante do cadastro da empresa.
Exemplo:
CFO
razaoSocial
string 
opcional
Razão social da empresa solicitante.
Exemplo:
RPE
tributacaoTipo
string 
opcional
Tipo de tributação da empresa.
Exemplo:
Simples NacionalLucro PresumidoLucro RealMEI
atividadePrimaria
string 
opcional
Tipo de atividade primária da empresa.
Exemplo:
Prestação de serviços
responsavelFinanceiro
string 
opcional
Nome do responsável financeiro da empresa.
Exemplo:
Maria Silva
faturamentoData
string <date>
opcional
Data de faturamento da emrpesa, no formato YYYY-MM-DD.
Exemplo:
2024-07-09
tributacaoValor
number 
opcional
Valor da tributação da empresa.
Exemplo:
10
faturamentoValor
number 
opcional
Valor do faturamento da empresa,
Exemplo:
20000000
inscricaoEstadual
string 
opcional
Inscrição estadual da empresa, sem pontuação.
Exemplo:
S4450
limite
number 
opcional
Limite do consumidor.
Exemplo:
2000
limiteParcelas
integer 
opcional
Limite do parcelamento.
Exemplo:
2
limiteDisponivel
integer 
opcional
Limite disponível para o consumidor.
Exemplo:
1000
limiteConsumido
integer 
opcional
Limite consumido pelo consumidor.
Exemplo:
1000
dataValidadeProposta
string <date-time>
opcional
Data de validade da proposta.
Exemplo:
2024-07-30T18:19:46-0300
idProdutoAtivo
integer <int64>
opcional
Identificador do produto ativo.
Exemplo:
1
enderecoResidencial
object 
opcional
Informações sobre o endereço residencial do consumidor.
id
integer <int64>
opcional
Identificador do endereço.
Exemplo:
2
bairro
string 
opcional
Bairro.
Exemplo:
Centro
cep
string 
opcional
Código postal, com 8 dígitos e sem pontuação.
Exemplo:
58000000
cnpj
string 
opcional
CNPJ, com 14 dígitos e sem pontuação. Retornado apenas quando tipo = JURIDICA.
Exemplo:
23429946000173
complemento
string 
opcional
Complemento do endereço.
Exemplo:
Casa
departamento
string 
opcional
Departamento da empresa. Retornado apenas quando tipo = JURIDICA.
Exemplo:
Secretaria
empresa
string 
opcional
Nome da empresa. Retornado apenas quando tipo = JURIDICA.
Exemplo:
RPE
localidade
string 
opcional
Cidade.
Exemplo:
João Pessoa
logradouro
string 
opcional
Endereço.
Exemplo:
Avenida Luis Sousa
numero
string 
opcional
Número.
Exemplo:
13
uf
string 
opcional
Unidade federativa.
Exemplo:
PB
conjuge
object 
opcional
Informações sobre o cônjuge do consumidor. Retornado apenas quando tipo = FISICA.
id
integer <int64>
opcional
Identificador do cônjuge.
Exemplo:
1
cpf
string 
opcional
CPF do cônjuge, com 11 dígitos e sem pontuação.
Exemplo:
8764092346
dataEmissaoRg
string 
opcional
Data de emissão da carteira de identidade nacional, no formato YYYY-MM-DD.
Exemplo:
2024-09-17
dataNascimento
string <date>
opcional
Data de nascimento do cônjuge, no formato YYYY-MM-DD.
Exemplo:
1988-11-27
nome
string 
opcional
Nome do cônjuge.
Exemplo:
Maria Sousa
orgaoEmissor
string 
opcional
Orgão emissor da carteira de identidade nacional.
Exemplo:
SSPPB
rg
string 
opcional
Número da carteira de identidade nacional do cônjuge, sem pontuação.
Exemplo:
212874233
sexo
string 
opcional
Sexo do cônjuge.
Exemplo:
FEMININO
telefone
object 
opcional
Informações de telefone do cônjuge.
telefoneList
array [object {6}] 
opcional
Informações de telefone do consumidor.
id
integer <int64>
opcional
Identificador do telefone.
Exemplo:
1
area
string 
opcional
DDD do telefone.
Exemplo:
84
ramal
string 
opcional
Ramal, se disponível.
Exemplo:
01
telefone
string 
opcional
Número de telefone, sem pontuação.
Exemplo:
988764502
tipo
enum<string> 
opcional
Tipo do telefone.
Valores permitidos:
CELULARRESIDENCIALCOMERCIALOUTRO
Exemplo:
CELULAR
sms
boolean 
opcional
Indica se recebe SMS.
Exemplo:
true
consumidorReferenciaList
array [object {4}] 
opcional
Informações sobre contato de referência. Retornado apenas quando tipo = FISICA.
id
integer <int64>
opcional
Identificador da referência.
Exemplo:
1
grauParentesco
string 
opcional
Grau de parentesco da referência com o consumidor.
Exemplo:
Filho
nome
string 
opcional
Nome da referência.
Exemplo:
José Sousa
telefone
object 
opcional
Informações de telefone da pessoa de referência.
consumidorSocioList
array [object {12}] 
opcional
Informações sobre sócios. Retornado apenas quando tipo = JURIDICA.
id
integer <int64>
opcional
Identificador do sócio.
Exemplo:
1
cargo
string 
opcional
Cargo do sócio.
Exemplo:
CFO
nome
string 
opcional
Nome do sócio.
Exemplo:
Ana Silva
cpf
string 
opcional
CPF do sócio, com 11 dígitos e sem pontuação.
Exemplo:
08075623490
sexo
string 
opcional
Sexo do sócio.
Exemplo:
FEMININO
nacionalidade
string 
opcional
Nacionalidade do sócio.
Exemplo:
Brasileiro
estadoCivil
string 
opcional
Estado civil do sócio.
Exemplo:
VIUVO
rg
string 
opcional
Número da carteira de identidade nacional, sem pontuação.
Exemplo:
222989765
orgaoEmissorRG
string 
opcional
Orgão emissor da carteira de identidade nacional.
Exemplo:
SSPPB
uf
string 
opcional
Unidade federativa.
Exemplo:
RN
cidadeNatal
string 
opcional
Cidade natal do sócio.
Exemplo:
Natal
dataNascimento
string 
opcional
Data de nascimento do sócio, no formato YYYY-MM-DD.
Exemplo:
1988-09-18
diasDeAtraso
integer <int32>
opcional
Dias de atraso.
Exemplo:
0
idClassificador
integer <int64>
opcional
Identificador do classificador do consumidor.
Exemplo:
1
classificador
object 
opcional
Informações do classificador.
id
integer <int64>
opcional
Identificador do classificador.
Exemplo:
1
descricao
string 
opcional
Descrição do classificador.
Exemplo:
SEM CLASSIFICACAO
dependenteList
array [object {7}] 
opcional
Informações sobre pessoas dependentes.
idDependente
integer <int64>
opcional
Identificador da pessoa dependente.
Exemplo:
1
nome
string 
opcional
Nome da pessoa dependente.
Exemplo:
Maria Silva
cpfDependente
string 
opcional
CPF da pessoa pendente, com 11 dígitos e sem pontuação.
Exemplo:
87865732410
status
enum<string> 
opcional
Status da pessoa dependente.
Valores permitidos:
ATIVOCANCELADO
Exemplo:
ATIVO
area
string 
opcional
DDD do telefone da pessoa dependente.
Exemplo:
88
telefone
string 
opcional
Número de telefone da pessoa dependente.
Exemplo:
989874563
cpfConsumidor
string 
opcional
CPF do consumir, com 11 dígitos e sem pontuação.
Exemplo:
45487809345
🟠400Pedido inválido
🟠401Não autorizado
🟠403Proibido
🟠404Registro não encontrado
🔴500Erro do servidor
Página anterior
Listar ocupações
Próxima página
Portuno