referral

Check for pending referral

Called by the app on first launch to retrieve deferred deep link referral information.

post/referral/check-pending

Request body

device_fingerprintstring required

Device fingerprint/identifier (device ID, advertising ID, etc.)

ip_addressstring

IP address (optional, for additional matching)

user_agentstring

User agent string (optional)

platformstring

Platform (android, ios, etc.)

claiming_member_idstring

Member ID of the user claiming the referral (optional, if user is already registered)

Example request

{
  "device_fingerprint": "device-uuid-12345",
  "ip_address": "192.168.1.1",
  "user_agent": "Mozilla/5.0...",
  "platform": "android",
  "claiming_member_id": "TWE-789012"
}

Response

Pending referral check result

has_pending_referralboolean required

Whether a pending referral was found

referrer_member_idstring

Referrer member ID if found

utm_sourcestring

UTM source if available

utm_mediumstring

UTM medium if available

utm_campaignstring

UTM campaign if available

Example response

{
  "has_pending_referral": true,
  "referrer_member_id": "TWE-123456",
  "utm_source": "facebook",
  "utm_medium": "social",
  "utm_campaign": "summer2024"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.