Skip to main content
POST
/
api
/
v1
/
licenses
/
verify
Verify license
curl --request POST \
  --url https://licenses.screech.dev/api/v1/licenses/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "licenseKey": "<string>",
  "productId": "<string>",
  "customerId": "<string>",
  "hardwareIdentifier": "<string>"
}
'
{
  "data": {
    "license": {
      "ipLimit": 123,
      "hwidLimit": 123,
      "expirationType": "NEVER",
      "expirationStart": "CREATION",
      "expirationDate": "2023-11-07T05:31:56Z",
      "expirationDays": 123,
      "metadata": {}
    },
    "products": [
      {
        "id": "<string>",
        "name": "<string>",
        "metadata": {}
      }
    ],
    "customers": [
      {
        "id": "<string>",
        "username": "<string>",
        "metadata": {}
      }
    ]
  },
  "result": {
    "valid": true,
    "message": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
licenseKey
string
required

The license key to verify. This is the key that was provided to the user when they purchased or received the license.

​
productId
string<cuid>

The ID of the product associated with the license. This is used to verify that the license is valid for the specified product.

​
customerId
string<cuid>

The ID of the customer associated with the license. This is used to verify that the license is valid for the specified customer.

​
hardwareIdentifier
string

A unique identifier for the client hardware. Typically a hardware ID or another identifier that remains consistent across sessions.

Response

200 - application/json

Successful license verification

​
data
object

Details of the data returned from the verification

​
result
object