iBaaS
  1. Account
iBaaS
  • iBaaS
    • v1
      • Authentication
        • login webhooks
        • login
        • refresh
        • logout
      • BaaS
        • Account
          • create-description
          • Occupations
            • list
          • retrieve-from-provider
            • by-account-number
            • by-account-id
          • migrate-account
            • import-csv
            • list-account-migrated
            • create-account-in-matera
            • list-account-migration-logs
            • cancel-account
          • create
            POST
          • update
            PUT
          • search
            POST
          • find
            GET
          • find-by-account-number
            GET
          • find-by-tax-id-number
            GET
          • get-balance
            GET
          • get-statement
            GET
          • inactivate
            DELETE
          • get-file
            GET
        • Cash In
          • make-pix-static-qr-code
          • make-pix-dynamic-qr-code
          • make-bank-slip
          • make-billing-slip
          • make-deposit
        • Cash Out
          • make-pix-transfer
          • make-pix-transfer-only-with-alias
          • make-non-priority-pix-transfer
          • make-bank-transfer
          • make-bank-slip-payment
          • make-utilities-payment
          • make-internal-transfer
          • return-internal-transfer
        • Transactions
          • get-transaction
          • get-withdraw
          • get-bank-slip-by-bar-code
          • lock-balance
          • unlock-balance
          • initiate-ted
        • Pix
          • Aliases
            • Portabilidade de Alias (Chave)
            • list
            • exclude
            • create
            • alias-verification-code
            • get-destination-alias
            • alias-portability
            • alias-portability-confirmation
            • alias-portability-cancellation
            • alias-ownership-claims
            • alias-ownership-claims-responses
            • alias-ownership-claims-cancellation
          • Med
            • iBass
              • search
              • create
              • cancel
            • list
            • search
            • find
            • create
            • sent
            • in_analysis
            • approved
            • rejected
            • cancel
            • situation-types
            • med-types
            • med-status
          • Automatic
            • Recurrence
              • List Recurrences
              • Detail Recurrence
              • Authorize Recurrence
              • Save Recurrence With Authorization
            • Billing
              • Cancel Billing Scheduled
              • List Billings Scheduled
          • get-limits
          • return-codes
          • get-participants
          • returns
          • decode-qr-code
          • text-to-qr-code
        • Cellphone Recharge
          • get-carriers
          • get-avaliable-values
          • recharge
        • Webhook
          • set-accounts-webhook
        • Limits
          • get-limits
          • request-limit-update
          • search-update-limit-requests
          • process-limit-update
        • Batches and Billings
          • Charge Report
            • generate-pdf
            • search
          • billing-slip-payers
            • search-by
            • list
            • create
            • find
            • update
            • delete
            • search
          • validate-shipment
          • shipment_file
          • send-shipment-with-json
          • download-return-file-batch-id
          • download-return-file-period
          • get-batches
          • get-batch
          • get-billings
          • get-billing
        • receipt-of-bills
          • Mudar status boleto (dev)
        • Dock
          • Catalog
            • document
          • Onboarding
            • setup-types
            • schema-and-business
            • product-processes
            • update-account
            • reg-docs
            • agree-reg-docs
            • start-instance
            • file-upload
            • pending-files
            • customer-process
            • client-proposal
            • Endpoint Sem Título
          • Account
            • get-account
            • update-status
            • list-account-entries
          • Account Manager
            • list-alias-via-account-identifier
            • create-banking-account
            • delete-banking-account
          • Pay
            • search-transfers
            • get-transfer
            • initiate-transfer
            • cancel-scheduled-transfer
          • Pix
            • create-dict-key
            • search-dicts
            • search-payments
            • send-payment
            • validate-dict
            • delete-dict-key
            • get-payment
      • Public Routers
        • validate-cnab400
  • Enums
    • PhysicalBusinessLineEnum
    • LegalBusinessLIneEnum
    • EstablishmentFormEnum
    • FinancialStatisticEnum
    • CountryEnum
    • AccountStatusEnum
    • DocumentsTypeEnum
    • MaritalStatusEnum
    • TestDataTableForPaymentSlips
    • CollectionWalletEnum
    • FineCodeEnum
    • RegistrationTypeEnum
    • Boletos
      • BillingSlipOriginTypeEnum
      • BatchBillingSlipFileTypeEnum
      • BillingSlipStatusEnum
      • OccurrenceCodeEnum
      • TitleTypeEnum
  • Esquemas
    • External Events
      • BaaS Dock
    • Ramos de Atividade
  1. Account

create-description

Fluxo de Cadastro e KYC#

