User Info (Object)

Includes details about the users who are registered on a particular business

  • access_token
    Type: string

    Access token of the user that identifies the user making the API request

  • address_line1
    Type: string

    Address of the user

  • age_verified
    Type: boolean

    Whether the age of the user is verified or not

  • 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.

  • allow_multiple
    Type: boolean

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

  • allow_push_notifications
    Type: boolean

    Whether the user has subscribed to receive push notifications or not

  • anniversary
    Type: stringFormat: date

    Anniversary date of the user, in YYYY-MM-DD format

  • apple_pass_url
    Type: string

    URL that a user can use to download the user's associated loyalty Apple pass

  • authentication_token
    Type: string

    Authentication token of the user that identifies the user making the API request

  • avatar_remote_url
    Type: string

    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.

  • balance
    Type:

    Contains information about the account balance of the user

    Properties: 16
  • birthday
    Type: stringFormat: date

    Date of birth of the user, in YYYY-MM-DD format

  • city
    Type: string

    City where the user lives

  • communicable_email
    Type: string

    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 system, in ISO 8601 format

  • discount_type
    Type: string

    The type of discount. The values can be redeemable, discount_amount, card_completion, redemption_code, fuel_reward, and subscription.

  • email
    Type: string

    Unique email address of the user

  • email_unsubscribe
    Type: boolean

    Whether the user has unsubscribed to email notifications or not

  • email_verified
    Type: boolean

    Whether the email address of the user has been verified or not

  • expiration_date
    Type: stringFormat: date

    Last user inactivity date increased by inactive days set for the business. This value is returned only if "Account re-evaluation strategy" is set to Guest Inactivity. All other cases return a NULL value.

  • facebook_signup
    Type: boolean

    Whether the user has a Facebook sign-up or not

  • 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

    Facebook ID that identifies the user

  • first_name
    Type: string

    First name of the user

  • force_password_reset
    Type: boolean

    Whether the password of the user matches the password policy set in the Punchh platform or not

  • gender
    Type: string

    Gender of the user

  • google_pass_url
    Type: string

    URL that a user can use to download the user's associated loyalty Google pass

  • id
    Type: integer

    Punchh ID of the user

  • 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
    Type: boolean

    Whether the passcode has been configured or not

  • phone
    Type: string

    Phone number of the user

  • preferred_locale
    Type: string

    Preferred locale of the user

  • privacy_policy
    Type: boolean

    Whether the user has agreed to the privacy policy to use the app as per the configuration or not

  • profile_field_answers
    Type: object

    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).

    Properties: 3
  • referral_code
    Type: string

    Referral code of the user

  • referral_path
    Type: string

    Referral URL of the user

  • rewards
    Type:

    Contains information about the available rewards of the user. If a user account does not have rewards, the API returns an empty object in the response.

    Properties: 13
  • secondary_email
    Type: string

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

  • selected_card_number
    Type: string

    This value is set only in single scan flow. This is the gift card that the user wants to use to make a payment. If this value is set, use it to make the payment for the order.

  • selected_discount_amount
    Type: string

    This value is set only in single scan flow. This is the discount amount that the user wants to redeem.

  • selected_reward_id
    Type: string

    This value is set only in single scan flow. This is the reward ID that the user wants to redeem.

  • sms_subscription
    Type: boolean

    Whether the user has subscribed to SMS services or not

  • state
    Type: string

    State in which the user lives

  • subscriptions
    Type:

    Contains information about different subscriptions issued to the user. This object is returned when the subscriptions feature is available for the business. If a user does not have active subscriptions, the API returns an empty object in the response.

    Properties: 3
  • terms_and_conditions
    Type: boolean

    Whether the terms and conditions of a business have been accepted by a user or not

  • test_user
    Type: boolean

    Whether the user is allowed to switch the environment in the mobile application or not

  • title
    Type: string

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

  • updated_at
    Format: date-timeenum
    const:  
    YYYY-MM-DDThh:mm:ssZ

    Date/time when the 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 used to identify the user. This smaller code can be converted to a QR code in the app and scanned at POS systems that do not support longer codes. Alternatively, a user can provide this to the POS operator if the POS device does not have a scanner.

  • user_id
    Type: string

    ID that identifies the user

  • user_joined_at
    Format: date-timeenum
    const:  
    YYYY-MM-DDThh:mm:ssZ

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

  • user_relations
    Type:

    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 object in the response.

    Properties: 4
  • work_zip_code
    Type: string

    Zip code of the user's office

  • zip_code
    Type: string

    Zip code of the user

