ConsumerApi

ReferFriendLinkUsedRequest

Consumer

The following routes are available for this service:
POST	/share/refer-friend-link-used	A friend referral link was used	Validates the JWT token with the identity of the referring user and returns relevant information.

**ReferFriendLinkUsedRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ReferFriendToken	body	string	Yes

**ReferFriendLinkUsedResponse** Parameters:
Name	Parameter	Data Type	Required
ReferringUser	form	ReferFriendUser	No
ExpiresAt	form	DateTimeOffset?	No
State	form	ReferFriendState	No

**ReferFriendUser** Parameters:
Name	Parameter	Data Type	Required
FirstName	form	string	No
LastName	form	string	No
ProfilePhotoUrl	form	string	No

**ReferFriendState** Enum:
Available
Awarded
CanNotReferYourself
YouWereAlreadySignedUp
Expired

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /share/refer-friend-link-used HTTP/1.1 
Host: consumer-api.brovs.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	referFriendToken: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	referringUser: 
	{
		firstName: String,
		lastName: String,
		profilePhotoUrl: String
	},
	expiresAt: 0001-01-01T00:00:00.0000000+00:00,
	state: Available
}