Punchh

Punchh User Sign-up and SSO API

The User Sign-up and SSO API from Punchh — 8 operation(s) for user sign-up and sso.

Documentation GitHub OpenAPI

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/auth/customers.json Register a new guest account online · Create New User #

Ask an LLM

“How does an online ordering site register a new loyalty guest with email and password?”

“Do I need first and last name when the guest signs up with a referral code?”

Tell an agent

Sign up a new guest with details {user}.

Create a loyalty account for {user} under business client {client}.

POST /api/auth/customers/sign_in Log a guest in with email and password · Log in With Email and Password #

Ask an LLM

“How do I sign an existing guest in with their email and password?”

“What do I get back when a guest logs in successfully?”

Tell an agent

Log in the guest with credentials {user}.

Sign in {user} using email and password for client {client}.

POST /api/auth/sso Exchange a security token for an auth token · Create SSO Access Token #

Ask an LLM

“How does a partner site turn its SSO security token into a guest authentication token?”

“What's needed to create an SSO access token?”

Tell an agent

Create an SSO access token from security token {security_token}.

Exchange {security_token} for a guest authentication token.

POST /api/auth/users/reset_password_token Get a password reset token for a guest · Get Password Reset Token #

Ask an LLM

“How can a guest who forgot their password get a reset token?”

“Can the site request a password reset token for a specific user?”

Tell an agent

Get a password reset token for {user}.

Start a password reset for the guest {user}.

POST /oauth/token Exchange an OAuth code for an SSO token · Get SSO Token #

Ask an LLM

“After a guest logs in on the hosted sign-in form, how do I get an access token from the authorization code?”

“Which grant type and redirect URI does the SSO token exchange need?”

Tell an agent

Exchange authorization code {code} for an access token with client {client_id}, secret {client_secret}, redirect {redirect_uri}, grant {grant_type}.

Get the SSO token for code {code} returned to {redirect_uri}.

POST /api/auth/users/connect_with_facebook Sign a guest in or up with Facebook · Log in With Facebook #

Ask an LLM

“Can guests register for loyalty using their Facebook account?”

“What profile details can I send along when a guest connects with Facebook?”

Tell an agent

Log in with Facebook token {access_token} for {email}.

Register {email} via Facebook token {access_token} with phone {phone}.

POST /api/auth/users/connect_with_apple Sign a guest in with Apple · Log in With Apple #

Ask an LLM

“Can guests use Sign in with Apple on the web ordering site?”

“Why does Sign in with Apple need a redirect URI?”

Tell an agent

Sign in the guest with Apple using details {user}.

Complete Apple sign-in for {user} with redirect URI {redirect_uri}.

POST /api/auth/users/connect_with_google Sign a guest in with Google · Log in With Google #

Ask an LLM

“How do I let guests log in with their Google account on the web?”

“What has to be configured before Google sign-in works?”

Tell an agent

Log in the guest with Google ID token {google_id_token}.

Sign up {first_name} {last_name} with Google token {google_id_token}.

Documentation

https://developers.partech.com/docs/dev-portal-mobile

https://developers.partech.com/docs/dev-portal-mobile

https://developers.partech.com/docs/dev-portal-mobile/make-your-first-mobile-api-call

https://developers.partech.com/docs/dev-portal-online-ordering

https://developers.partech.com/docs/dev-portal-online-ordering

https://developers.partech.com/docs/dev-portal-online-ordering/make-your-first-sso-api-call

https://developers.partech.com/docs/dev-portal-platform-functions

https://developers.partech.com/docs/dev-portal-platform-functions

https://developers.partech.com/docs/dev-portal-platform-functions/make-your-first-platform-function-api-call

https://developers.partech.com/docs/dev-portal-pos

https://developers.partech.com/docs/dev-portal-pos

https://developers.partech.com/docs/dev-portal-pos/make-your-first-pos-api-call

Specifications

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/openapi/punchh-user-sign-up-and-sso-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-access-token-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-create-user-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-login-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-mark-offers-read-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-transaction-details-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-transaction-details-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-update-user-profile-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-user-session-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-access-token-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-create-user-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-login-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-mark-offers-read-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-transaction-details-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-transaction-details-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-update-user-profile-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-user-session-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-checkin-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-checkin-response-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-redemption-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-redemption-response-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-checkin-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-checkin-response-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-redemption-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-redemption-response-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/platform-functions-redeemable-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/platform-functions-redeemable-structure.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-access-token-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-create-user-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-login-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-mark-offers-read-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-transaction-details-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-transaction-details-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-update-user-profile-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-user-session-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-ld/punchh-mobile-context.jsonld

PostmanCollection

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-mobile.postman_collection.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-mobile.opencollection.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-checkin-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-checkin-response-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-redemption-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-redemption-response-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-ld/punchh-online-ordering-context.jsonld

PostmanCollection

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-online-ordering.postman_collection.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-online-ordering.opencollection.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/platform-functions-redeemable-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-ld/punchh-platform-functions-context.jsonld

PostmanCollection

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-platform-functions.postman_collection.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-platform-functions.opencollection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/punchh:punchh-user-sign-up-and-sso-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Online Ordering and SSO User Sign-up and SSO API
  version: '1.0'
  description: 'The Punchh SSO API endpoints provide user-management functions such as login, registration, forgot password, and connect with Facebook for users on the Punchh loyalty platform. You can also fetch user-specific information such as rewards or point balances.


    The Punchh Online Ordering API endpoints enable users to earn and redeem rewards for online orders.'
  contact:
    name: Punchh Dev Support
    url: https://developers.punchh.com
servers:
- url: https://SERVER_NAME_GOES_HERE.punchh.com
tags:


# --- truncated at 32 KB (95 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/openapi/punchh-user-sign-up-and-sso-api-openapi.yml