Register Products — Check Serial

Step 1 of 2 in the Register Products flow: checks whether a serial is suitable for product registration and returns the license and product details, so your form can show the customer what they are about to register. A serial is suitable if it belongs to an offline-distributed (dealer) license that has not been registered yet. Nothing is written to the license.

To complete the registration, continue with Register Products — Submit Registration.

GET https://api.keyzy.io/v2/register-products/{serial-number}?app_id=XXXXXX&api_key=XXXXXXXXXXXXXXXXX

Variables

VariableDescription
serial-numberserial number

Parameters

ParameterDescription
app_idAn app_id that has read permission
api_keyAn api_key that has read permission

Returns

Success

{
  "data": [
    {
      "id": "int",
      "dealer_id": "int",
      "dealer_name": "string",
      "sku_id": "int",
      "sku_name": "string",
      "sku_number": "string",
      "sku_url": "string",
      "image_url": "string",
      "serial": "string",
      "name": "string",
      "email": "string",
      "type": "perpetual|subscription|trial",
      "start_at": "unix timestamp",
      "end_at": "unix timestamp",
      "registered": "bool",
      "created_at": "timestamp",
      "updated_at": "timestamp"
    }
  ]
}

Errors

For general error format details, see Errors.

You are not authorized — the app_id or api_key is wrong.

{
  "error": {
    "message": "You are not authorized!",
    "status_code": 401
  }
}

Serial not valid — the serial number is too short.

{
  "error": {
    "message": "The serial number is not valid!",
    "status_code": 422
  }
}

Serial not found — the serial does not exist, is not assigned to a dealer, or is already registered.

{
  "error": {
    "message": "The license does not exist or is not assigned to a dealer or is already registered!",
    "status_code": 404
  }
}