mobile_sign_up

Sign up / Register

​

Registers a user's profile on the app of a business

Note: If the business is using referral code, the actual first_name and last_name of the guest must be passed because the referral code will be generated using the first_name, last_name, and some random characters. Also, if you do not pass the first_name or the last_name, the API response may be delayed or time out.

Using Referral Code As Invite Code in the Sign-up Process

When a user signs up using the Sign up / Register API, the API returns a referral code within the user object. The user can share this code with non-loyalty users to invite them to join the business loyalty program.

When a referred user signs up and enters the shared referral code in the mobile app, this referral_code must be passed in the invite_code request parameter when calling the Sign up / Register API.

Headers
  • punchh-app-device-id
    Type: string
    required

    The app device ID helps Punchh identify each device so that certain rewards can be awarded individually to each device instead of per user. For example, the sign-up reward is given to each device ID to prevent fraudulent sign-ups so that a user cannot do repeated sign-ups from a single device to get rewards. It should not change even if the user resets a device. See the sample code to generate the punchh-app-device-id header.

  • x-pch-digest
    Type: string
    required

    The signature for the API call

  • Content-Type
    Type: string
    required

    Set this header to application/json.

  • Accept
    Type: string
    required

    Advertises which content types the client is able to understand

  • Accept-Language
    Type: string

    Preferred language

  • User-Agent
    Type: string
    required

    Used to identify the software, device, and application initiating the request, providing information about the client to the server. For details, see User Agent.

Body
application/json
  • client
    Type: string

    OAuth client ID provided by the business

  • user
    Type: object
Responses
  • 200
    Type: object
    • access_token
      Type: Access Token (Object)

      An access token is needed to identify the user making the API request.

    • user
      Type: User (Object)

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

  • 422
    Type: object
    • errors
      Type: object
post/api2/mobile/users
{
  "access_token": {
    "token": "string",
    "seconds_to_expire": 1,
    "revoked_at": "YYYY-MM-DDThh:mm:ssZ",
    "refresh_token": "string",
    "scopes": [
      "string"
    ]
  },
  "user": {
    "address": "string",
    "avatar_remote_url": "string",
    "birthday": "YYYY-MM-DD",
    "communicable_email": "string",
    "city": "string",
    "created_at": "YYYY-MM-DDThh:mm:ssZ",
    "email": "string",
    "email_verified": true,
    "facebook_signup": true,
    "favourite_locations": "string",
    "favourite_store_numbers": "string",
    "fb_uid": "string",
    "first_name": "string",
    "gender": "string",
    "last_name": "string",
    "marketing_email_subscription": true,
    "marketing_pn_subscription": true,
    "migrate_status": true,
    "passcode_configured_for_giftcards": true,
    "phone": "string",
    "profile_field_answers": {
      "upf0": "string",
      "upf1": "string",
      "upf2": "string"
    },
    "referral_code": "string",
    "referral_path": "string",
    "secondary_email": "string",
    "state": "string",
    "superuser": true,
    "terms_and_conditions": true,
    "title": "string",
    "updated_at": "YYYY-MM-DDThh:mm:ssZ",
    "user_as_barcode": "string",
    "user_as_qrcode": "string",
    "user_code": "string",
    "user_id": 1,
    "user_relations": [
      "kid"
    ],
    "zip_code": "string",
    "anniversary": "string",
    "verification_mode": null,
    "apple_signup": true,
    "apple_uid": "string",
    "has_generated_fb_email": true,
    "sms_subscription": true,
    "apple_pass_url": "string",
    "age_verified_status": true,
    "account_created_at": "2025-12-19T16:30:02.130Z",
    "user_joined_at": "2025-12-19T16:30:02.130Z"
  }
}

The response returns basic details about the user account, including the access token that you must use to authenticate other API calls on the user's behalf.