Propostas
Criar
Cria proposta de onboarding (etapa inicial do titular).
O POST abre a proposta, mas não cria o titular nem libera PF/PJ. O PATCH em Atualizar é obrigatório em seguida.
Registra a proposta com o CPF do titular. A resposta traz o id da proposta (proposalId).
Visão do fluxo: Propostas de onboarding.
Endpoint
POST /api/v2/baas/onboardings/proposals
Scope: baas.onboarding-proposals.write
Contrato: Criar proposta.
Campos obrigatórios
| Campo | Regra | Se omitir |
|---|---|---|
document | CPF do titular, 11 dígitos sem máscara (ou CNPJ, 14) | 400 / 422 |
device.os_version_name | SO do dispositivo, string até 255 caracteres | 400 / 422 |
Campos opcionais na abertura: birth_date, phone, full_name, social_name, email, address. Podem ir no POST ou no PATCH cadastral.
A resposta traz journey.step (etapa atual) e, quando existirem, onboardingNaturalPersons[] / onboardingLegalPersons[].
Documentos KYC não entram neste POST: vão no PATCH de Pessoa física ou Pessoa jurídica.
Próximos passos: Consultar e Atualizar para concluir o cadastro do titular.