---
title: "Find a friend by name"
method: POST
path: "/api/entry-point/{version}/referee"
tags: ["Referee"]
---

# Find a friend by name

`POST /api/entry-point/{version}/referee`

Provide some details of a referee (optional - if you have them) and some context (such as locale) so we can tell you if we can serve a name finder journey. We'll provide the URL to the web-view for their journey.

Given a set of input parameters about the referee (and segment etc), decide if we could serve them a referee
name finder journey and give them a link to the web view for doing that.

If you choose to direct the consumer to the URL via an iframe, the closing of the journey and the fulfillment of any coupon is done via postMessage. If you send the consumer to the URL they will close the flow using the browser itself and the CTA at the end is the defined CTA URL to take them to the next step of their journey.

## Path parameters

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

## Request body

- EntryPointForRefereeType
  - `customer` Referee
    - `emailAddress` string — Customer email address
    - `title` string — Customer title such as Mr, Miss, Dr or Sir
    - `firstname` string — Customer firstname
    - `surname` string — Customer surname
    - `uniqueIdentifier` string — Your unique identifier for this customer e.g. CustomerId
  - `request` RequestWithVariation, 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.
    - `variation` string — Variation - an index (0,1,2...) specifying which of the currently running AB tests to choose (if available)
  - `implementation` ImplementationDetails
    - `wrapContentWithBranding` boolean — If true (default), serve content in the URLs with customisable branding wrapper (normally a logo and padding). If false, serve content without any wrapping.
    - `showCloseIcon` boolean — If true (and the page is rendered inside an iframe), Mention Me will include a close icon. A user clicking on the close icon will trigger a postMessage event which can be listened to for closing the iframe. Documentation is available at https://docs.mention-me.com/developer-docs/advanced/postmessage-iframe

## Response `200`

Returned when successful

- EntryPointLink
  - `url` string
  - `defaultCallToAction` string

## Other responses

- `404` — Returned when this specific integration point has been disabled
- `422` — Data had validation errors
- `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)