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

# Verify license

> Verifies the validity of a license key.



## OpenAPI

````yaml openapi.json post /api/v1/licenses/verify
openapi: 3.0.1
info:
  title: Screech Licenses
  description: API documentation for Screech Licenses
  version: 1.0.0
servers:
  - url: https://licenses.screech.dev
security:
  - bearerAuth: []
paths:
  /api/v1/licenses/verify:
    post:
      summary: Verify license
      description: Verifies the validity of a license key.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                licenseKey:
                  type: string
                  description: >-
                    The license key to verify. This is the key that was provided
                    to the user when they purchased or received the license.
                productId:
                  type: string
                  description: >-
                    The ID of the product associated with the license. This is
                    used to verify that the license is valid for the specified
                    product.
                  format: cuid
                customerId:
                  type: string
                  description: >-
                    The ID of the customer associated with the license. This is
                    used to verify that the license is valid for the specified
                    customer.
                  format: cuid
                hardwareIdentifier:
                  type: string
                  description: >-
                    A unique identifier for the client hardware. Typically a
                    hardware ID or another identifier that remains consistent
                    across sessions.
              required:
                - licenseKey
      responses:
        '200':
          description: Successful license verification
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    description: Details of the data returned from the verification
                    properties:
                      license:
                        type: object
                        description: Details of the verified license
                        properties:
                          ipLimit:
                            type: integer
                            nullable: true
                            description: Maximum number of different IP addresses allowed
                          hwidLimit:
                            type: integer
                            nullable: true
                            description: Maximum number of hardware identifiers allowed
                          expirationType:
                            type: string
                            enum:
                              - NEVER
                              - DATE
                              - DURATION
                            description: Defines how the license expiration is calculated
                          expirationStart:
                            type: string
                            enum:
                              - CREATION
                              - ACTIVATION
                            description: >-
                              Defines when the license expiration countdown
                              begins
                          expirationDate:
                            type: string
                            format: date-time
                            nullable: true
                            description: >-
                              Date when the license expires, if expirationType
                              is DATE
                          expirationDays:
                            type: integer
                            nullable: true
                            description: >-
                              Number of days until license expiration, if
                              expirationType is DURATION
                          metadata:
                            type: object
                            nullable: true
                            description: >-
                              License metadata as JSON key-value pairs,
                              containing additional information about the
                              license
                            additionalProperties: true
                      products:
                        type: array
                        description: List of products associated with the license
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              format: cuid
                              description: Unique identifier for the product
                            name:
                              type: string
                              description: Product name
                            metadata:
                              type: object
                              nullable: true
                              description: >-
                                Product metadata as JSON key-value pairs,
                                containing additional information about the
                                product
                              additionalProperties: true
                      customers:
                        type: array
                        description: List of customers associated with the license
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              format: cuid
                              description: Unique identifier for the customer
                            username:
                              type: string
                              description: Customer username
                            metadata:
                              type: object
                              nullable: true
                              description: >-
                                Customer metadata as JSON key-value pairs,
                                containing additional information about the
                                customer
                              additionalProperties: true
                  result:
                    type: object
                    properties:
                      valid:
                        type: boolean
                        description: Indicates whether the license is valid
                      message:
                        type: string
                        description: >-
                          Message providing additional information about the
                          verification result
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````