Mobile User (Object)

The user object includes the details of the users who are registered on a particular business.

address
Type: string

Address of the user
age_verified_status
Type: boolean

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.
anniversary
Type: string

Anniversary date of the user, in YYYY-MM-DD format
apple_signup
Type: boolean

Whether the user has an Apple sign-up or not. This will return true for the first time sign-up.
apple_uid
Type: string

Unique ID generated by Apple
avatar_remote_url
Type: string | null

URL of the user's profile image uploaded to an online file storage system. This will be used for users who signed up using email.
birthday
Format: date-timeenum
const:
YYYY-MM-DD

Date of birth of the user, in YYYY-MM-DD format
city
Type: string

City where the user lives
communicable_email
Type: string

The email address used for communication with the user
created_at
Format: date-timeenum
const:
YYYY-MM-DDThh:mm:ssZ

Date/time when the user was created in the system, in ISO 8601 format
email
Type: string

Unique email address used to identify the user
email_verified
Type: boolean

Whether the email address of the user has been verified or not
facebook_signup
Type: boolean

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.
favourite_locations
Type: string

List of the user's favorite locations
favourite_store_numbers
Type: string

List of store numbers of the user's favorite locations
fb_uid
Type: string | null

Facebook ID that identifies the user
first_name
Type: string

First name of the user
gender
Type: string

Gender of the user
has_generated_fb_email
Type: boolean

Whether the user has generated a Facebook email or not
last_name
Type: string

Last name of the user
marketing_email_subscription
Type: boolean

Whether the user has subscribed to receive marketing emails or not
marketing_pn_subscription
Type: boolean

Whether the user has subscribed to marketing push-notifications or not
migrate_status
Type: boolean

Whether the user has a migrate status or not
passcode_configured_for_giftcards
Type: boolean

Whether the user has configured a passcode for gift cards or not
phone
Type: integer

Phone number of the user
profile_field_answers
Type: object

Answers given by the user while filling out the user profile.
referral_code
Type: string

Referral code of the user
referral_path
Type: string

Referral URL of the user
secondary_email
Type: string

The secondary email address of the user is configured when a user signs up with Facebook but does not share the email address. The app asks for an alternate email address, which is kept as the secondary_email.
sms_subscription
Type: boolean

Whether the user has subscribed to SMS services or not
state
Type: string

State where the user lives
superuser
Type: boolean

Whether multiple check-ins are allowed for a user. This is used mostly for testing purposes by developers.
terms_and_conditions
Type: boolean

Whether the terms and conditions of a business have been accepted by a user or not
title
Type: string | null

Salutation as selected by the user
updated_at
Format: date-timeenum
const:
YYYY-MM-DDThh:mm:ssZ

Date/time when user was updated in the system, in ISO 8601 format
user_as_barcode
Type: string

Barcode that identifies the user
user_as_qrcode
Type: string

QR code that identifies the user
user_code
Type: string

A unique ID that identifies the user. This smaller code can be converted to a QR code in the app and scanned at some POS systems that do not support longer codes. Alternatively, a user could give this to the POS operator if the POS does not have a scanner.
user_id
Type: integer

ID that identifies the user
user_relations
Type:

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.

Properties: 4
verification_mode

Mode of verification (available only for a user in awaiting migration state)
zip_code
Type: string

Zip code where the user lives

Messages (Object)

Notifications (Object)