Skip to main content
POST
Gerar ou reutilizar link de onboarding
Retorna o link de onboarding ativo da organização. Se não houver link ativo, ou se o ativo estiver expirado, cria um novo. Exige headers client-id + client-secret.
Entregue a url ao usuário final. Este caminho não retorna registration_id. Veja o guia Subcontas.

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

Response

Link de onboarding ativo retornado (existente ou recém-criado)

url
string
required

URL completa do onboarding com token

Example:

"https://app.uvvipay.com/onboarding/2f1c8b9a-4d3e-4f6a-9b1c-0a1b2c3d4e5f"

status
enum<string>
required

Status do link de onboarding

Available options:
active,
inactive,
cancelled
Example:

"active"

created_at
string<date-time>
required

Data de criação do link

Example:

"2026-07-16T18:00:00.000Z"