post-api2-mobile-users-google_sign_in

Log in With Google

​

Enables mobile application users to log in using Google Sign-in.

The following must be configured for the business in the Punchh platform to make a successful call to the API:

1. The Enable Google Sign-in option must be enabled in the Punchh platform. Contact your Punchh representative to update this Punchh platform configuration.

2. Google Web Client ID, Google iOS Client ID / Google Andriod Client ID, and Google Web Client Secret must be specified in the Punchh platform. Contact your Punchh representative to update this Punchh platform configuration.

Headers
  • x-pch-digest
    Type: string
    required

    The signature for the API call

  • Accept
    Type: string
    required

    Advertises which content types the client is able to understand

  • Accept-Language
    Type: string

    Preferred language

  • Content-Type
    Type: string
    required

    Set this header to application/json.

  • 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
  • address
    Type: string

    Address of the user

  • age_verified
    Type: boolean

    Whether the age of the user has been verified or not. Required when the business-level age verification is enabled.

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

  • anniversary
    enum
    const:  
    YYYY-MM-DD

    Anniversary date of the user

    • YYYY-MM-DD
  • birthday
    Type: string

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

  • city
    Type: string

    City where the user lives

  • client
    Type: string
    required

    OAuth client ID provided by the business

  • favourite_location_ids
    Type: string

    Favorite location IDs of the user

  • first_name
    Type: string

    First name of the user

  • gender
    Type: string

    Gender of the user

  • google_id_token
    Type: string
    required

    Token received from Google

  • last_name
    Type: string

    Last name of the user

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: object

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

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

Success Response - 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.