Onboarding de Conta Escrow

Qual é a primeira etapa do onboarding?

Preparação e upload de documentos.

Fluxo:

1. Solicitar URL de upload

   • Endpoint: POST /v1/documents/upload

   • Enviar fileName

2. Fazer upload do documento

   • Enviar o arquivo para o uploadUrl recebido

3. Resultado

   • A API retorna a key (ID do documento) que será usada no cadastro da pessoa.

Como cadastrar as pessoas envolvidas na conta?

Cada participante da conta deve ser criado no sistema.

• Endpoint: POST /v1/persons

Dados enviados:

• Nome

• Email

• IDs dos documentos enviados na etapa anterior

Resultado:

• Retorno do personId, identificador único da pessoa.

Como criar a Conta Escrow?

Após cadastrar todas as pessoas:

• Endpoint: POST /v1/accounts

Principais campos do payload:

Exemplos de permissões:

• POSTING_CREATE

• POSTING_REVIEW

• VIEW_ACCOUNT

⚠️ As permissões não podem ser alteradas via API após a criação da conta.

Como preparar a conta para movimentação de dinheiro?

É necessário cadastrar os destinatários bancários.

• Endpoint: POST /v1/accounts/:accountId/destinations

Dados informados:

• Banco

• Agência

• Conta

Resultado:

• accountDestinationId, utilizado para transferências.

Para mais informações acesse a nossa documentação.