Propostas
Listar
Lista propostas de onboarding do parceiro autenticado.
Lista propostas de onboarding vinculadas ao parceiro.
Visão do fluxo: Propostas de onboarding.
Endpoint
GET /api/v2/baas/onboardings/proposals
Scope: baas.onboarding-proposals.read
Query opcional: page (inicia em 0), limit.
Bearer e HMAC. Em GET assinados, corpo na assinatura costuma ser [].
Contrato: Listar propostas.
Resposta
Envelope paginado:
| Campo | Descrição |
|---|---|
data[] | Propostas do parceiro |
pagination.page | Página atual |
pagination.limit | Tamanho da página |
pagination.total | Total de registros |
Cada item em data[] inclui id, document, step, status, contato (full_name, email, phone), natural_person_id, legal_person_id, notifications_enabled, created_at, updated_at. Sem password nem OTP.
Para OTP e pendências, Consulte a proposta pelo id.
SDK PHP
$proposals = $client->onboardingProposals()->list();
foreach ($proposals as $proposal) {
echo $proposal->id, ' ', $proposal->step, PHP_EOL;
}
O resource normaliza { "data": [...] } ou array na raiz (OnboardingProposalResource::list()).
Autenticação: Autenticação da plataforma BaaS.