Member Profile

GET 
/client/users/:correlation_id/profile

Returns member profile details.

Request

Body

This request does not have a body.

Response

Attributes	Definition	Format	Notes
dateOfBirth	Member's date of birth	String
gender	Member's gender	String
firstName	Member's first name	String
lastName	Member's last name	String
email	Member's email	String
businessName	Business name	String
phoneNumber	Member's phone number	String
street	Member's street address	String
street2	Member's street2 address	String
suite	Member's suite or apartment	String
city	Member's city	String
provinceState	Member's province state	String
postalZipCode	Member's postal zip code	String
countryCode	Member's country code	String
languagePreference	Member's language preference	String
registrationDetails	Member's registration details	Object
Referral	Contains data if a member was referred by another member.	Object	Required if member was referred, contains code to rewardCap below
code	Generated referral code for this referral.	String	Unique code in proper format
referrer	Contains data identifying the member who referred this member.	Object	Contains firstName and lastName below; not provided if member was not referred
firstName	First name of the member who referred this member.	String
lastName	Last name of the member who referred this member.	String
currentRewardCount	Total number of times a referral has been issued by the referrer	Number	If the referrer object has not yet been created, the count will be set to "0"
rewardCap	Maximum number of referrals that the referrer can provide	Number

Error Responses

statusCode	errorMessage	errorCode	Definition
400 Bad Request	Must provide a session correlation ID	INVALID_REQUEST	No correlationId has been provided for this session
400 Bad Request	Session correlation ID does not exist--create it first.	INVALID_REQUEST	Invalid correlationId has been provided for this session
400 Bad Request	Route not found	INVALID_REQUEST	When invalid path is provided

Request

Responses

200

200 - Get Member Profile Details

Response Headers

Date
Example: Thu, 19 Oct 2023 12:01:37 GMT
Content-Length
Example: 372
Connection
Example: keep-alive
x-amzn-RequestId
Example: b00098d2-2877-4370-bd5b-5277b8b95298
Referrer-Policy
Example: no-referrer
X-XSS-Protection
Example: 1;mode=block
Access-Control-Allow-Origin
Example: *
MCK-APPID
Example: ES-CB-V1
MCK-MSGID
Example: mck-0c5aa024-5240-446e-aa44-a5bc6881a75d
Expect-CT
Example: max-age=86400
Strict-Transport-Security
Example: max-age=31536000; includeSubDomains; preload
Feature-Policy
Example: vibrate 'none'; geolocation 'none'
X-Frame-Options
Example: sameorigin
Content-Security-Policy
Example: connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.net
MCK-MSGTIMESTAMP
Example: October 19th 2023, 12:01:37
x-amz-apigw-id
Example: NDEZQEQeIAMEMDw=
cache-control
Example: no-cache, no-store, must-revalidate
MCK_CORRELATIONID
Example: CORRELATION_ID_NOT_PROVIDED_IN_REQUEST
X-Content-Type-Options
Example: nosniff
X-Amzn-Trace-Id
Example: Root=1-65311aa1-54d93dee090d3c355b0026e7;Sampled=0;lineage=9855d443:0

400

400 - Invalid Correlation ID

Response Headers

Date
Example: Thu, 19 Oct 2023 12:04:53 GMT
Content-Length
Example: 121
Connection
Example: keep-alive
x-amzn-RequestId
Example: da05b550-8212-4cb8-a956-0f8a10134f44
Referrer-Policy
Example: no-referrer
X-XSS-Protection
Example: 1;mode=block
Access-Control-Allow-Origin
Example: *
MCK-APPID
Example: ES-CB-V1
MCK-MSGID
Example: mck-16511f3f-cec6-4a85-a58f-aa1498b1a7da
Expect-CT
Example: max-age=86400
Strict-Transport-Security
Example: max-age=31536000; includeSubDomains; preload
Feature-Policy
Example: vibrate 'none'; geolocation 'none'
X-Frame-Options
Example: sameorigin
Content-Security-Policy
Example: connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.net
MCK-MSGTIMESTAMP
Example: October 19th 2023, 12:04:52
x-amz-apigw-id
Example: NDE3zHdCIAMEahA=
cache-control
Example: no-cache, no-store, must-revalidate
MCK_CORRELATIONID
Example: CORRELATION_ID_NOT_PROVIDED_IN_REQUEST
X-Content-Type-Options
Example: nosniff
X-Amzn-Trace-Id
Example: Root=1-65311b64-534391f064670b7f0686c2e2;Sampled=0;lineage=9855d443:0

404

404 - Invalid Path

Response Headers

Date
Example: Thu, 19 Oct 2023 12:06:32 GMT
Content-Length
Example: 27
Connection
Example: keep-alive
x-amzn-RequestId
Example: 4012b02e-d7ef-4a2b-9301-6573fdbd84f8
Referrer-Policy
Example: no-referrer
X-XSS-Protection
Example: 1;mode=block
Access-Control-Allow-Origin
Example: *
MCK-APPID
Example: ES-CB-V1
MCK-MSGID
Example: mck-f56fa8f2-1470-497e-9fcc-07cd1257c013
Expect-CT
Example: max-age=86400
Strict-Transport-Security
Example: max-age=31536000; includeSubDomains; preload
Feature-Policy
Example: vibrate 'none'; geolocation 'none'
X-Frame-Options
Example: sameorigin
Content-Security-Policy
Example: connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.net
MCK-MSGTIMESTAMP
Example: October 19th 2023, 12:06:32
x-amz-apigw-id
Example: NDFHaGD_IAMEMDw=
MCK_CORRELATIONID
Example: CORRELATION_ID_NOT_PROVIDED_IN_REQUEST
X-Content-Type-Options
Example: nosniff
X-Amzn-Trace-Id
Example: Root=1-65311bc8-588708c63b86cdcf2a558473;Sampled=0;lineage=9855d443:0