> ## 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.

# Listar subcontas

> Retorna a lista paginada de subcontas vinculadas ao merchant autenticado, com filtros opcionais.



## OpenAPI

````yaml GET /v1/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:
  /v1/submerchants:
    get:
      tags:
        - Submerchants
      summary: Listar subcontas
      description: >-
        Retorna a lista paginada de subcontas vinculadas ao merchant
        autenticado, com filtros opcionais.
      operationId: getSubmerchants
      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
        - name: page
          required: false
          in: query
          description: Página da paginação (1-based)
          schema:
            default: 1
            example: 1
            type: number
        - name: limit
          required: false
          in: query
          description: Quantidade de itens por página (máximo 100)
          schema:
            default: 10
            example: 10
            type: number
        - name: status
          required: false
          in: query
          description: Filtrar por um ou mais status
          schema:
            example:
              - kyc_approved
              - active
            type: array
            items:
              type: string
              enum:
                - pending
                - documentation_pending
                - onboarding
                - kyc_approved
                - kyc_rejected
                - inactive
                - active
                - blocked
        - name: name
          required: false
          in: query
          description: Filtro por nome legal (busca parcial)
          schema:
            example: Empresa Exemplo
            type: string
        - name: cnpj
          required: false
          in: query
          description: Filtro por CNPJ ou CPF (apenas dígitos, 11 ou 14 caracteres)
          schema:
            type: string
            example: '12345678000199'
        - name: startDate
          required: false
          in: query
          description: Data inicial do filtro (formato ISO 8601)
          schema:
            example: '2026-01-01'
            type: string
        - name: endDate
          required: false
          in: query
          description: Data final do filtro (formato ISO 8601)
          schema:
            example: '2026-12-31'
            type: string
      responses:
        '200':
          description: Lista de subcontas retornada com sucesso
        '400':
          description: Filtros inválidos
        '401':
          description: Credenciais inválidas ou ausentes
        '429':
          description: Limite de requisições excedido
components:
  securitySchemes:
    client-id:
      type: apiKey
      in: header
      name: client-id
    client-secret:
      type: apiKey
      in: header
      name: client-secret

````