Skip to content
ReadyZone Docs
API Reference

Start free offer

Start a free-offer request with or without OTP.

POST /api/portal/free-offer/start

Access: Public

Request body

{
  "companyReference": "readyzone-center-12345",
  "planId": "plan_uuid",
  "phone": "699112233",
  "macAddress": "AA:BB:CC:DD:EE:FF",
  "ipAddress": "192.168.88.20",
  "userAgent": "Mozilla/5.0"
}

companyReference, planId, and phone are required. macAddress is required for offers limited to a smart device.

Response

{
  "claimToken": "claim_token",
  "otpRequired": true,
  "expiresAt": "2026-10-17T12:00:00.000Z",
  "plan": {
    "id": "plan_uuid",
    "name": "Free discovery",
    "type": "smart-device-based",
    "frequency": "daily"
  }
}
AttributeTypeDescription
claimTokenstringTemporary token passed to the verification step.
otpRequiredbooleanWhether an OTP must be entered.
expiresAtstring (ISO 8601)Claim expiration date.
planobjectSummary of the selected free plan.

Status codes

  • 200 OK
  • 400 Bad Request (invalid data)
  • 404 Not Found (offer or zone not found)
  • 409 Conflict (offer already claimed)
  • 429 Too Many Requests (anti-abuse limit)

On this page