Onboarding BaaS
O parceiro abre o cadastro pela API de Contas. A aprovação é do time operacional da instituição. A API de Contas não tem endpoint para o parceiro aprovar ou rejeitar.
A criação depende da preferência ENABLE_ONBOARDING_API_ENDPOINT no ambiente. Com ela desligada, POST /onboarding responde 422 com Onboarding API is disabled.
Escopos: baas.onboarding.write para criar e enviar documentos, baas.onboarding.read para consultar. Não envie x-account-id. Veja Como operar.
Criar
POST /onboarding
O processo nasce com status 1 (Aguardando aprovação). A resposta traz id (UUID) e status.
accountType | O que enviar |
|---|---|
NATURAL_PERSON | person: nome, CPF (11 dígitos), e-mail, telefone e endereço |
LEGAL_PERSON | person do responsável e company: razão social, nome fantasia, CNPJ (14 dígitos), e-mail e telefone |
O endereço pede CEP com 8 dígitos, logradouro, número e bairro. Complemento e nome social são opcionais.
A listagem também aceita o filtro SALARY_ACCOUNT. A criação por esta API é NATURAL_PERSON ou LEGAL_PERSON.
Se a pessoa já existir, a API responde 422 com Person already exists.
Documentos
POST /onboarding/{id}/images, multipart/form-data, com type e file.
type | Arquivo |
|---|---|
FRONT | Frente do documento |
BACK | Verso do documento |
SELFIE | Selfie do titular |
JPG ou PNG, no máximo 10 MB. O envio só é aceito com o onboarding em 0 (Pendente) ou 1 (Aguardando aprovação).
Acompanhar
GET /onboardings/{id} ou GET /onboardings. Onboardings removidos não aparecem na lista.
Não há webhook de status. Os valores, o que acontece depois do 2 (Aprovado) e a frequência de consulta estão em Status de contas e pessoas.