Este endpoint permite iniciar o processo de onboarding de novas contas para pessoas jurídicas.
Descrição:
Através deste endpoint, é possível iniciar o processo de onboarding de novas contas para pessoas jurídicas. Caso a requisição seja bem-sucedida, você receberá um identificador único gerado para aquele onboarding. Se a onboarding for aprovada, a conta será credenciada e você receberá um webhook com as informações da conta, onde o identificador da conta será o mesmo retornado na abertura do onboarding. Consulte a página "Webhook de confirmação de conta" para mais detalhes.
Importante:
O identificador retornado pertence à conta que foi credenciada (caso aprovada). Ele será necessário posteriormente para realizar as requisições nas APIs do sistema. Um campo chamado accountIdentifier no cabeçalho é obrigatório.
Corpo da Requisição
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
documentNumber | String | Sim | Número do documento |
tradingName | String | Sim | Nome fantasia da empresa |
openCompanyDate | String | Sim | Data de abertura da empresa |
String | Sim | Endereço de e-mail da empresa | |
mobilePhone | String | Sim | Número de telefone da empresa |
representative | Object | Sim | Dados do representante da empresa |
└── cpf | String | Sim | CPF do representante |
└── name | String | Sim | Nome do representante |
String | Sim | E-mail do representante | |
└── mobilePhone | String | Sim | Telefone do representante |
destinationAccount | Object | Sim | Conta de destino |
└── bankNumber | String | Sim | Número do banco da conta |
└── branch | String | Sim | Número da agência da conta |
└── number | String | Sim | Número da conta da empresa |
fees | Object | Sim | Dados de taxas a serem cobrados da conta |
└── bankSlip | Double | Não | Taxa cobrada no pagamento do boleto (Obrigatório se o pixCashIn não for informado) |
└── pixCashIn | Double | Não | Taxa cobrada para recebimento de pagamento com pix (Obrigatório se o bankSlip não for informado) |
Resposta de Sucesso
{
"identifier": "d4f290b4-9bdb-4695-bcdb-c4ccc921b5ff"
}
Corpo da Resposta de Sucesso
Campo | Tipo | Descrição |
---|---|---|
identifier | String | Identificador único gerado |
Resposta em Caso de Erro
Campo | Tipo | Descrição |
---|---|---|
path | String | Caminho do erro |
error | String | Tipo de erro |
message | String | Mensagem de erro |
errors | Array | Lista de erros adicionais |
└── field | String | Campo que causou o erro |
└── value | String | Valor que causou o erro |
└── message | String | Mensagem descrevendo o erro ocorrido |
timestamp | String | Carimbo de data/hora do erro |
status | Number | Código de status HTTP do erro |