Create New User

pos_create_user

Create New User

This API creates a new user account by using phone or email or card (at least one of them).

Headers

Authorization
Type: string
required

This is a combination of unique API key as well as business key (UUID) as the Authorization header.

Body

application/json

For authentication, the location key token must be provided as a parameter.

Using a Loyalty Card

Card numbers are generated in the Punchh platform. By using a card, an end-user can earn loyalty without registering. A business usually distributes physical cards to end-users with a PIN. The cards are scanned by the barcode reader at the POS. Card numbers are usually 16 digits.

address_line1
Type: string

Address of the user
age_verified_status
Type: boolean

Whether or not the user has undergone age verification by Koupon Media. Possible values: true, false. The parameter is accepted in the request if Koupon Media is selected as the age verification adapter for the business in the Punchh platform. Contact your Punchh representative to update this Punchh platform configuration setting.
birthday
Format: dateenum
const:
YYYY-MM-DD

Birth date of the user
- YYYY-MM-DD
card_number
Type: string

Loyalty card number of the user
city
Type: string

City in which the user lives
email
Type: string

Email address of the user
favourite_locations
Type: string

List of favorite locations of the end-user. You can fetch location_name and location_id from the Location Configuration API. The parameter accepts an empty value ("") for the blank favorite locations list.
first_name
Type: string

First name of the user
gender
Type: string

Gender of the user (i.e., male ,female, or declined)
last_name
Type: string

Last name of the user
phone
Type: string
required

Phone number of the user. The phone number parameter accepts various formats, including 1111-111-111, 111-111-1111, or 1111111111.
send_compliance_sms
Type: boolean

Send true in order to trigger a compliance / opt-in SMS for the user. Possible values - True, true, False, false. Both terms_and_conditions and send_compliance_sms must be set to "true" for the API to trigger a compliance (opt-in) SMS.

Responses

200
Type: object
address_line1
Type: string

Address of the user

age_verified
Type: boolean

Is the age of the user verified or not

age_verified_status
Type: boolean

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

anniversary
Format: dateenum
const:
YYYY-MM-DD

Anniversary of the user in YYYY-MM-DD format

YYYY-MM-DD
avatar_remote_url
Type: string

Avatar URL of the user profile image

balance
Type: Balance

Balance Object

birthday
Type: string

Birthday date of the user in YYYY-MM-DD format

city
Type: string

City in which the user lives

created_at
Type: string

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

discount_type
Type: string

Discount type. e.g., 'card_completion' || 'reward' || 'discount_amount' || 'redemption_code'

email
Type: string

Email address of the user

email_verified
Type: boolean

Is the email address of the user verified or not

fb_uid
Type: string

Unique Facebook ID of the user

first_name
Type: string

First name of the user

gender
Type: string

Gender of the user

id
Type: integer

Unique ID of the user

last_name
Type: string

Last name of the user

phone
Type: string

Phone number of the user

privacy_policy
Type: boolean

Has the user agreed to the privacy policy or not

rewards
Type: Rewards Object
selected_card_number
Type: string
selected_discount_amount
Type: string
selected_reward_id
Type: integer

Integer numbers.

state
Type: string

State in which the user lives

updated_at
Type: string

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

user_digest
Type: string
zip_code
Type: string

Zip code of the user

post/api/pos/users

Show Schema

{
  "address_line1": "string",
  "age_verified": true,
  "anniversary": "YYYY-MM-DD",
  "avatar_remote_url": "string",
  "balance": {
    "balance": [
      {
        "banked_rewards": "string",
        "expired_membership_level": null,
        "initial_visits": 1,
        "membership_level": null,
        "membership_level_id": null,
        "net_balance": 1,
        "net_debits": 1,
        "pending_points": 1,
        "points_balance": 1,
        "signup_anniversary_day": "string",
        "total_credits": 1,
        "total_debits": "string",
        "total_point_credits": 1,
        "total_redeemable_visits": 1,
        "total_visits": 1,
        "unredeemed_cards": 1
      }
    ]
  },
  "birthday": "string",
  "city": "string",
  "created_at": "string",
  "discount_type": "string",
  "email": "string",
  "email_verified": true,
  "fb_uid": "string",
  "first_name": "string",
  "gender": "string",
  "id": 1,
  "last_name": "string",
  "phone": "string",
  "privacy_policy": true,
  "rewards": {
    "rewards": [
      {
        "created_at": "string",
        "description": "string",
        "discount_amount": 1,
        "end_date_tz": "string",
        "id": 1,
        "image": "string",
        "name": "string",
        "points": 1,
        "redeemable_properties": "string",
        "start_date_tz": "string",
        "status": "string",
        "updated_at": "string",
        "type": "string",
        "meta_data": "string"
      }
    ]
  },
  "selected_card_number": "string",
  "selected_discount_amount": "string",
  "selected_reward_id": 1,
  "state": "string",
  "updated_at": "string",
  "user_digest": "string",
  "zip_code": "string",
  "age_verified_status": true
}