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

CampoTipoObrigatórioDescrição
documentNumberStringSimNúmero do documento
tradingNameStringSimNome fantasia da empresa
openCompanyDateStringSimData de abertura da empresa
emailStringSimEndereço de e-mail da empresa
mobilePhoneStringSimNúmero de telefone da empresa
representativeObjectSimDados do representante da empresa
└── cpfStringSimCPF do representante
└── nameStringSimNome do representante
└── emailStringSimE-mail do representante
└── mobilePhoneStringSimTelefone do representante
destinationAccountObjectSimConta de destino
└── bankNumberStringSimNúmero do banco da conta
└── branchStringSimNúmero da agência da conta
└── numberStringSimNúmero da conta da empresa
feesObjectSimDados de taxas a serem cobrados da conta
└── bankSlipDoubleNãoTaxa cobrada no pagamento do boleto (Obrigatório se o pixCashIn não for informado)
└── pixCashInDoubleNãoTaxa 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

CampoTipoDescrição
identifierStringIdentificador único gerado

Resposta em Caso de Erro

CampoTipoDescrição
pathStringCaminho do erro
errorStringTipo de erro
messageStringMensagem de erro
errorsArrayLista de erros adicionais
└── fieldStringCampo que causou o erro
└── valueStringValor que causou o erro
└── messageStringMensagem descrevendo o erro ocorrido
timestampStringCarimbo de data/hora do erro
statusNumberCódigo de status HTTP do erro
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!