Atualizar
O PATCH da proposta é obrigatório após o POST. Só com ele o titular é criado e o fluxo libera PF ou PJ.
Se você pular este passo, POST ou PATCH de PF/PJ retornam 404 com Customer not found.
Visão do fluxo: Propostas de onboarding.
Endpoint
PATCH /api/v2/baas/onboardings/proposals/{proposalId}
Scope: baas.onboarding-proposals.write
Contrato: Atualizar proposta.
Antes do PATCH
- Consulte a proposta (
GET). - Faça merge local: campos do
GET+ novos valores do formulário. - Inclua
passwordepassword_confirmationquando for criar ou atualizar o titular (passwordnão retorna noGET).
Dois grupos de campos
1. Pacote cadastral (cria o titular)
Envie todos juntos no PATCH:
| Campo | Regra |
|---|---|
full_name | String, máx. 255 |
social_name | String, máx. 255 |
email | E-mail válido |
phone | String, 8 a 11 dígitos (sem +55) |
birth_date | Data Y-m-d |
password + password_confirmation | Senha e confirmação idênticas |
accepted_terms_at | Data/hora Y-m-d H:i:s |
device.os_version_name | String no objeto device |
Sem este pacote completo, o titular não é criado e a etapa 2 (PF/PJ) falha com Customer not found.
2. Códigos OTP (compliance)
| Campo | Regra |
|---|---|
email_verification_code | Obrigatório; OTP do e-mail (volátil; vem no GET) |
phone_verification_code | Obrigatório; OTP do celular (volátil; vem no GET) |
Envie no mesmo PATCH do pacote cadastral (recomendado). Sem eles: 422 ou reprovação em compliance.
OTP expirado: Reenviar e-mail ou Reenviar SMS, depois GET + PATCH.
notifications_enabled (default false) controla se SMS/e-mail de OTP são disparados localmente.
O que não enviar
files[]: documentos KYC vão noPATCHde Pessoa física ou Pessoa jurídica.
Campos enviados substituem o valor remoto. Prefira sempre GET → merge → PATCH.
Com a proposta concluída, siga para Pessoa física ou Pessoa jurídica.