QFqfex
user

Redeem Invitation Code

Changed on

Redeem a valid invitation code for the authenticated user, create the referral link, and enable user access.

post/redeem-invitation-code

Request

  • Base URL
    https://api.qfex.com
  • URL
    https://api.qfex.com/redeem-invitation-code
  • Auth
    API key in header x-qfex-hmac-signature and API key in header x-qfex-nonce and API key in header x-qfex-public-key and API key in header x-qfex-timestamp

Query parameters

api_versionstring
Example:2026-10-30

Published API contract date. Omit or use latest for the latest contract; explicit dates stay pinned. Applies to request validation and response format.

Request body

$schemastring uri

A URL to the JSON Schema for this object.

invitation_codestring required

Example request

{
  "$schema": "https://api.qfex.com/contracts/2026-10-30/schemas/RedeemInvitationCodeRequestBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

invitation_codestring required
is_redeemedboolean required
messagestring required
sharer_user_idstring uuid required

Example response

{
  "$schema": "https://api.qfex.com/contracts/2026-10-30/schemas/RedeemInvitationCodeResponseBody.json"
}

Changes