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

# Identidade da conta

> Retorna a conta merchant autorizada pelo token OAuth ou API key.

Identifica a conta merchant associada à credencial. Com OAuth, use access token (`gp_oat_live_...`) e scope `account:read`. Com API key, use `X-API-Key` e permissão `account/balance`.

<RequestExample>
  ```bash cURL (OAuth) theme={null}
  curl -X GET 'https://api.goatpay.com.br/v1/me' \
    -H 'Authorization: Bearer gp_oat_live_...'
  ```

  ```bash cURL (API key) theme={null}
  curl -X GET 'https://api.goatpay.com.br/v1/me' \
    -H 'X-API-Key: gp_live_...'
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "success": true,
    "message": "Conta identificada",
    "data": {
      "id": "clx...",
      "name": "Minha Empresa",
      "status": "ACTIVE",
      "platformBrand": "GOATPAY"
    },
    "requestId": "req_abc"
  }
  ```
</ResponseExample>

Retorna o **resource owner** (conta merchant autorizada), não dados pessoais do usuário que clicou em autorizar.

<ParamField header="Authorization" type="string">
  `Bearer gp_oat_live_...` — access token OAuth2. Requer scope `account:read`.
</ParamField>

<ParamField header="X-API-Key" type="string">
  `gp_live_...` — chave de API com permissão `account/balance`.
</ParamField>

<Note>
  Use **uma** das autenticações acima. Erro `403 insufficient_scope` se o token OAuth não inclui `account:read`.
</Note>


## OpenAPI

````yaml GET /me
openapi: 3.1.0
info:
  title: GoatPay API
  description: >
    API pública merchant da GoatPay. Autenticação via header `X-API-Key:
    gp_live_...`.

    Respostas de sucesso usam o envelope `{ success, message, data, requestId
    }`.

    Campos internos (`accountId`, `metadata`, histórico de entregas de webhook,
    etc.) não são expostos.

    `providerTransactionId` aparece como `referenceId`; `providerInfractionId`
    como `infractionId`.

    Rate limit global: 100 requisições por minuto por API key (HTTP 429). Sem
    chave, limite por IP.
  version: 1.0.0
servers:
  - url: https://api.goatpay.com.br/v1
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: pix
    description: >-
      Cobranças PIX (receber), reembolsos de depósito recebido e transferências
      PIX (enviar). Alias legado em payouts/* para envios.
  - name: transfer-internal
    description: Transferências entre contas GoatPay
  - name: transfer-scheduled
    description: Transferências programadas (agendar, repetir ou por saldo)
  - name: crypto
    description: Depósitos e transferências em criptomoeda
  - name: billings
    description: >-
      Cobranças avulsas (pagamento único) — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: subscriptions
    description: >-
      Assinaturas recorrentes com ciclo fixo — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: account
    description: Saldo e extrato
  - name: subaccount
    description: Subcontas merchant (carteiras lógicas sob a conta principal)
  - name: meds
    description: Disputas MED
  - name: webhooks
    description: Endpoints de webhook de saída
  - name: oauth
    description: OAuth 2.0 — autorização de terceiros (fora do prefixo /v1)
  - name: oauth-apps
    description: Gestão de aplicações OAuth (prefixo /v1, API key)
  - name: payouts
    description: Alias de transfer-pix para saques PIX
  - name: customers
    description: Clientes da loja (CRM)
  - name: products
    description: Produtos e entregas digitais
  - name: coupons
    description: Cupons de desconto para links
  - name: payment-links
    description: Links de pagamento e checkout hospedado
paths:
  /me:
    get:
      tags:
        - account
        - oauth
      summary: Identidade da conta autorizada
      description: >
        Retorna dados da conta merchant associada ao access token OAuth2 ou à
        API key.

        Com OAuth: requer scope `account:read`. Com API key: requer permissão
        `account/balance`.

        Não confundir com OpenID Connect userinfo.
      operationId: getAccountMe
      responses:
        '200':
          $ref: '#/components/responses/AccountMeSuccess'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      security:
        - oauth2:
            - account:read
        - apiKeyAuth: []
components:
  responses:
    AccountMeSuccess:
      description: Conta merchant autorizada identificada.
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - message
              - data
            properties:
              success:
                type: boolean
              message:
                type: string
              data:
                $ref: '#/components/schemas/PublicAccountMe'
              requestId:
                type: string
          examples:
            default:
              value:
                success: true
                message: Conta identificada
                data:
                  id: clx...
                  name: Minha Empresa
                  status: ACTIVE
                  platformBrand: GOATPAY
                requestId: req_abc
    Unauthorized:
      description: Chave ausente, inválida ou revogada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: Chave sem permissão para este endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    PublicAccountMe:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        status:
          type: string
        platformBrand:
          type: string
          example: GOATPAY
    ErrorEnvelope:
      type: object
      required:
        - success
        - message
        - error
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: Subconta inativa
        error:
          type: object
          properties:
            code:
              type: string
              example: Bad Request
            statusCode:
              type: integer
              example: 400
        requestId:
          type: string
          example: req_abc123
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave `gp_live_...` criada em Integrações → Chaves de API no dashboard.
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://api.goatpay.com.br/oauth/authorize
          tokenUrl: https://api.goatpay.com.br/oauth/token
          refreshUrl: https://api.goatpay.com.br/oauth/token
          scopes:
            account:read: Saldo, extrato e identidade da conta
            transactions:read: Consultar transações
            transactions:write: Criar transferências e estornos
            payments:read: Consultar cobranças PIX
            payments:write: Criar cobranças PIX
            withdrawals:read: Consultar saques
            withdrawals:create: Criar saques
            webhooks:read: Listar webhooks
            webhooks:write: Gerenciar webhooks

````