Examples 
{
  "address_line1": "",
  "anniversary": null,
  "avatar_remote_url": null,
  "birthday": null,
  "city": "",
  "created_at": "2023-04-04T09:05:19Z",
  "email": "test@example.com",
  "email_verified": false,
  "fb_uid": null,
  "first_name": "FIRST_NAME_GOES_HERE",
  "age_verified": false,
  "privacy_policy": true,
  "gender": "male",
  "id": 111111111,
  "last_name": "LAST_NAME_GOES_HERE",
  "state": "",
  "updated_at": "2023-09-12T05:39:28Z",
  "zip_code": null,
  "test_user": false,
  "user_joined_at": "2023-04-04T09:05:19Z",
  "balance": {
    "banked_rewards": "2.00",
    "membership_level": "Bronze",
    "membership_level_id": 109,
    "net_balance": 2,
    "net_debits": 0,
    "pending_points": 0,
    "points_balance": 0,
    "signup_anniversary_day": "04/04",
    "total_credits": 15,
    "total_debits": "0.0",
    "total_point_credits": 15,
    "total_redeemable_visits": 1,
    "expired_membership_level": "Bronze",
    "total_visits": 0,
    "initial_visits": 1,
    "unredeemed_cards": 0
  },
  "selected_card_number": null,
  "selected_reward_id": null,
  "selected_discount_amount": null,
  "rewards": [
    {
      "id": 31300354648,
      "created_at": "2023-10-01T18:05:42Z",
      "end_date_tz": "2023-10-05T18:29:59Z",
      "start_date_tz": "2023-10-01T18:05:42Z",
      "updated_at": "2023-10-01T18:05:42Z",
      "image": "IMAGE_URL_GOES_HERE",
      "status": "unredeemed",
      "points": 100,
      "discount_amount": 10,
      "description": "Free Sandwich with Purchase of Chips and Drink",
      "name": "Free Sandwich with Purchase of Chips and Drink",
      "redeemable_properties": ""
    },
    {
      "id": 31300354654,
      "created_at": "2023-10-01T18:05:42Z",
      "end_date_tz": "2023-10-14T18:29:59Z",
      "start_date_tz": "2023-10-01T18:05:42Z",
      "updated_at": "2023-10-01T18:05:42Z",
      "image": "IMAGE_URL_GOES_HERE",
      "status": "unredeemed",
      "points": 0,
      "discount_amount": 10,
      "description": "Free Drinks",
      "name": "Welcome Series Free Gift",
      "redeemable_properties": ""
    }
  ],
  "discount_type": null,
  "allow_multiple": false,
  "apple_pass_url": "APPLE_PASS_URL_GOES_HERE",
  "google_pass_url": "GOOGLE_PASS_URL_GOES_HERE",
  "authentication_token": "AUTHENTICATION_TOKEN_GOES_HERE",
  "favourite_locations": "306082,333070,304374",
  "favourite_store_numbers": "12345,0604,1234",
  "marketing_email_subscription": true,
  "marketing_pn_subscription": true,
  "passcode_configured": false,
  "profile_field_answers": {
    "test1": "Option 1"
  },
  "referral_code": "REFERRAL_CODE_GOES_HERE",
  "referral_path": "URL_GOES_HERE",
  "secondary_email": "test@example.com",
  "terms_and_conditions": false,
  "title": "",
  "user_as_barcode": "1111111",
  "user_as_qrcode": "QR_CODE_GOES_HERE",
  "user_code": "P11111111",
  "user_id": 111111111,
  "user_relations": [
    {
      "id": 111111111,
      "relation": "spouse",
      "name": "FIRST_NAME_GOES_HERE LAST_NAME_GOES_HERE",
      "birthday": "1999-01-01",
      "created_at": "2023-08-18T12:32:13Z",
      "updated_at": "2023-08-18T12:32:13Z"
    }
  ],
  "work_zip_code": null,
  "preferred_locale": "en",
  "force_password_reset": null,
  "expiration_date": null,
  "sms_subscription": true,
  "phone": "1111111111",
  "migrate_status": false,
  "email_unsubscribe": false,
  "allow_push_notifications": true,
  "facebook_signup": false,
  "communicable_email": "test@example.com",
  "access_token": "ACCESS_TOKEN_GOES_HERE",
  "subscriptions": [
    {
      "plan_name": "free burger",
      "pos_meta": "VIP subs",
      "subscription_id": 123
    }
  ]
}
Previous
User (Object)
Next
User Input (Object)
Copyright © 2026 PAR Technology Corporation. All rights reserved.
PAR Technology Corporation 8383 Seneca Turnpike, Suite 3 New Hartford, New York 13413 (315) 738-0600 legal@partech.com. PAR Tech is a leading global provider of software, systems, and service solutions to the restaurant and retail industries. You may learn about its product offerings here.
Before using this application, please read the PAR Tech Terms of Use. In addition, the sample applications of PAR Technology are licensed under the terms of the O'Saasy License.