Boomerangme Cards Boomerangme API
63
AI ReadinessAI-Aware (B-)63/100
Agent-ready OpenAPI document · curated by JenticMarketingMarketing AutomationapiKey13 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For 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.
Use for: Issue a new stamp card pass to a customer who just signed up, Check whether a phone number already has a Boomerangme pass attached, Send a push notification to all holders of a specific loyalty template, Retrieve the cashback balance for a customer's active pass
Not supported: Does not handle payment processing, e-commerce checkout, or email marketing - use for digital wallet loyalty pass issuance and push notifications only.
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.
Install Jentic One Beta
Connect the Boomerangme API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Boomerangme API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fboomerangme.cards%2Fboomerangme" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fboomerangme.cards%2Fboomerangme" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Boomerangme API.
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
Patterns agents use Boomerangme API for, with concrete tasks.
★ 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.
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.
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.
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.
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
13 endpoints — jentic publishes the only available openapi specification for boomerangme api, keeping it validated and agent-ready.
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
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
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
B
Boomerangme API
- AI-Aware (B-)63/100
90
Foundational Compliance63
Developer Experience & Jentic Compatibility46
AI-Readiness & Agent Experience94
Agent Usability50
Security63
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
90
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: ASignals: 4
98%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
60%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
46
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: DSignals: 4
35%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
50%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
63
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: BSignals: 1
63%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
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 isolation
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.
Intent-based discovery
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
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Boomerangme API through Jentic.
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.
GET STARTED