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

# Check a licence key

> Called every week by a self-hosted installation, without a token: the signed key is its own proof. Limited to 30 calls a minute.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/licences/check
openapi: 3.1.0
info:
  title: Lekalao API
  version: 1.0.0
  description: >-
    Everything the interface does, your application can do too. Every call
    carries an API token (Settings → API tokens).
servers:
  - url: https://{host}
    description: Your installation
    variables:
      host:
        default: lekalao.example.com
        description: The domain of your own Lekalao
security:
  - bearer: []
tags:
  - name: Lists
  - name: Subscribers
  - name: Tags
  - name: Segments
  - name: Imports
  - name: Templates
  - name: Campaigns
  - name: Automations
  - name: Transactional e-mails
  - name: Revenue
  - name: Platform
paths:
  /api/v1/licences/check:
    post:
      tags:
        - Platform
      summary: Check a licence key
      description: >-
        Called every week by a self-hosted installation, without a token: the
        signed key is its own proof. Limited to 30 calls a minute.
      operationId: api.licences.check
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - key
                - instance
              properties:
                key:
                  type: string
                instance:
                  type: string
                  maxLength: 64
                domain:
                  type:
                    - string
                    - 'null'
                version:
                  type:
                    - string
                    - 'null'
      responses:
        '200':
          description: The key is valid.
          content:
            application/json:
              schema:
                type: object
                properties:
                  valid:
                    type: boolean
                  customer:
                    type: string
                  plan:
                    type:
                      - string
                      - 'null'
                  expires_at:
                    type:
                      - string
                      - 'null'
                    format: date
                  expired:
                    type: boolean
        '403':
          description: The key has been revoked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  valid:
                    type: boolean
                  reason:
                    type: string
                    enum:
                      - revoked
        '422':
          description: The key cannot be read, or is badly signed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  valid:
                    type: boolean
                  reason:
                    type: string
                    enum:
                      - invalid
      security: []
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: >-
        An API token. The "read" ability: GET routes only. "read + write": every
        route.

````