Referral

A Referral is an invitation link that a partner generates to onboard and connect other WorldFirst accounts. Each link carries a mode that determines how attributions are counted and whether the invited account grants permissions back to the partner.
Referrals support two modes. In
CONNECTED_ONLY
mode, a single link can attribute multiple registrations and only establishes an account association. In
AUTHORIZED
mode, a link is a one-to-one directed invitation that establishes the association and activates the specified authorization scopes granted by the invited account. Use this API to create invitation links and to query a link's current status and attribution details.
Important: This endpoint is available to approved partners only. Contact us at techsupport@worldfirst.com — our team is ready to assist you.

Endpoints

Enum Reference

The following enum types are used across Referral endpoints.

ReferralType

AuthorizationScope

ReferralStatus

InvitedAccountStatus