Errors

The Licentric API uses standard HTTP status codes and returns a consistent error response format for all error conditions.

Error Response Format

All error responses share the same JSON envelope: a human-readable message in error, a machine-readable code you can branch on, optional structured details (Zod issues, rate-limit metadata, etc.), and a requestId you can quote when filing a support ticket. The HTTP status itself is on the response, not the body.

{
  "error": "Human-readable description of the error",
  "code": "ERROR_CODE",
  "details": { "issues": [{ "path": ["productId"], "message": "Required", "code": "invalid_type" }] },
  "requestId": "01J8X3W4Y5Z6A7B8C9D0EFGHJK"
}

Example Errors

Validation Error

{
  "error": "Validation failed",
  "code": "VALIDATION_ERROR",
  "details": {
    "issues": [
      { "path": ["productId"], "message": "Required", "code": "invalid_type" }
    ]
  }
}

Authentication Error

{
  "error": "Invalid or expired API key",
  "code": "UNAUTHORIZED"
}

Conflict Error

{
  "error": "Cannot suspend a revoked license",
  "code": "CONFLICT"
}

HTTP Status Codes