> ## Documentation Index
> Fetch the complete documentation index at: https://developers.uvvipay.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar link de onboarding

> Retorna o link de onboarding ativo da organização autenticada, ou null quando não houver link ativo. Requer produto PaaS habilitado.

<Note>
  Retorna o link de onboarding ativo da organização, ou `null` quando não
  houver link ativo. Requer o produto PaaS habilitado.
</Note>


## OpenAPI

````yaml GET /v2/submerchants
openapi: 3.0.0
info:
  title: UvviPay Public API
  description: >-
    Endpoints públicos da plataforma UvviPay para integração de subcontas
    (submerchants).
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.uvvipay.com.br
    description: Produção
  - url: https://api-staging.uvvipay.com.br
    description: Staging
security:
  - client-id: []
    client-secret: []
tags: []
paths:
  /v2/submerchants:
    get:
      tags:
        - Submerchants
      summary: Consultar link de onboarding ativo
      description: >-
        Retorna o link de onboarding ativo da organização autenticada, ou null
        quando não houver link ativo. Requer produto PaaS habilitado.
      operationId: getSubmerchantOnboardingLink
      parameters:
        - name: client-secret
          in: header
          description: Secret da credencial do merchant
          required: true
          schema:
            type: string
        - name: client-id
          in: header
          description: ID público da credencial do merchant
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Link ativo ou null
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOnboardingLinkResponseOrNullDto'
        '401':
          description: Credenciais inválidas ou ausentes
        '403':
          description: Produto PaaS não habilitado para o merchant
        '429':
          description: Limite de requisições excedido
components:
  schemas:
    ApiOnboardingLinkResponseOrNullDto:
      description: Link de onboarding ativo, ou null quando inexistente
      nullable: true
      allOf:
        - $ref: '#/components/schemas/ApiOnboardingLinkResponseDto'
    ApiOnboardingLinkResponseDto:
      type: object
      properties:
        url:
          type: string
          description: URL completa do onboarding com token
          example: >-
            https://app.uvvipay.com/onboarding/2f1c8b9a-4d3e-4f6a-9b1c-0a1b2c3d4e5f
        status:
          type: string
          enum:
            - active
            - inactive
            - cancelled
          description: Status do link de onboarding
          example: active
        createdAt:
          type: string
          format: date-time
          description: Data de criação do link
          example: '2026-07-16T18:00:00.000Z'
      required:
        - url
        - status
        - createdAt
  securitySchemes:
    client-id:
      type: apiKey
      in: header
      name: client-id
    client-secret:
      type: apiKey
      in: header
      name: client-secret

````