v1

latestOpenAPI 3.0.02026-07-22207183.5 KB

Link new customer to referrer

Register referee

After a successful response from the "Find friend" API, this endpoint allows you to register a new customer to confirm the relationship between the Referee (the friend) and the Referrer (the person who referred them).

Confirming the registration requires the referrerMentionMeIdentifier and referrerToken from the search API response.

To complete the registration, you will need to confirm the registration details of the referee via this API. This will grant the referee their reward, or will inform them on how to obtain one if further action is required (e.g. making a purchase).

post/api/consumer/{version}/referee/register

Path parameters

version'v2' | 'v1' required

Version

Request body

referrerMentionMeIdentifierinteger required

Id representing the referrer returned by a successful name search

referrerTokenstring required

Token representing the referrer returned by a successful name search

Example request

{
  "customer": {
    "emailAddress": "jane.doe@example.com"
  },
  "request": {
    "partnerCode": "[YOUR-PARTNER-CODE]",
    "situation": "mobile-app",
    "segment": "vip",
    "localeCode": "en_GB",
    "ipAddress": "127.0.0.1",
    "appVersion": "e.g. MyApp/v1.73"
  }
}

Response

Returned when successful

statusstring