Skip to main content
GET
https://api.keyport.sbs
/
api
/
v1
/
license
/
{key}
Look up a license by key
curl --request GET \
  --url https://api.keyport.sbs/api/v1/license/{key} \
  --header 'Authorization: Bearer <token>'
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.keyport.sbs/api/v1/license/{key}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
import requests

url = "https://api.keyport.sbs/api/v1/license/{key}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
HttpResponse<String> response = Unirest.get("https://api.keyport.sbs/api/v1/license/{key}")
  .header("Authorization", "Bearer <token>")
  .asString();
{
  "id": "license_uuid",
  "organization_id": "org_uuid",
  "product_id": "product_uuid",
  "global_customer_id": "customer_uuid",
  "license_key": "ABCD-EFGH-IJKL-MNOP",
  "status": "active",
  "expires_at": null,
  "is_lifetime": true,
  "ip_system_enabled": true,
  "max_ips": 1,
  "current_unique_ip_count": 1,
  "notes": null,
  "version_pin_mode": null,
  "version_pinned": null,
  "version_range_min": null,
  "version_range_max": null,
  "revoked_at": null,
  "created_at": "2026-04-07T00:00:00.000Z",
  "updated_at": "2026-04-07T00:00:00.000Z",
  "customer_email": "customer@example.com",
  "customer_name": "Example Customer",
  "customer_discord_id": null
}
{
  "valid": false,
  "status": "invalid_api_key",
  "message": "Missing Authorization header. Use: Authorization: Bearer YOUR_API_KEY"
}
{
  "message": "License not found.",
  "error": "Not Found",
  "statusCode": 404
}
Retrieve the full details of a license by its key. Unlike POST /api/v1/validate, this endpoint is read-only and has no side effects.
Use the interactive playground on this page to test a lookup request with your product API key and a real license key.

​
Endpoint

GET https://api.keyport.sbs/api/v1/license/:key
Replace :key with the license key you want to look up (e.g. ABCD-EFGH-IJKL-MNOP).

​
Headers

Authorization: Bearer kp_live_xxxxxxxxxxxxxxxxxxxxxxxxx

​
Behavior

This endpoint does not:
  • register an IP address
  • run validate-time business logic
  • change license state in any way
Use it when you need to inspect license metadata — expiry, IP counts, version pins, customer info — without affecting the license.
This endpoint requires the same product API key in the Authorization header as the validate endpoint.

​
Response fields

​
id
string
Unique identifier for the license record.
​
organization_id
string
ID of the organization that owns this license.
​
product_id
string
ID of the product this license belongs to.
​
global_customer_id
string | null
ID of the customer this license is assigned to, if any.
​
license_key
string
The license key string itself.
​
status
string
Current status of the license (e.g. active, revoked, expired).
​
expires_at
string | null
ISO 8601 expiry timestamp. null for lifetime licenses.
​
is_lifetime
boolean
true if the license never expires.
​
ip_system_enabled
boolean
Whether IP-based access control is active for this license.
​
max_ips
number | null
Maximum number of unique IPs allowed. null if the IP system is disabled.
​
current_unique_ip_count
number
Number of unique IPs that have validated with this license so far.
​
notes
string | null
Optional notes attached to the license by your team. null if none were set.
​
version_pin_mode
string | null
The version enforcement mode in use (e.g. pinned, range). null if the version module is disabled.
​
version_pinned
string | null
The exact version pinned to this license, when applicable.
​
version_range_min
string | null
Minimum allowed version when a range is configured.
​
version_range_max
string | null
Maximum allowed version when a range is configured.
​
revoked_at
string | null
ISO 8601 timestamp of when the license was revoked. null if it has not been revoked.
​
created_at
string
ISO 8601 timestamp of when the license was created.
​
updated_at
string
ISO 8601 timestamp of the most recent update to the license record.
​
customer_email
string | null
Email address of the assigned customer.
​
customer_name
string | null
Display name of the assigned customer.
​
customer_discord_id
string | null
Discord user ID of the assigned customer, if provided.

​
Example

curl --request GET \
  --url https://api.keyport.sbs/api/v1/license/ABCD-EFGH-IJKL-MNOP \
  --header 'Authorization: Bearer kp_live_xxxxxxxxxxxxxxxxxxxxxxxxx'

{
  "id": "license_uuid",
  "organization_id": "org_uuid",
  "product_id": "product_uuid",
  "global_customer_id": "customer_uuid",
  "license_key": "ABCD-EFGH-IJKL-MNOP",
  "status": "active",
  "expires_at": null,
  "is_lifetime": true,
  "ip_system_enabled": true,
  "max_ips": 1,
  "current_unique_ip_count": 1,
  "notes": null,
  "version_pin_mode": null,
  "version_pinned": null,
  "version_range_min": null,
  "version_range_max": null,
  "revoked_at": null,
  "created_at": "2026-04-07T00:00:00.000Z",
  "updated_at": "2026-04-07T00:00:00.000Z",
  "customer_email": "customer@example.com",
  "customer_name": "Example Customer",
  "customer_discord_id": null
}

Authorizations

​
Authorization
string
header
required

Use your product API key in the Authorization header.

Path Parameters

​
key
string
required
Example:

"ABCD-EFGH-IJKL-MNOP"

Response

License details returned successfully.

​
id
string
Example:

"license_uuid"

​
organization_id
string
Example:

"org_uuid"

​
product_id
string
Example:

"product_uuid"

​
global_customer_id
string | null
Example:

"customer_uuid"

​
license_key
string
Example:

"ABCD-EFGH-IJKL-MNOP"

​
status
string
Example:

"active"

​
expires_at
string<date-time> | null
Example:

null

​
is_lifetime
boolean
Example:

true

​
ip_system_enabled
boolean
Example:

true

​
max_ips
integer | null
Example:

1

​
current_unique_ip_count
integer
Example:

1

​
notes
string | null
Example:

null

​
version_pin_mode
string | null
Example:

null

​
version_pinned
string | null
Example:

null

​
version_range_min
string | null
Example:

null

​
version_range_max
string | null
Example:

null

​
revoked_at
string<date-time> | null
Example:

null

​
created_at
string<date-time>
Example:

"2026-04-07T00:00:00.000Z"

​
updated_at
string<date-time>
Example:

"2026-04-07T00:00:00.000Z"

​
customer_email
string | null
Example:

"customer@example.com"

​
customer_name
string | null
Example:

"Example Customer"

​
customer_discord_id
string | null
Example:

null