Criar onboarding no BaaS.

POST

/onboarding

Onboardings

Cria um novo processo de abertura de conta vinculado ao BaaS da credencial autenticada. Este endpoint é exclusivo para credenciais BaaS e não exige o cabeçalho x-account-id.

O vínculo do onboarding ao BaaS deve vir da credencial BaaS autenticada, não de variações de x-account-id. A conta dona da credencial pode ter accounts.baas_id = null; nesse caso o backend resolve o BaaS pela relação baas.account_number = account.number.

O onboarding é criado com status Aguardando aprovação (1). A análise e aprovação são realizadas pelo time operacional da instituição.

A funcionalidade depende da preferência ENABLE_ONBOARDING_API_ENDPOINT estar habilitada no ambiente.

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Token URL: /oauth/token

Scopes:

baas.onboarding.write-Permite criar cadastros/onboardings e enviar documentos

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201

application/json

Onboarding criado

Bodyapplication/json

🟠400

🟠401

🟠403

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

cURL

Pessoa físicaPessoa jurídica

curl --location '/onboarding' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountType": "NATURAL_PERSON",
    "person": {
        "name": "João da Silva Santos",
        "document": "12345678901",
        "email": "joao.silva@email.com",
        "phone": "11987654321",
        "address": {
            "zipCode": "01310100",
            "address": "Avenida Paulista",
            "number": "1578",
            "complement": "Apto 101",
            "district": "Bela Vista"
        }
    }
}'

Response Example

201 - Exemplo de resposta

{
    "message": "Onboarding created successfully",
    "id": "4fdd34d2-e9fa-4bb5-bfeb-84281f77f19a",
    "status": 1
}

Página anterior

Gerar credencial da API de QR Codes (Pix) para conta filha.

Próxima página

Enviar imagem do onboarding.