O processo de cadastro de uma conta deve seguir todas as etapas corretamente para garantir a conformidade com o KYC (Know Your Customer). Após a criação da conta, o sistema de KYC valida as informações fornecidas e retorna o status da conta via webhook, conforme o resultado. Abaixo, detalhamos as etapas do fluxo e os possíveis status pelos quais a conta do cliente pode passar, incluindo as notificações via webhook.

Status da Conta#

StatusDescrição
REGISTERA conta foi registrada e está aguardando a validação pelo KYC.
VALIDATINGA conta está sendo validada pelo KYC para garantir que todas as informações estão corretas e em conformidade.
VALIDATEDA conta foi validada e está pronta para continuar o processo de criação.
PROCESSINGA conta está sendo configurada no sistema.
APPROVEDA conta foi aprovada e está totalmente funcional.
REJECTEDA abertura foi rejeitada por inconsistências nos dados. O cliente pode corrigir as informações e reenviar.
DENIEDO KYC não autorizou a abertura da conta. Este é um status final, sem possibilidade de reenvio. A conta fica bloqueada por um determinado tempo e qualquer tentativa de abertura de conta será automaticamente negada pelo KYC.
DISABLEDA conta foi desativada, mas pode ser reativada, se necessário.
BLOCKEDA conta foi bloqueada e o acesso está impedido até que o problema seja resolvido.

Notificações via Webhook#

Para configurar um novo webhook para notificações, utilize o endpoint set-accounts-webhook disponível nesta documentação.

Opções de Cadastro de Cliente#

Durante o cadastro, o cliente pode escolher entre três modalidades de conta, conforme seu perfil:
1.
Pessoa Física (PF) — Cadastro de indivíduos, com base no CPF e documentos pessoais.
2.
Pessoa Jurídica (PJ) — Cadastro de empresas, incluindo documentos como o Contrato Social e outros dados corporativos.
O processo de aprovação varia de acordo com o tipo de cadastro e as informações fornecidas. Recomendamos que todos os dados sejam preenchidos corretamente para evitar atrasos ou rejeições no KYC. Caso haja rejeição, é possível reenviar os dados corrigidos para nova análise.

Regras Gerais#

Campos em comum
CampoTipoDescriçãoRegras
namestringNome completo do titular da conta.Obrigatório.
taxid_numberstringNúmero de CPF ou CNPJ do cliente.Obrigatório. Deve ser único no sistema e seguir o formato de CPF ou CNPJ.
mobile_phonestringNúmero de telefone celular do cliente.Obrigatório.
mobile_phone_countrystringCódigo do país do telefone celular.Obrigatório. Validado com a enumeração CountryEnum.
emailstringEndereço de e-mail do cliente.Obrigatório. Deve ser um e-mail válido.
addressarrayInformações de endereço.Obrigatório.
address.streetstringNome da rua.Obrigatório.
address.numberstringNúmero da residência.Obrigatório.
address.complementstringComplemento do endereço.Opcional.
address.districtstringBairro.Obrigatório.
address.citystringCidade.Obrigatório.
address.statestringEstado.Obrigatório.
address.zip_codestringCEP.Obrigatório.
address.countrystringPaís.Obrigatório. Validado com a enumeração CountryEnum.
documentsarrayLista de documentos enviados.Obrigatório.
documents.*.typestringTipo do documento.Obrigatório. Validado com a enumeração DocumentsTypeEnum.
documents.*.contentstringConteúdo do documento codificado em Base64.Obrigatório.
custom_dataarrayDados personalizados que podem ser enviados como informações adicionais.Opcional.
custom_data.latitudestringLatitude.Opcional.
custom_data.longitudestringLongitude.Opcional.
Pessoa Física
CampoTipoDescriçãoRegras
physical_detailarrayDetalhes físicos da pessoa.Obrigatório.
physical_detail.social_namestringNome social.Opcional.
physical_detail.father_namestringNome do pai.Opcional.
physical_detail.mother_namestringNome da mãe.Obrigatório.
physical_detail.birth_datedateData de nascimento.Obrigatório.
physical_detail.birth_citystringCidade de nascimento.Obrigatório.
physical_detail.birth_statestringEstado de nascimento.Obrigatório.
physical_detail.birth_countrystringPaís de nascimento.Obrigatório. Validado com a enumeração CountryEnum.
physical_detail.business_lineintegerOcupação.Obrigatório. Validado com a enumeração PhysicalBusinessLineEnum.
physical_detail.document_typestringTipo de documento de identificação.Obrigatório.
physical_detail.document_numberstringNúmero do documento de identificação.Obrigatório.
physical_detail.document_issue_datedateData de emissão do documento.Obrigatório.
physical_detail.document_issuerstringÓrgão emissor do documento.Obrigatório.
physical_detail.document_statestringEstado emissor do documento.Obrigatório.
physical_detail.marital_statusstringEstado civil.Obrigatório. Validado com a enumeração MaritalStatusEnum.
physical_detail.genderstringGênero.Obrigatório. Deve ser 'M' ou 'F'.
physical_detail.financial_statisticintegerRamo de atividadeOpcional. Validado com a enumeração FinancialStatisticEnum.
physical_detail.monthly_incomenumericRenda mensal.Obrigatório.

