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

# Verify API key

> Verifies the API key and returns the authenticated business and key metadata. Use it as a connectivity check.



## OpenAPI

````yaml /openapi/v1.yaml get /api/v1/me
openapi: 3.1.0
info:
  title: Rigaly Business API
  version: '1.0'
  description: |
    Public API for businesses to manage their Rigaly loyalty programs: issue
    and redeem points, manage rewards, validate redemptions, and generate mass
    codes for physical products.

    All endpoints require an API key created in the Rigaly business dashboard
    (Tools → API Management), passed as `Authorization: Bearer rgly_sk_...`.
  contact:
    email: support@rigaly.com
servers:
  - url: https://api.rigaly.com
    description: Production
security:
  - apiKey: []
paths:
  /api/v1/me:
    get:
      tags:
        - Meta
      summary: Verify API key
      description: >-
        Verifies the API key and returns the authenticated business and key
        metadata. Use it as a connectivity check.
      operationId: getMe
      responses:
        '200':
          description: Key is valid
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessEnvelope'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          business:
                            type: object
                            properties:
                              id:
                                type: string
                                format: uuid
                              name:
                                type: string
                                example: Coffee Corner
                              email:
                                type: string
                                example: owner@example.com
                              status:
                                type: string
                                example: approved
                              country:
                                type: string
                                example: US
                          api_key:
                            type: object
                            properties:
                              id:
                                type: string
                                format: uuid
                              name:
                                type: string
                                example: Production store
                              prefix:
                                type: string
                                example: rgly_sk_3fA9
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    SuccessEnvelope:
      type: object
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
        data:
          type: object
    ErrorEnvelope:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            message:
              type: string
  responses:
    Unauthorized:
      description: Missing, malformed, or revoked API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            error:
              message: Invalid API key
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'API key from the Rigaly dashboard: `Authorization: Bearer rgly_sk_...`'

````