canonical: https://jentic.com/apis/boomerangme.cards/boomerangme

# Boomerangme Cards Boomerangme API

Jentic publishes the only available OpenAPI specification for Boomerangme API, keeping it validated and agent-ready. Boomerangme is a digital loyalty card platform that issues mobile wallet passes for Apple Wallet and Google Pay, including stamps, cashback, subscriptions, coupons, discount cards, certificates, and membership cards. The API lets merchants create and update clients, issue passes against templates, send push notifications to pass holders, and look up customer passes by phone or email. It is designed for small and mid-size retailers running stamp-card and cashback loyalty programmes without a native app.

## For AI agents

Issue digital loyalty cards in Apple Wallet and Google Pay, manage clients, and send push notifications to pass holders for Boomerangme stamp, cashback, and membership programmes.

## Scope

Does not handle payment processing, e-commerce checkout, or email marketing - use for digital wallet loyalty pass issuance and push notifications only.

## Capabilities

- Issue digital loyalty passes for stamps, cashback, coupons, certificates, and membership programmes
- Create and update client records with phone, email, and custom attributes
- Look up active passes for a customer by phone number or email address
- Send targeted push notifications to wallet pass holders
- Retrieve pass-level information including stamp counts and cashback balances
- List loyalty templates available on the merchant account
- Verify whether a phone number already has a pass attached

## Use cases

### Wallet-based stamp and cashback loyalty programme

Cafes, salons, and small retailers run a digital stamp or cashback loyalty programme without building a mobile app by issuing Apple Wallet and Google Pay passes through Boomerangme. The API handles creating the client, attaching a pass against a chosen template, and updating stamp counts at checkout. Merchants typically launch in under a day using a prebuilt template.

Example prompt: Create a client record for phone number +14155551212 named Sara, then issue a pass against the coffee-stamps template and return the pass URL

### Customer lookup at point of sale

Staff at the counter need to find a customer's loyalty pass quickly using just a phone number or email so they can add a stamp or apply cashback. The API exposes lookup endpoints that return the active passes for a contact, allowing a POS integration or agent to verify membership and fetch the current balance in a single call.

Example prompt: Given the phone number +447700900123, return all Boomerangme passes attached to the customer and their current stamp counts

### Re-engagement push campaigns

Marketing teams send targeted push notifications to wallet pass holders to drive return visits, announce promotions, or remind customers about expiring rewards. The API accepts a notification payload and dispatches it to all holders of a specified template, with the message appearing on the customer's lock screen alongside the pass.

Example prompt: Send a push notification with the text 'Double stamps this weekend' to every holder of the coffee-stamps template and confirm the dispatch

### Agent-driven loyalty enrolment

An AI agent enrols new customers into a Boomerangme loyalty programme as part of a wider conversational signup flow. The agent uses Jentic to discover the createClient and createPass operations, supplies the customer's contact details and template id, and returns the wallet pass URL to the customer in the same conversation. Credentials stay in your Jentic One instance and never enter the agent's context.

Example prompt: Search Jentic for 'issue a Boomerangme loyalty pass', load the createPass schema, and execute it for a new client with phone +447700900456 against template id tmpl_123

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/createClient` | Create a new client record |
| POST | `/createPass` | Issue a wallet pass against a template |
| POST | `/searchClient` | Search for an existing client |
| POST | `/getPassInfoByPhone` | Look up pass details by phone number |
| POST | `/getClientPassesByEmail` | List all passes for an email address |
| POST | `/sendInfoPush` | Send a push notification to pass holders |
| POST | `/getTemplates` | List loyalty templates on the account |

## Key resources

- **Clients** — Create, search, and update customer profiles with phone, email, and custom attributes
- **Passes** — Issue wallet passes against a template and retrieve pass details by id, phone, or email
- **Templates** — List the loyalty programme templates configured on the merchant account
- **Notifications** — Send push notifications to wallet pass holders and list dispatched notifications

## Why Jentic

- **Setup:** Wiring Boomerangme by hand means setting the x-access-token header, learning its RPC-style POST calls, and mapping loyalty pass and push flows yourself. Through Jentic you install once, import the Boomerangme API from the API Directory, store the access token once, and your agent calls it.
- **Permission scoping:** Boomerangme carries the client and pass details in the request body rather than the URL path, so scope the agent to the operations it needs, such as creating a client or issuing a pass, and leave out ones like sending push notifications unless the agent requires them. Every operation you allow is one you have explicitly chosen.
- **Credential handling:** Your Boomerangme x-access-token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'issue a loyalty pass' or 'send a wallet push notification', and Jentic returns the matching Boomerangme operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **LoyaltyLion API** — E-commerce loyalty programme aimed at Shopify and BigCommerce stores rather than wallet-pass retail.
- **Antavo API** — Enterprise loyalty engine with deeper segmentation and tier rules than Boomerangme.
- **Smile.io API** — Points and referral loyalty for Shopify and BigCommerce merchants.
- **Talon.One API** — Promotion and discount engine that pairs with a wallet-pass loyalty system to handle complex coupon rules.

## FAQ

### Why is there no official OpenAPI spec for Boomerangme API?

Boomerangme does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Boomerangme API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Boomerangme API use?

Boomerangme uses an API key passed in the x-access-token request header. When you call it through Jentic, the access token is stored in your Jentic One instance and injected at execution time, so the raw token never enters the agent's context.

### Can I issue an Apple Wallet pass with the Boomerangme API?

Yes. Call POST /createPass with a clientId and a templateId; Boomerangme returns a wallet pass URL that works in both Apple Wallet and Google Pay. The customer adds the pass with one tap from a browser or messaging app.

### How do I look up a customer's loyalty passes by phone number?

Use POST /getClientPassesByPhone with the customer's phone in international format. The endpoint returns every active pass attached to that number, including the template, stamp count, and cashback balance. POST /checkPassExistsByPhone is a lighter alternative if you only need a yes/no check.

### How do I send a push notification to pass holders through Jentic?

Search Jentic for 'send a Boomerangme push notification', load the sendInfoPush schema, and execute it with the templateId and message body. Use pip install jentic to add the SDK, then call client.search, client.load, and client.execute in that order.

### What are the rate limits for the Boomerangme API?

Boomerangme does not document public rate limits in the OpenAPI spec; merchants on standard plans report comfortable headroom for typical retail volumes. For high-frequency lookups, batch requests where possible and cache template lists between calls.

### Is the Boomerangme API free to use?

API access is included with a paid Boomerangme merchant subscription rather than billed separately. You authenticate with the access token issued from your merchant dashboard; there is no additional per-call fee from Boomerangme for endpoints in this spec.

### Can I limit what my agent is allowed to do with the Boomerangme API?

Yes. Jentic One is self-hosted, so you run it and your own rules decide which Boomerangme operations and credentials the agent may use. Because Boomerangme carries client and pass details in the request body rather than the URL path, you scope the agent to only the operations it needs, such as createClient and createPass, and leave out others like sendInfoPush unless the agent requires them. Every operation you allow is one you have explicitly chosen, and the access token stays in your Jentic One instance rather than the agent's context.