---
title: "Register referee"
method: POST
path: "/api/consumer/{version}/referee/register"
tags: ["Link new customer to referrer"]
---

# Register referee

`POST /api/consumer/{version}/referee/register`

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).

## Path parameters

- `version` 'v2' | 'v1', required

## Request body

- EnrolRefereeType
  - `referrerMentionMeIdentifier` integer, required — Id representing the referrer returned by a successful name search
  - `referrerToken` string, required — Token representing the referrer returned by a successful name search
  - `customer` CustomerDetails, required
    - `emailAddress` string, required — Customer email address
    - `title` string — Customer title such as Mr, Miss, Dr or Sir
    - `firstname` string, required — Customer firstname
    - `surname` string, required — Customer surname
    - `uniqueIdentifier` string — Your unique identifier for this customer e.g. CustomerId
    - `segment` string — Customer segment - a string containing segment data about this customer, e.g. vip or employee. You can concatenate multiple segments together if you wish using hyphens.
    - `customField` string — Custom field - a string containing custom data about this customer, e.g. SEGMENT001 or Package B
    - `visitorId` string — The visitor ID from the MentionMe Browser Fingerprint, used to link customer journeys. This should be a SHA256 hash (browserId + clientIP).
  - `request` Request, required
    - `partnerCode` string, required — Your partner code, used to link to your users and offers
    - `situation` string, required — Situation - a string representing where in the application you are making this request
    - `segment` string — Segment - the segment the customer belongs to
    - `localeCode` string, required — Locale code - ISO standard locale code (e.g. en_GB) for the locale you expect the content to be in
    - `ipAddress` string — IP address of the customer connection. If you're making a request on behalf of a customer, pass their IP address here. If the customer will connect directly, leave this empty and we will retrieve this from their request.
    - `userDeviceIdentifier` string — User Device Identifier should be a unique reference to this device. We use this for preventing gaming. Multiple users with the same Device Identifier will be treated as the same individual and may be flagged for gaming. On Android the UniqueID could be an InstanceID or GUID. On iPhone the UniqueID should be generated by identifierForVendor.
    - `deviceType` string — Device type - your description of the device the user is using. We use this for performance and conversion optimisation.
    - `appName` string — Your application name. Used for reporting.
    - `appVersion` string — Your application version reference. Used for reporting and troubleshooting.

## Response `200`

Returned when successful

- RefereeRegister
  - `offer` Offer
    - `id` integer
    - `localeCode` string
    - `headline` string — e.g. "You can get a £20 gift card if you refer a friend to ..."
    - `description` string — e.g. "Give your friends a 20% off introductory offer"
    - `callToAction` string — e.g. "Get a £20 gift card"
    - `privacyNotice` string — e.g. "Get a £20 gift card"
    - `privacyLink` string — e.g. "https://mention-me.com/help/privacy_policy"
    - `referrerReward` Reward
      - `description` string — The description we give may vary depending on the point in the flow that we choose to give it. Note that in some cases this might be "promising the reward" and in other cases "giving it". e.g. "You'll get £20 for each friend you refer" e.g. "Your friends get a free camera when they order for the first time" e.g. "A 20% discount code"
      - `summary` string
      - `amount` string
    - `refereeReward` Reward
      - `description` string — The description we give may vary depending on the point in the flow that we choose to give it. Note that in some cases this might be "promising the reward" and in other cases "giving it". e.g. "You'll get £20 for each friend you refer" e.g. "Your friends get a free camera when they order for the first time" e.g. "A 20% discount code"
      - `summary` string
      - `amount` string
  - `refereeReward` RefereeReward
    - `description` string
    - `couponCode` string
    - `securityCode` string
    - `url` string
    - `amount` string
  - `content` ContentCollectionLink
    - `relationship` string
    - `resource` Content[]
      - `key` string
      - `content` string
  - `termsLinks` TermsLinks
    - `localeCode` string
    - `linkToTermsInLocale` string
  - `status` string

## Other responses

- `400` — The request contains errors
- `403` — Returned when the integration for this merchant is not enabled
- `404` — Returned when the referrer is not found
- `500` — Internal server error, unable to complete the request

---

[API](https://skmtc.net/mention-me/apis/auth-api.md) · [All operations](https://skmtc.net/mention-me/apis/auth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mention-me/auth-api/versions/cdad84f071bd/schema)