Skip to documentation
AdQuestDocs

Referral evidence

API type: referral. Connect an invite code to a distinct participant’s qualifying action.

On this page

Connect inviter and invitee

  1. Use the inviter’s participant session to start the quest and read getGrowthStatus(id). Display the returned referral code / link.

  2. Capture the shared code in the host app’s onboarding flow.

  3. Sign in the invitee, mint their own participant session and call attributeReferral using the invitee’s client.

  4. Meet the configured attribution target. Refresh the inviter’s growth status and submit completion when their referral requirement is met.

Attribute as the invitee
// inviteeClient must have the INVITEE's participant token and external user ID.
await inviteeClient.attributeReferral(questId, referralCode);
// Later, with the inviter's session:
const status = await inviterClient.getGrowthStatus(questId);
// Once the configured referral requirement is satisfied:
const completion = await questRequest(inviterConfig, questId, "complete");

Verify attribution boundaries

  • Test with two distinct accounts and sessions. A self-referral is not a valid invite.
  • Retain the same code across signup without replacing the inviter’s identity.
  • Respect reused-account/device checks, attribution windows and completion limits.
  • A shared link alone does not earn a reward; show the server’s attribution and reward status.

Next steps

Something unclear, missing or wrong here? Tell us