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

> Retorna o status atual de uma subconta a partir do internalId.



## OpenAPI

````yaml GET /v1/submerchants/status
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/status:
    get:
      tags:
        - Submerchants
      summary: Consultar status da subconta
      description: Retorna o status atual de uma subconta a partir do internalId.
      operationId: getSubmerchantStatus
      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: internalId
          required: true
          in: query
          description: Identificador interno (UUID) da subconta
          schema:
            format: uuid
            example: 5b9f3d6a-3a2c-4d6f-9b9e-0a1b2c3d4e5f
            type: string
      responses:
        '200':
          description: Status da subconta
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubMerchantStatusResponseDto'
        '401':
          description: Credenciais inválidas ou ausentes
        '404':
          description: Subconta não encontrada
        '429':
          description: Limite de requisições excedido
components:
  schemas:
    SubMerchantStatusResponseDto:
      type: object
      properties:
        status:
          type: string
          enum:
            - pending
            - documentation_pending
            - onboarding
            - kyc_approved
            - kyc_rejected
            - inactive
            - active
            - blocked
          description: Status atual da subconta
          example: kyc_approved
      required:
        - status
  securitySchemes:
    client-id:
      type: apiKey
      in: header
      name: client-id
    client-secret:
      type: apiKey
      in: header
      name: client-secret

````