Campos para Responsável Legal (PF)#

CampoTipoDescriçãoRegras
physical_legal_responsiblearrayInformações do responsável legal, caso aplicável.Opcional, mas obrigatório se presente.
physical_legal_responsible.namestringNome do responsável legal.Obrigatório.
physical_legal_responsible.mother_namestringNome da mãe do responsável legal.Obrigatório.
physical_legal_responsible.taxid_numberstringCPF ou CNPJ do responsável legal.Obrigatório.
physical_legal_responsible.mobile_phonestringTelefone celular do responsável legal.Obrigatório.
physical_legal_responsible.mobile_phone_countrystringCódigo do país do telefone celular.Obrigatório.
physical_legal_responsible.emailstringE-mail do responsável legal.Obrigatório.
physical_legal_responsible.birth_datedateData de nascimento do responsável.Obrigatório.
physical_legal_responsible.documentsarrayDocumentos do responsável legal.Obrigatório.
physical_legal_responsible.addressarrayEndereço do responsável legal.Obrigatório.
Pessoa Jurídica
CampoTipoDescriçãoRegras
legal_detailarrayDetalhes legais da empresa.Obrigatório.
legal_detail.company_namestringNome da empresa.Obrigatório.
legal_detail.business_linestringRamo de atividadeObrigatório. Validado com a enumeração LegalBusinessLineEnum.
legal_detail.establishment_formstringForma de constituiçãoObrigatório. Validado com a enumeração EstablishmentFormEnum.
legal_detail.establishment_datedateData de constituição da empresa.Obrigatório.
legal_detail.state_registrationstringInscrição estadual.Obrigatório.
legal_detail.financial_statisticnumericSetor de atividadeObrigatório. Validado com a enumeração FinancialStatisticEnum.
legal_detail.monthly_incomenumericRenda mensal.Opcional.
legal_representativesarrayLista de representantes legais da empresa.Obrigatório.
legal_representatives.*.namestringNome do representante legal.Obrigatório.
legal_representatives.*.mother_namestringNome da mãe do representante legal.Obrigatório.
legal_representatives.*.taxid_numberstringCPF ou CNPJ do representante legal.Obrigatório.
legal_representatives.*.mobile_phonestringTelefone celular do representante legal.Obrigatório.
legal_representatives.*.emailstringE-mail do representante legal.Obrigatório.
legal_representatives.*.birth_datedateData de nascimento do representante legal.Obrigatório.
legal_representatives.*.documentsarrayDocumentos do representante legal.

Modelos de Payload#

Payload para Pessoa Física
{
  "name": "João Silva",
  "taxid_number": "12345678909",
  "mobile_phone": "11987654321",
  "mobile_phone_country": "BRA",
  "email": "joao.silva@example.com",
  "address": {
    "street": "Rua das Flores",
    "number": "123",
    "complement": "Apto 101",
    "district": "Centro",
    "city": "São Paulo",
    "state": "SP",
    "zip_code": "01010-010",
    "country": "BRA"
  },
  "documents": [
    {
      "type": "drivers_license",
      "content": "base64encodeddocumentcontent=="
    }
  ],
  "custom_data": {
    "longitude": "12123",
    "latitude": 12345,
    "device": "111111"
  },
  "physical_detail": {
    "social_name": "Joãozinho",
    "father_name": "Carlos Silva",
    "mother_name": "Maria Silva",
    "birth_date": "1990-01-01",
    "birth_city": "São Paulo",
    "birth_state": "SP",
    "birth_country": "BRA",
    "occupation": 1,
    "document_type": "RG",
    "document_number": "123456789",
    "document_issue_date": "2010-01-01",
    "document_issuer": "SSP-SP",
    "document_state": "SP",
    "marital_status": "single",
    "gender": "M",
    "financial_statistic": 4500,
    "monthly_income": 3000
  }
}
Payload para Pessoa Fisica (Responsável Legal)
Payload para Pessoa Jurídica
Página anterior
Account
Próxima página
list
Built with