Find a friend

get

https://mention-me.com/api/consumer/{version}/referrer/search

Search for a referrer by name (or email) to allow your customer to find their friend via NameShare.

If an exact match is found, we will return a 200 response. The 200 response will include the referrerMentionMeIdentifier and referrerToken. You should next collect the referee's details (i.e. their email address) and register them with the "Register referee" API. Completion of the registration with a valid email, referrerMentionMeIdentifier and referrerToken will allow the referee to gain their reward.

If no exact match is found, we will return a 404 response. A 404 may indicate we didn't find anyone, or it may indicate that we found multiple people with the same name. If we did find multiple people with the same name, we will also set the foundMultipleReferrers parameter in the root of the response to true.

If foundMultipleReferrers is set to true, the client should prompt the referee to narrow down the search, e.g. by entering the email address of the referrer. The exact narrowing strategy is up to the client.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

version

string

enum

required

Version

Allowed:

Query Params

name

string

required

Name of a referrer to search for (entered by the new customer)

string

Optionally ask the new customer to qualify the name with an email address belonging to the referrer. We typically ask for a Name first and then if no matches found, offer Name + Email address.

request[partnerCode]

string

required

Your partner code, used to link to your users and offers

request[situation]

string

required

Situation - a string representing where in the application you are making this request

request[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.

request[localeCode]

string

required

Locale code - ISO standard locale code (e.g. en_GB) for the locale you expect the content to be in

request[userDeviceIdentifier]

string

User Device Identifier should be a unique reference to this combination of app + user.

request[deviceType]

string

Device type - your description of the device the user is using. We use this for performance and conversion optimisation.

request[appName]

string

Your application name. Used for reporting.

request[appVersion]

string

Your application version reference. Used for reporting and troubleshooting.

Responses

403

Returned when the integration for this merchant is not enabled

404

Returned when it is not possible to find a match for this search

500

The request contains errors

503

The service was unavailable, try again shortly

200Returned when successful