Subcontas
Subcontas -
1. Autenticação
a. Na autenticação, para utilizar os endpoints de subcontas, serão necessários enviar os scopes company.write e company.read.
b. A autenticação na conta principal irá conseguir manipular os seguintes endpoints:
i. Criação de subcontas, ii. Listar subcontas, iii. Alteração de subcontas, iv. Inativação de subcontas.
c. Assim que criada uma subconta, será necessário autenticar utilizando as credenciais dela para manipular os seguintes endpoints:
i. Obtendo documentos necessários de envio para validação da Subconta.
ii. Envio de documentos para a Subconta.
2. Criação de subcontas
a. Para a criação de contas PF ou PJ possui alguns campos específicos:
b. Em caso de conta PJ, o campo typeCompany possui as opções abaixo:
- ltda = LTDA
- eireli = Eireli
- association = Associações/Condomínios
- individualEntrepreneur = Empresário individual
- mei = MEI
- sa = S/A
- slu = SLU
3. Listar subcontas
a. A listagem de subcontas irá retornar todas as contas ativas ou não ativas em sua conta principal.
b. A listagem até então traz todas as contas e todas suas informações.
c. É possível buscar por documentos ou galaxPayIds específicos.
4. Alteração de subcontas - A alteração de subcontas permite alterar apenas os campos de endereços.
5. Inativação de Subconta
a. Este endpoint irá inativar a subconta, não sendo possível o cadastro de clientes, contratos/vendas e planos para esta conta.
b. Após inativação, irá constar no histórico de ações da conta principal o IP, Data/Hora e a conta que foi inativada.
6. Obtendo documentos necessários de envio para validação da Subconta
a. Este endpoint deverá ser utilizado autenticado na subconta, ele irá retornar as informações necessárias para o envio de informações sobre a empresa.
b. Além dos campos, este endpoint irá fornecer quais são os arquivos que deverão ser enviados para aquela empresa.
c. Em casos de documentos pessoais, o endpoint irá retornar um nó de CNH e RG. Porém, é necessário apenas o envio das informações de um dos nós.
Exemplo: Caso envie todos os documentos relacionados à CNH, não será necessário o envio dos documentos do RG. O contrário também acontece.
d. O campo type = “Tipo de associado” possui as opções abaixo, que são:
i. partner = Sócio , ii. attorney = Procurador , iii. personinvolved = Pessoa envolvida
7. Envio de documentos para subconta - Este endpoint será utilizado para enviar os campos e arquivos que o endpoint “Obtendo documentos necessários de envio para validação da subconta” informou que seria necessário.
8. Webhooks
a. Após a análise da conta pela equipe de compliance da empresa, o status da verificação da conta irá mudar, sendo empty, denied ou approved. Sendo assim, será enviado o evento company.verifyDocuments.
i. O status empty significa que os documentos ainda não foram enviados para análise.
ii. O status denied significa que os documentos não estão válidos por um ou mais motivos.
b. Estes motivos irão retornar no nó Verification->Reasons
iii. O status approved significa que os documentos comprovam a veracidade das informações e foram aprovados para utilizar o cel_cash.
