Skip to main content
GET
Consultar status da subconta
Retorna o status da subconta já criada. Informe internalId na query. Não use este endpoint para acompanhar onboarding assíncrono.
Status de onboarding assíncrono fica em GET /v2/submerchants/onboarding/{registrationId}/status. Veja o guia Subcontas.
A consulta retorna só status. NOTA: O motivo da correção não vem nesse JSON. A conta responsável vê o motivo. NOTA: Não existe status suspended nem o rótulo “suspensa” para subconta. Desativação é inactive. Bloqueio é blocked. NOTA: Mudança de status da subconta chega no webhook submerchant.status.updated. Veja Webhooks. O valor é o status da subconta, não o do onboarding.

Authorizations

client-id
string
header
required
client-secret
string
header
required

Headers

client-secret
string
required

Secret da credencial do merchant

client-id
string
required

ID público da credencial do merchant

Query Parameters

internalId
string<uuid>
required

Identificador interno (UUID) da subconta

Example:

"5b9f3d6a-3a2c-4d6f-9b9e-0a1b2c3d4e5f"

Response

Status da subconta

status
enum<string>
required

Status atual da subconta

Available options:
pending,
documentation_pending,
pendencias_regularizadas,
onboarding,
kyc_approved,
kyc_rejected,
kyc_manual_review,
inactive,
active,
blocked
Example:

"kyc_approved"