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

# Dados da empresa

> Retorna cadastro, permissões e saldo da empresa autenticada.

> [!NOTE]
>
> Diferente das transações, esta rota retorna o objeto da empresa diretamente na raiz, sem envelope `success`.


## OpenAPI

````yaml openapi.yaml GET /company
openapi: 3.1.0
info:
  title: SkalePayments API
  version: 1.0.0
  description: |
    API para criação e consulta de pagamentos PIX na SkalePayments.
    Valores monetários das requisições são expressos em centavos.
  contact:
    name: SkalePayments
    url: https://skalepayments.com.br
servers:
  - url: https://api.skalepayments.com.br
    description: Produção
security:
  - ApiKeyAuth: []
tags:
  - name: Transações
    description: Criação e consulta de cobranças PIX
  - name: Empresa
    description: Perfil e permissões da conta autenticada
paths:
  /company:
    get:
      tags:
        - Empresa
      summary: Dados da empresa
      description: |
        Retorna cadastro, permissões, endereço, representante legal e saldo da
        empresa autenticada. Campos sem dados podem ser omitidos.
      operationId: obterDadosDaEmpresa
      responses:
        '200':
          description: Dados da empresa
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company'
              examples:
                company:
                  summary: Empresa autenticada
                  value:
                    userId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                    legalName: Empresa Exemplo LTDA
                    blocked: false
                    invoiceDescriptor: Empresa Exemplo
                    createdAt: '2022-05-26T19:06:35.000Z'
                    uploadedDocuments: true
                    user:
                      email: contato@exemplo.com
                      phone: '11999999999'
                      name: Responsável Exemplo
                      isEmailVerified: true
                      createdAt: '2022-05-26T19:03:23.000Z'
                    document:
                      number: '12345678000199'
                      type: cnpj
                    permissions:
                      isPixAvailable: true
                      transferEnabled: true
                      transferPriceCents: 500
                      anticipationEnabled: false
                    defaultRecipient:
                      legalName: Empresa Exemplo LTDA
                      balance:
                        available: 69345
                        updatedAt: '2026-03-26T00:17:38.607Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |
            curl --request GET \
              --url 'https://api.skalepayments.com.br/company' \
              --header 'X-API-Key: sk_sua_chave_aqui'
components:
  schemas:
    Company:
      type: object
      properties:
        userId:
          type: string
          format: uuid
        legalName:
          type: string
        blocked:
          type: boolean
        invoiceDescriptor:
          type: string
        createdAt:
          type: string
          format: date-time
        uploadedDocuments:
          type: boolean
        user:
          type: object
          properties:
            email:
              type: string
              format: email
            phone:
              type: string
            name:
              type: string
            isEmailVerified:
              type: boolean
            createdAt:
              type: string
              format: date-time
        document:
          $ref: '#/components/schemas/Document'
        permissions:
          type: object
          properties:
            isPixAvailable:
              type: boolean
            transferEnabled:
              type: boolean
            transferPriceCents:
              type: integer
            anticipationEnabled:
              type: boolean
        details:
          type: object
          additionalProperties: true
        legalRepresentative:
          type: object
          additionalProperties: true
        socialContract:
          type: string
          format: uri
        address:
          type: object
          additionalProperties: true
        defaultRecipient:
          type: object
          properties:
            legalName:
              type: string
            document:
              $ref: '#/components/schemas/Document'
            transferSettings:
              type: object
              additionalProperties: true
            balance:
              type: object
              properties:
                available:
                  type: integer
                  description: Saldo disponível em centavos.
                updatedAt:
                  type: string
                  format: date-time
    Document:
      type: object
      additionalProperties: false
      required:
        - type
        - number
      properties:
        type:
          type: string
          enum:
            - cpf
            - cnpj
        number:
          type: string
          description: Documento com ou sem pontuação, conforme aceito pela API.
          example: '52998224725'
    ErrorResponse:
      type: object
      required:
        - success
        - statusCode
        - message
        - code
        - timestamp
        - path
        - method
      properties:
        success:
          type: boolean
          const: false
        statusCode:
          type: integer
        message:
          type: string
        code:
          type: string
          example: HTTP_EXCEPTION
        timestamp:
          type: string
          format: date-time
        path:
          type: string
        method:
          type: string
  responses:
    Unauthorized:
      description: API Key ausente ou inválida
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Erro interno da API
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave de integração obtida no painel SkalePayments

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.