Skip to main content
GET
Consultar status do onboarding (API)
Consulta o status do onboarding iniciado por POST /v2/submerchants/onboarding/pf ou POST /v2/submerchants/onboarding/pj. Use o registration_id retornado no submit. Exige headers client-id + client-secret.

Campos da resposta

Como usar status, action e can_resubmit

NOTA: Use este endpoint para decidir a próxima ação. O status da resposta 202 do submit ou do reenvio não substitui esta consulta. NOTA: Se can_resubmit for false, o reenvio retorna 409.

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

Path Parameters

registrationId
string<uuid>
required

UUID do registro de onboarding retornado no POST /v2/submerchants/onboarding/pf|pj

Response

Status do onboarding

external_id
string | null
required

Chave de idempotência enviada no onboarding (x-idempotency-key)

Example:

"pedido-123"

registration_id
string<uuid>
required

ID do registro de onboarding

Example:

"2f1c8b9a-4d3e-4f6a-9b1c-0a1b2c3d4e5f"

status
enum<string>
required

Estado do onboarding para o integrador

Available options:
processing,
approved,
rejected,
action_required
Example:

"action_required"

action
enum<string>
required

Próxima ação esperada do integrador

Available options:
none,
resubmit_documents,
contact_support
Example:

"resubmit_documents"

can_resubmit
boolean
required

Indica se o POST de reenvio de documentos está elegível

Example:

true