Onboarding conta escrow
Etapa 1: Preparação e Upload de Documentos
Para cada pessoa (Física ou Jurídica) que fará parte da conta (Titular, Securitizadora, Administrador, etc.), os documentos devem ser preparados e carregados antes do cadastro:
1. Solicitar Link Pré-Assinado (Pre-Signed URL):
- Endpoint: POST /v1/documents/upload
- Ação: Envie o nome do arquivo (fileName) para avisar o sistema sobre o arquivo que será carregado.
- Retorno: A API retorna o uploadUrl (para fazer o POST do arquivo) e a key (ou ID do documento).
2. Upload do Arquivo:
- Ação: Faça o POST do arquivo binário (documento) para o uploadUrl recebido.
3. Resultado:
- Retorno: A key (ID) do documento será usada no payload da Criação de Pessoa na Etapa 2.
Etapa 2: Cadastro de Todas as Pessoas (Partes Relacionadas)
Para o Titular e para cada Parte Relacionada (Securitizadora, Fundo, etc.):
- Endpoint: POST /v1/persons
- Payload: Inclua os dados obrigatórios (nome, e-mail) e os IDs dos documentos (obtidos na Etapa 1).
- Retorno: O personId (ID da Pessoa) para cada pessoa criada.
Etapa 3: Criação da Conta Escrow
Use o ID da Pessoa Titular e os IDs das outras Partes Relacionadas para criar a conta.
- Endpoint: POST /v1/accounts
- Payload Essencial:
- accountType: Defina como ESCROW.
- personId: O ID da pessoa titular.
- parties (Partes Relacionadas): Liste todas as pessoas que farão parte da conta (Titular, Fundo, Gestor, etc.).
- permissions: Defina o array de permissões para cada Parte Relacionada (ex: POSTING_CREATE, POSTING_REVIEW, VIEW_ACCOUNT). As permissões são cruciais e não podem ser alteradas via API após a criação.
- accountStatusChangeWebhookUrl (Opcional, mas Recomendado): Defina uma URL para receber eventos de onboarding (ex: "em análise", "aprovado").
- Resultado: A conta é criada e entra no fluxo de análise (onboarding - KYC, etc.), e os eventos de status são enviados para o webhook configurado.
Etapa 4: Preparação para Movimentação de Fundos (Destinatários)
Use o ID da Pessoa Titular e os IDs das outras Partes Relacionadas para criar a conta.
- Endpoint: POST /v1/accounts/:accountId/destinations
- Ação: Cadastre os dados bancários (banco, agência, conta) das contas para as quais a Conta Escrow fará Pix/TED.
- Retorno: O accountDestinationId, que será usado para realizar as transferências (POST /v1/postings).
Etapa 5: Configuração de Funcionalidades Adicionais (Cobrança e Retenção)
Dependendo das necessidades do contrato Escrow:
Funcionalidade | Endpoint | Fluxo |
|---|---|---|
Cobrança (Boleto/Charge) | POST /v1/wallets e POST /v1/wallets/:walletId/charges |
|
Retenção de Depósito | POST /v1/accounts/:accountId/deposit-retention | Crie a regra de retenção (porcentagem, período, teto) e aponte para um accountDestinationId (da Etapa 4) para onde o valor retido deve ser liquidado. |
Webhooks Transacionais | POST /v1/accounts/:accountId/webhook-configurations | Cadastre webhooks para receber notificações sobre eventos da conta (exceto onboarding, que foi na Etapa 3), como entrada de SLC, SPB (TED), ou Pix. |
Updated about 22 hours ago