GET/api/v2/users/check-referral

Check if a referral code is valid for a company

Authentication

Send your API key in the x-api-key header on every request.

Request parameters
Field	Type	Required	Description
referralCode (query)	string	No	The referral code to validate
visitorId (query)	string	No	Optional per-install visitor id (at most 64 chars). When the code is a live campaign link, the visit is recorded as a click, once per visitor per UTC day (crawlers and previews are skipped). Without it nothing is recorded.

200 — OK

Response 200 fields
Field	Type	Required	Description
Valid	boolean	No
TierId	unknown	No
Kind	string	No
Provider	string	No
InviterDisplayName	string	No
WelcomeAmount	unknown	No	Welcome reward the referred user receives at qualification (0 when the program pays none).
WelcomeCurrency	string	No
TermsVersion	unknown	No	Current referral program terms version, echoed back as ReferralTermsVersion at registration.
Destination	string	No	Campaign links only: where the client should route the visitor after sign-up (signup, home, cards, topup, rewards).

400 — Bad Request

Response 400 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

404 — Not Found

Response 404 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

500 — Internal Server Error

Response 500 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

curl -X GET "https://{base_url}/api/v2/users/check-referral" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.