Skip to content
ReadyZone Docs
API Reference

Verify free offer

Verify the OTP and assign the free offer.

POST /api/portal/free-offer/verify

Access: Public

Request body

{
  "claimToken": "claim_token",
  "otp": "4920",
  "macAddress": "AA:BB:CC:DD:EE:FF"
}

claimToken is required. otp is required when the previous request returns otpRequired: true.

Response body

{
  "success": true,
  "claimId": "claim_uuid",
  "purchaseId": "purchase_uuid",
  "sessionId": "session_uuid",
  "username": "AA:BB:CC:DD:EE:FF",
  "password": "generated-password",
  "accessMode": "credentials"
}
AttributeTypeDescription
successbooleanConfirms activation.
claimIdstringClaim identifier.
purchaseIdstringCreated purchase identifier.
sessionIdstring or nullCreated or associated session.
usernamestringUsername when accessMode is credentials.
passwordstringReturned only for credentials mode.
accessModestringcredentials or mac. In mac mode, the user must reconnect the device.
idempotentbooleanPresent when the same claim is confirmed again.

Status codes

  • 200 OK
  • 400 Bad Request (invalid OTP or token)
  • 404 Not Found (claim not found)
  • 409 Conflict (claim already processed)
  • 429 Too Many Requests (anti-abuse limit)

On this page