User (Object)

Email address of the user

Security token that identifies the user

Address information (part 1) of the user

Whether or not the user has undergone age verification. Possible Values: true, false. The value is set to true if the user's age is verified; otherwise, it is set to false. The response returns this parameter in sign-in, sign-up, and user update APIs if the age verification is enabled for the business in the Punchh platform. Contact your Punchh representative to update this Punchh platform configuration setting.

Whether multiple check-ins are allowed for the user or not

Whether the user has allowed push notifications or not

Anniversary of the user in YYYY-MM-DD format. This field gets updated in the database only if the user did not set it at time of sign-up.

The authentication token of the user. You can retrieve this from the response of a successful sign-in API call or through the SSO process.

Avatar URL of the user profile image

Birthday of the user, in YYYY-MM-DD format. This field gets updated in the database only if the user did not set it at time of sign-up.

City where the user lives

Email address where emails should be sent

Date/time when the user was created in the system, in ISO 8601 format

Unsubscribed email address of the user

Whether the email address is verified or not

This value will be returned only if "Account re-evaluation strategy" is set to Guest Inactivity. All other cases return a NULL value.

Indicates whether the user signed up using Facebook. This parameter returns true the first time a user signs up using Facebook. For all subsequent logins, it returns a false value.

List of the user's favorite locations

List of store numbers of the user's favorite locations

Unique Facebook ID of the user

First name of the user

Gender of the user

Unique ID of the user

Last name of the user

Whether the user has subscribed to receive marketing emails or not

Whether the user has subscribed to receive marketing push notifications or not

Whether the user has been migrated or not

Whether the passcode has been configured or not

Phone number of the user

Preferred locale of the user

Answers given by the user while filling in the user profile. The user submits answers to profile field questions that are configured in the Punchh platform. A total of 25 answers can be submitted. The keys range from 'upf0' to 'upf24'. If questions have multiple answers, the values should be separated by a | character (pipe).

The user's referral code. The user can share this referral code to refer others to join the business loyalty program. When a referred user signs up and enters the shared referral code, this referral_code must be passed in the invite_code request parameter when calling the Create New User API.

URL that points to the referred path

Secondary email address of the user

Whether the user has subscribed to SMS services or not

State where the user lives

Whether the user has agreed to the terms and conditions to use the app as per the configuration

Title used for the user (e.g., Mr., Mrs., etc.)

Date/time when the user was updated in the system, in ISO 8601 format

Unique user ID in barcode format

Unique user ID in QR code format

Unique user ID

Sign-up anniversary date of the user, in YYYY-MM-DDThh:mm:ssZ format

The object contains information about the relationship details of a user, for example, spouse and kid information. If the user account does not have relationship details, the API returns an empty user_relations object in the response.

Whether the user wants to receive menu notifications or not

Zip code of the user's office

Zip code of the user