# LoyaltyDog

> Developer documentation for the LoyaltyDog loyalty, gift card, and wallet pass platform.

## Docs

- [Create Breach Incident](https://docs.loyalty.dog/api-reference/admin/create-breach-incident.md): Record a new GDPR Article 33 breach incident. Sets a 72-hour ICO notification deadline.
- [Publish Terms Version](https://docs.loyalty.dog/api-reference/admin/publish-terms-version.md): Publish a new version of a legal document (admin only, SWE-380).
- [Record Authority Notification](https://docs.loyalty.dog/api-reference/admin/record-authority-notification.md): Record that the ICO/supervisory authority has been notified (manual step).
- [Update Breach Incident](https://docs.loyalty.dog/api-reference/admin/update-breach-incident.md): Update a breach incident. Recomputes risk level when affected records or categories change.
- [Chat With Advisor](https://docs.loyalty.dog/api-reference/ai-advisor/chat-with-advisor.md): Handle a chat request and return a structured AI advisor response.
- [Health Check](https://docs.loyalty.dog/api-reference/ai-advisor/health-check.md): Report AI Advisor health and Mistral configuration status.
- [Acknowledge Anomaly Alert](https://docs.loyalty.dog/api-reference/anomalies/acknowledge-anomaly-alert.md)
- [Get Anomaly Alerts](https://docs.loyalty.dog/api-reference/anomalies/get-anomaly-alerts.md)
- [Get Anomaly Metrics](https://docs.loyalty.dog/api-reference/anomalies/get-anomaly-metrics.md)
- [Export Audit Logs](https://docs.loyalty.dog/api-reference/audit-logs/export-audit-logs.md): ### Export Audit Logs (async bulk export)
- [Get Export Status](https://docs.loyalty.dog/api-reference/audit-logs/get-export-status.md): ### Poll Audit Log Export Status
- [Query Audit Logs](https://docs.loyalty.dog/api-reference/audit-logs/query-audit-logs.md): ### Query Audit Logs
- [Device Health Check](https://docs.loyalty.dog/api-reference/devices/device-health-check.md): Health check endpoint for device monitoring.
- [Get Device](https://docs.loyalty.dog/api-reference/devices/get-device.md): Get device information by ID.
- [Register Device](https://docs.loyalty.dog/api-reference/devices/register-device.md): Register a new tablet/kiosk device.
- [Update Device](https://docs.loyalty.dog/api-reference/devices/update-device.md): Update device information.
- [Acknowledge Fraud Alert](https://docs.loyalty.dog/api-reference/fraud/acknowledge-fraud-alert.md)
- [Block Ip](https://docs.loyalty.dog/api-reference/fraud/block-ip.md)
- [Create Fraud Rule](https://docs.loyalty.dog/api-reference/fraud/create-fraud-rule.md)
- [Delete Fraud Rule](https://docs.loyalty.dog/api-reference/fraud/delete-fraud-rule.md)
- [Get Blocked Ips](https://docs.loyalty.dog/api-reference/fraud/get-blocked-ips.md)
- [Get Fraud Alerts](https://docs.loyalty.dog/api-reference/fraud/get-fraud-alerts.md)
- [Get Fraud Metrics](https://docs.loyalty.dog/api-reference/fraud/get-fraud-metrics.md)
- [Get Fraud Patterns](https://docs.loyalty.dog/api-reference/fraud/get-fraud-patterns.md)
- [Get Fraud Rules](https://docs.loyalty.dog/api-reference/fraud/get-fraud-rules.md)
- [Get Velocity Checks](https://docs.loyalty.dog/api-reference/fraud/get-velocity-checks.md)
- [Unblock Ip](https://docs.loyalty.dog/api-reference/fraud/unblock-ip.md)
- [Update Fraud Rule](https://docs.loyalty.dog/api-reference/fraud/update-fraud-rule.md)
- [Create Dsar Request](https://docs.loyalty.dog/api-reference/gdpr/create-dsar-request.md): ### Create Data Subject Access Request
- [Get Dsar Status](https://docs.loyalty.dog/api-reference/gdpr/get-dsar-status.md): ### Get DSAR Request Status
- [Verify Dsar Request](https://docs.loyalty.dog/api-reference/gdpr/verify-dsar-request.md): ### Verify DSAR Request Identity
- [Export Analytics](https://docs.loyalty.dog/api-reference/gift-card-analytics/export-analytics.md): Export analytics data for the period.
- [Get Analytics Overview](https://docs.loyalty.dog/api-reference/gift-card-analytics/get-analytics-overview.md): Return a KPI snapshot for the programme over the requested period.
- [Get Analytics Trends](https://docs.loyalty.dog/api-reference/gift-card-analytics/get-analytics-trends.md): Return time-series transaction data bucketed by *granularity*.
- [Logoutcustomer](https://docs.loyalty.dog/api-reference/gift-card-customers/logoutcustomer.md): ### Logout Customer
- [Sendcustomerotp](https://docs.loyalty.dog/api-reference/gift-card-customers/sendcustomerotp.md): ### Send OTP to Customer
- [Validatecustomersession](https://docs.loyalty.dog/api-reference/gift-card-customers/validatecustomersession.md): ### Validate Customer Session
- [Verifycustomerotp](https://docs.loyalty.dog/api-reference/gift-card-customers/verifycustomerotp.md): ### Verify OTP and Login Customer
- [Getmerchanttheme](https://docs.loyalty.dog/api-reference/gift-card-merchants/getmerchanttheme.md): Fetch the authenticated merchant's persisted portal theme.
- [Initmerchantsession](https://docs.loyalty.dog/api-reference/gift-card-merchants/initmerchantsession.md): ### Init or Refresh Merchant Session
- [Savemerchantsettings](https://docs.loyalty.dog/api-reference/gift-card-merchants/savemerchantsettings.md): ### Save Per-Location Merchant Settings
- [Savemerchanttheme](https://docs.loyalty.dog/api-reference/gift-card-merchants/savemerchanttheme.md): Validate and persist the authenticated merchant's portal theme.
- [Validatemerchantsession](https://docs.loyalty.dog/api-reference/gift-card-merchants/validatemerchantsession.md): ### Validate Merchant Session
- [Create Schedule](https://docs.loyalty.dog/api-reference/gift-card-reports/create-schedule.md): Create an automated report schedule for the programme.
- [Delete Scheduled Report](https://docs.loyalty.dog/api-reference/gift-card-reports/delete-scheduled-report.md): Delete a scheduled report by its UUID.
- [Download Scheduled Report](https://docs.loyalty.dog/api-reference/gift-card-reports/download-scheduled-report.md): Generate and stream the latest report data for a schedule.
- [List Scheduled Reports](https://docs.loyalty.dog/api-reference/gift-card-reports/list-scheduled-reports.md): List all scheduled reports for the programme, newest first.
- [Validate Report Data](https://docs.loyalty.dog/api-reference/gift-card-reports/validate-report-data.md): Run data-integrity checks against the programme's gift card collection.
- [Acknowledgeamlalert](https://docs.loyalty.dog/api-reference/gift-cards/acknowledgeamlalert.md)
- [Activategiftcard](https://docs.loyalty.dog/api-reference/gift-cards/activategiftcard.md): ### Activate Gift Card
- [Checkgiftcardbalance](https://docs.loyalty.dog/api-reference/gift-cards/checkgiftcardbalance.md): Authenticate the provided card number and security code, and return the card's balance and usability information.
- [Consolidategiftcards](https://docs.loyalty.dog/api-reference/gift-cards/consolidategiftcards.md): Consolidates multiple ACTIVE gift cards from the same program and customer into a single new active card with the combined balance.
- [Creategiftcard](https://docs.loyalty.dog/api-reference/gift-cards/creategiftcard.md): Create a new gift card in pending status with a generated card number and security code.
- [Creategiftcardconsent](https://docs.loyalty.dog/api-reference/gift-cards/creategiftcardconsent.md): Create or update GDPR consent for a customer identified by email or phone.
- [Customercheckgiftcardbalance](https://docs.loyalty.dog/api-reference/gift-cards/customercheckgiftcardbalance.md): ### Customer Balance Check (Cross-Program)
- [Downloadgiftcardcustomerdata](https://docs.loyalty.dog/api-reference/gift-cards/downloadgiftcardcustomerdata.md)
- [Erasegiftcardcustomerdata](https://docs.loyalty.dog/api-reference/gift-cards/erasegiftcardcustomerdata.md)
- [Exportgiftcardcustomerdata](https://docs.loyalty.dog/api-reference/gift-cards/exportgiftcardcustomerdata.md)
- [Getamlalerts](https://docs.loyalty.dog/api-reference/gift-cards/getamlalerts.md)
- [Getbusinessreports](https://docs.loyalty.dog/api-reference/gift-cards/getbusinessreports.md)
- [Getcustomerconsolidatablemerchants](https://docs.loyalty.dog/api-reference/gift-cards/getcustomerconsolidatablemerchants.md): Get list of merchants and their number of active, positive-balance cards for a customer.
- [Getcustomerreports](https://docs.loyalty.dog/api-reference/gift-cards/getcustomerreports.md)
- [Getcustomertransactions](https://docs.loyalty.dog/api-reference/gift-cards/getcustomertransactions.md): ### Get All Customer Transactions
- [Getescheatmentreport](https://docs.loyalty.dog/api-reference/gift-cards/getescheatmentreport.md)
- [Getexpirationwarnings](https://docs.loyalty.dog/api-reference/gift-cards/getexpirationwarnings.md)
- [Getgiftcardbypasssid](https://docs.loyalty.dog/api-reference/gift-cards/getgiftcardbypasssid.md): ### Get Gift Card Info by Pass SID
- [Getgiftcardconsent](https://docs.loyalty.dog/api-reference/gift-cards/getgiftcardconsent.md)
- [Getgiftcardconsentbyidentifier](https://docs.loyalty.dog/api-reference/gift-cards/getgiftcardconsentbyidentifier.md): Look up GDPR consent by email, phone, or customer ID.
- [Getgiftcarddetails](https://docs.loyalty.dog/api-reference/gift-cards/getgiftcarddetails.md): ### Get Gift Card Details
- [Getgiftcards](https://docs.loyalty.dog/api-reference/gift-cards/getgiftcards.md)
- [Getgiftcards](https://docs.loyalty.dog/api-reference/gift-cards/getgiftcards-1.md)
- [Getgiftcardtransactions](https://docs.loyalty.dog/api-reference/gift-cards/getgiftcardtransactions.md): ### Get Gift Card Transaction History
- [Getnetworkoverview](https://docs.loyalty.dog/api-reference/gift-cards/getnetworkoverview.md): ### Network Overview
- [Giftcardhealthcheck](https://docs.loyalty.dog/api-reference/gift-cards/giftcardhealthcheck.md): ### Gift Card Service Health Check
- [Issue multiple gift cards](https://docs.loyalty.dog/api-reference/gift-cards/issue-multiple-gift-cards.md): ### Bulk Issue Gift Cards
- [Poll async bulk issuance task](https://docs.loyalty.dog/api-reference/gift-cards/poll-async-bulk-issuance-task.md): ### Poll Async Bulk Issuance
- [Processexpiredcard](https://docs.loyalty.dog/api-reference/gift-cards/processexpiredcard.md)
- [Redeemgiftcard](https://docs.loyalty.dog/api-reference/gift-cards/redeemgiftcard.md): Redeem a specified amount from an active, non-expired gift card and record a REDEMPTION transaction.
- [Refundgiftcardtransaction](https://docs.loyalty.dog/api-reference/gift-cards/refundgiftcardtransaction.md)
- [Reloadgiftcard](https://docs.loyalty.dog/api-reference/gift-cards/reloadgiftcard.md): ### Reload Gift Card
- [Reloadgiftcardbynumber](https://docs.loyalty.dog/api-reference/gift-cards/reloadgiftcardbynumber.md): ### Reload Gift Card by Card Number
- [Resendgiftcardsecuritycode](https://docs.loyalty.dog/api-reference/gift-cards/resendgiftcardsecuritycode.md): ### Resend Security Code
- [Schedulegiftcarddelivery](https://docs.loyalty.dog/api-reference/gift-cards/schedulegiftcarddelivery.md)
- [Searchgiftcards](https://docs.loyalty.dog/api-reference/gift-cards/searchgiftcards.md): ### Search Gift Cards
- [Searchgiftcards](https://docs.loyalty.dog/api-reference/gift-cards/searchgiftcards-1.md): ### Search Gift Cards
- [Suspendgiftcard](https://docs.loyalty.dog/api-reference/gift-cards/suspendgiftcard.md)
- [Transfergiftcardbalance](https://docs.loyalty.dog/api-reference/gift-cards/transfergiftcardbalance.md): ### Transfer Balance Between Gift Cards
- [Transfergiftcardownership](https://docs.loyalty.dog/api-reference/gift-cards/transfergiftcardownership.md): ### Transfer Gift Card Ownership
- [Unsuspendgiftcard](https://docs.loyalty.dog/api-reference/gift-cards/unsuspendgiftcard.md)
- [Updategiftcardconsent](https://docs.loyalty.dog/api-reference/gift-cards/updategiftcardconsent.md)
- [Voidgiftcard](https://docs.loyalty.dog/api-reference/gift-cards/voidgiftcard.md)
- [Detect language from Accept-Language header](https://docs.loyalty.dog/api-reference/localization/detect-language-from-accept-language-header.md): Detects the preferred language from the browser's Accept-Language header.
- [Get customer preferred language](https://docs.loyalty.dog/api-reference/localization/get-customer-preferred-language.md): Returns the current preferred language for a customer.
- [Get merchant default language](https://docs.loyalty.dog/api-reference/localization/get-merchant-default-language.md): Returns the current default language for a merchant (program).
- [Get translations for a language](https://docs.loyalty.dog/api-reference/localization/get-translations-for-a-language.md): Returns all translations for the specified language code.
- [List available languages](https://docs.loyalty.dog/api-reference/localization/list-available-languages.md): Returns a list of all supported languages with their codes, names, flags, and native names.
- [Localization pipeline health](https://docs.loyalty.dog/api-reference/localization/localization-pipeline-health.md): Reports whether real translations loaded from the @loyaltydog/i18n package (vs. the empty fallback) and the en-US 'common' key count. Use to detect the raw-key degradation mode in any environment.
- [Update customer preferred language](https://docs.loyalty.dog/api-reference/localization/update-customer-preferred-language.md): Updates the preferred language for a customer.
- [Update merchant default language](https://docs.loyalty.dog/api-reference/localization/update-merchant-default-language.md): Updates the default language for a merchant (program).
- [Cancel Loyalty Program Offer](https://docs.loyalty.dog/api-reference/loyalty/cancel-loyalty-program-offer.md): ### Cancel Offer
- [Cancel Loyalty Program Voucher](https://docs.loyalty.dog/api-reference/loyalty/cancel-loyalty-program-voucher.md): ### Cancel Voucher
- [Change Loyalty Program Pass Type](https://docs.loyalty.dog/api-reference/loyalty/change-loyalty-program-pass-type.md): ### Change Pass Type
- [Claim Loyalty Program Customer Offer](https://docs.loyalty.dog/api-reference/loyalty/claim-loyalty-program-customer-offer.md): ### Claim an Offer for Customer
- [Create Loyalty Program](https://docs.loyalty.dog/api-reference/loyalty/create-loyalty-program.md): Create a new loyalty program.
- [Create Loyalty Program Customer](https://docs.loyalty.dog/api-reference/loyalty/create-loyalty-program-customer.md): ### Create Loyalty Program Customer
- [Create Loyalty Program Offer](https://docs.loyalty.dog/api-reference/loyalty/create-loyalty-program-offer.md): ### Create Offer
- [Create Loyalty Program Voucher](https://docs.loyalty.dog/api-reference/loyalty/create-loyalty-program-voucher.md): ### Create Voucher
- [Create Or Update Loyalty Program Offer Card Image](https://docs.loyalty.dog/api-reference/loyalty/create-or-update-loyalty-program-offer-card-image.md): ### Create or Update Card Offer Image
- [Create Or Update Loyalty Program Voucher Card Image](https://docs.loyalty.dog/api-reference/loyalty/create-or-update-loyalty-program-voucher-card-image.md): ### Create or Update Card Voucher Image
- [Delete Loyalty Program Card Image](https://docs.loyalty.dog/api-reference/loyalty/delete-loyalty-program-card-image.md): ### Delete Card Image
- [Delete Loyalty Program Customer](https://docs.loyalty.dog/api-reference/loyalty/delete-loyalty-program-customer.md): ### Delete Loyalty Program Customer
- [Delete Loyalty Program Offer](https://docs.loyalty.dog/api-reference/loyalty/delete-loyalty-program-offer.md): ### Delete Offer
- [Delete Loyalty Program Offer Card Image](https://docs.loyalty.dog/api-reference/loyalty/delete-loyalty-program-offer-card-image.md): ### Delete Card Offer Image
- [Delete Loyalty Program Voucher](https://docs.loyalty.dog/api-reference/loyalty/delete-loyalty-program-voucher.md): ### Delete Voucher
- [Delete Loyalty Program Voucher Card Image](https://docs.loyalty.dog/api-reference/loyalty/delete-loyalty-program-voucher-card-image.md): ### Delete Card Voucher Image
- [Duplicate Loyalty Program Offer](https://docs.loyalty.dog/api-reference/loyalty/duplicate-loyalty-program-offer.md): ### Duplicate Offer
- [Export Loyalty Program Customer Data](https://docs.loyalty.dog/api-reference/loyalty/export-loyalty-program-customer-data.md): ### Export Customer Data (DSAR — SWE-362)
- [Get Customer Consents](https://docs.loyalty.dog/api-reference/loyalty/get-customer-consents.md): ### Get Current Customer Consent State
- [Get Loyalty Program Activities](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-activities.md): ### Get Loyalty Program Activities
- [Get Loyalty Program Card](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-card.md): ### Get Loyalty Program Card
- [Get Loyalty Program Card Image](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-card-image.md): ### Get Loyalty Program Card Image
- [Get Loyalty Program Card Images](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-card-images.md): ### Get Loyalty Program Card Images
- [Get Loyalty Program Custom Fields](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-custom-fields.md): ### Get Loyalty Program Custom Fields
- [Get Loyalty Program Customer](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-customer.md): ### Get Loyalty Program Customer
- [Get Loyalty Program Customer Activities](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-customer-activities.md): ### Get Loyalty Program Activities of Customer
- [Get Loyalty Program Customer Offers](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-customer-offers.md): ### List Available Offers for Customer
- [Get Loyalty Program Customer Reserved Points](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-customer-reserved-points.md): ### Get Loyalty Program Customer Reserved and Available Points Retrieves the total reserved and available points for a specific customer within a loyalty program. **Path Parameters**: - `programId`: UUID of the loyalty program - `customerId`: UUID of the customer **Returns**: - A JSON object contain…
- [Get Loyalty Program Customer Transactions](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-customer-transactions.md): ### Get Loyalty Program Transactions of Customer
- [Get Loyalty Program Customers](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-customers.md): ### List Loyalty Program Customers
- [Get Loyalty Program Details](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-details.md): ### Get Loyalty Program Details
- [Get Loyalty Program Icon](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-icon.md): ### Get Loyalty Program Icon
- [Get Loyalty Program Offer](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-offer.md): ### Get Loyalty Program Offer
- [Get Loyalty Program Offer Card](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-offer-card.md): ### Get Loyalty Program Offer Card
- [Get Loyalty Program Offer Card Image](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-offer-card-image.md): ### Get Loyalty Program Offer Card Image
- [Get Loyalty Program Offer Images](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-offer-images.md): ### Get Loyalty Program Offer Images
- [Get Loyalty Program Offers](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-offers.md): ### Get Loyalty Program Offers
- [Get Loyalty Program Transactions](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-transactions.md): ### Get Loyalty Program Transactions
- [Get Loyalty Program Voucher](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-voucher.md): ### Get Loyalty Program Voucher
- [Get Loyalty Program Voucher Card](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-voucher-card.md): ### Get Loyalty Program Voucher Card
- [Get Loyalty Program Voucher Card Image](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-voucher-card-image.md): ### Get Loyalty Program Voucher Card Image
- [Get Loyalty Program Voucher Images](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-program-voucher-images.md): ### Get Loyalty Program Voucher Images
- [Get Loyalty Programs](https://docs.loyalty.dog/api-reference/loyalty/get-loyalty-programs.md): ### List Loyalty Programs
- [Post Loyalty Program Customer Push](https://docs.loyalty.dog/api-reference/loyalty/post-loyalty-program-customer-push.md): ### Send Push Notification to a Customer
- [Post Loyalty Program Customers Push](https://docs.loyalty.dog/api-reference/loyalty/post-loyalty-program-customers-push.md): ### Send Push Message to All Customers
- [Publish Loyalty Program Offer](https://docs.loyalty.dog/api-reference/loyalty/publish-loyalty-program-offer.md): ### Publish Offer
- [Publish Loyalty Program Voucher](https://docs.loyalty.dog/api-reference/loyalty/publish-loyalty-program-voucher.md): ### Publish Voucher
- [Publish Loyalty Program Voucher](https://docs.loyalty.dog/api-reference/loyalty/publish-loyalty-program-voucher-1.md)
- [Record Customer Consents](https://docs.loyalty.dog/api-reference/loyalty/record-customer-consents.md): ### Record Customer Consents
- [Redeem Loyalty Program Customer Offer](https://docs.loyalty.dog/api-reference/loyalty/redeem-loyalty-program-customer-offer.md): ### Redeem Current Offer for Customer
- [Update Loyalty Program Card](https://docs.loyalty.dog/api-reference/loyalty/update-loyalty-program-card.md): ### Update Card
- [Update Loyalty Program Card Image](https://docs.loyalty.dog/api-reference/loyalty/update-loyalty-program-card-image.md): ### Update Card Image
- [Update Loyalty Program Custom Fields](https://docs.loyalty.dog/api-reference/loyalty/update-loyalty-program-custom-fields.md): ### Update Loyalty Program Custom Fields
- [Update Loyalty Program Customer](https://docs.loyalty.dog/api-reference/loyalty/update-loyalty-program-customer.md): ### Update Loyalty Program Customer
- [Update Loyalty Program Customer Points](https://docs.loyalty.dog/api-reference/loyalty/update-loyalty-program-customer-points.md): ### Add Reward Points to Customer Account
- [Update Loyalty Program Details](https://docs.loyalty.dog/api-reference/loyalty/update-loyalty-program-details.md): ### Update Program
- [Update Loyalty Program Icon](https://docs.loyalty.dog/api-reference/loyalty/update-loyalty-program-icon.md): ### Update Icon
- [Update Loyalty Program Offer](https://docs.loyalty.dog/api-reference/loyalty/update-loyalty-program-offer.md): ### Update Offer
- [Update Loyalty Program Offer Card](https://docs.loyalty.dog/api-reference/loyalty/update-loyalty-program-offer-card.md): ### Update Offer Card
- [Update Loyalty Program Voucher](https://docs.loyalty.dog/api-reference/loyalty/update-loyalty-program-voucher.md): ### Update Voucher
- [Update Loyalty Program Voucher Card](https://docs.loyalty.dog/api-reference/loyalty/update-loyalty-program-voucher-card.md): ### Update Voucher Card
- [Accept Terms](https://docs.loyalty.dog/api-reference/merchants/accept-terms.md): ### Record Merchant Terms Acceptance (SWE-361)
- [Get Chart Data](https://docs.loyalty.dog/api-reference/merchants/get-chart-data.md): Get time-series chart data for performance visualization.
- [Get Merchant Metrics](https://docs.loyalty.dog/api-reference/merchants/get-merchant-metrics.md): Get metrics for a merchant's loyalty program.
- [Get Pass Template Actions](https://docs.loyalty.dog/api-reference/pass-templates->-actions/get-pass-template-actions.md): ### Get Pass Template Actions
- [Update Pass Template Actions](https://docs.loyalty.dog/api-reference/pass-templates->-actions/update-pass-template-actions.md): ### Update Pass Template Actions
- [Delete Branding Footer Image](https://docs.loyalty.dog/api-reference/pass-templates->-branding/delete-branding-footer-image.md): ### Delete Branding Footer Image
- [Get Branding Settings Of Pass Template](https://docs.loyalty.dog/api-reference/pass-templates->-branding/get-branding-settings-of-pass-template.md): ### Get Branding Settings of Pass Template
- [Update Branding Footer Image](https://docs.loyalty.dog/api-reference/pass-templates->-branding/update-branding-footer-image.md): ### Update Branding Footer Image
- [Update Branding Settings Of Pass Template](https://docs.loyalty.dog/api-reference/pass-templates->-branding/update-branding-settings-of-pass-template.md): ### Update Branding Settings of Pass Template
- [Get Pass Template Distribution Restrictions](https://docs.loyalty.dog/api-reference/pass-templates->-distribution-restrictions/get-pass-template-distribution-restrictions.md): ### Get Pass Template Distribution Restrictions
- [Update Pass Template Distribution Restrictions](https://docs.loyalty.dog/api-reference/pass-templates->-distribution-restrictions/update-pass-template-distribution-restrictions.md): ### Update Pass Template Distribution Restrictions
- [Create Or Update Image Of Pass Template Of Type And Resolution](https://docs.loyalty.dog/api-reference/pass-templates->-images/create-or-update-image-of-pass-template-of-type-and-resolution.md): ### Create or Update Image of Pass Template of Type and Resolution
- [Delete All Images Of Pass Template](https://docs.loyalty.dog/api-reference/pass-templates->-images/delete-all-images-of-pass-template.md): ### Delete All Images of Pass Template
- [Delete All Images Of Pass Template Of Type](https://docs.loyalty.dog/api-reference/pass-templates->-images/delete-all-images-of-pass-template-of-type.md): ### Delete All Images of Pass Template of Type
- [Delete Image Of Pass Template Of Type And Resolution](https://docs.loyalty.dog/api-reference/pass-templates->-images/delete-image-of-pass-template-of-type-and-resolution.md): ### Delete Image of Pass Template of Type and Resolution
- [Get All Images Of Pass Template](https://docs.loyalty.dog/api-reference/pass-templates->-images/get-all-images-of-pass-template.md): ### Get All Images of Pass Template
- [Get All Images Of Pass Template Of Type](https://docs.loyalty.dog/api-reference/pass-templates->-images/get-all-images-of-pass-template-of-type.md): ### Get All Images of Pass Template of Type
- [Get Image From Pass Template Of Type And Resolution](https://docs.loyalty.dog/api-reference/pass-templates->-images/get-image-from-pass-template-of-type-and-resolution.md): ### Get Image from Pass Template of Type and Resolution
- [Delete Pass Template Information](https://docs.loyalty.dog/api-reference/pass-templates->-information/delete-pass-template-information.md): ### Delete Pass Template Information
- [Get Pass Template Information](https://docs.loyalty.dog/api-reference/pass-templates->-information/get-pass-template-information.md): ### Get Pass Template Information
- [Update Pass Template Information](https://docs.loyalty.dog/api-reference/pass-templates->-information/update-pass-template-information.md): ### Update Pass Template Information
- [Get Pass Template Link](https://docs.loyalty.dog/api-reference/pass-templates->-link/get-pass-template-link.md): ### Get Pass Template Link
- [Create Pass From Template With Values Images](https://docs.loyalty.dog/api-reference/pass-templates->-pass-generation/create-pass-from-template-with-values-images.md): ### Create Pass from Template with Values and Images
- [Create Pass From Template With Values Images By Name](https://docs.loyalty.dog/api-reference/pass-templates->-pass-generation/create-pass-from-template-with-values-images-by-name.md): ### Create Pass from Template with Values and Images by Name
- [Get Payment Settings For Pass Template](https://docs.loyalty.dog/api-reference/pass-templates->-payment-settings/get-payment-settings-for-pass-template.md): ### Get Payment Settings for Pass Template
- [Update Payment Settings For Pass Template](https://docs.loyalty.dog/api-reference/pass-templates->-payment/update-payment-settings-for-pass-template.md): ### Update Payment Settings for Pass Template
- [Create Pass Template](https://docs.loyalty.dog/api-reference/pass-templates/create-pass-template.md): ### Create Pass Template
- [Get Pass Templates](https://docs.loyalty.dog/api-reference/pass-templates/get-pass-templates.md): ### Get Pass Templates
- [Create Passtype](https://docs.loyalty.dog/api-reference/pass-type-ids/create-passtype.md): Creates a new pass type ID using either a certificate or a PKCS12 file.
- [Create Passtype Csr](https://docs.loyalty.dog/api-reference/pass-type-ids/create-passtype-csr.md): Generates a new Certificate Signing Request (CSR) for the user.
- [Delete Passtype](https://docs.loyalty.dog/api-reference/pass-type-ids/delete-passtype.md): Deletes a pass type ID and all related resources asynchronously.
- [Get All Available Passtypes](https://docs.loyalty.dog/api-reference/pass-type-ids/get-all-available-passtypes.md): Retrieves a list of all available pass type IDs for the current user.
- [Get Passtype Information](https://docs.loyalty.dog/api-reference/pass-type-ids/get-passtype-information.md): Fetches detailed information about a specific pass type ID associated with the current user.
- [Create Update Pass Images Type Resolution](https://docs.loyalty.dog/api-reference/passes->-pass-images/create-update-pass-images-type-resolution.md): ### Create or Update Image of Pass of Type and Resolution
- [Delete All Pass Images Type](https://docs.loyalty.dog/api-reference/passes->-pass-images/delete-all-pass-images-type.md): Delete all images of a specific type associated with a pass.
- [Delete All Pass Images Type Resolution](https://docs.loyalty.dog/api-reference/passes->-pass-images/delete-all-pass-images-type-resolution.md): ### Delete all images with the given type and resolution of the Wallet pass
- [Delete Pass Images](https://docs.loyalty.dog/api-reference/passes->-pass-images/delete-pass-images.md): Delete all images associated with a specific pass.
- [Get Pass Images](https://docs.loyalty.dog/api-reference/passes->-pass-images/get-pass-images.md): Retrieve all images associated with a specific pass.
- [Get Pass Images By Type](https://docs.loyalty.dog/api-reference/passes->-pass-images/get-pass-images-by-type.md): Retrieve all images of a specific type associated with a pass.
- [Get Pass Images Type Resolution](https://docs.loyalty.dog/api-reference/passes->-pass-images/get-pass-images-type-resolution.md): Retrieve all images of a specific type and resolution associated with a pass.
- [Get Pass Status](https://docs.loyalty.dog/api-reference/passes->-pass-images/get-pass-status.md): ### Get the status of the Wallet pass
- [Update Pass Status](https://docs.loyalty.dog/api-reference/passes->-pass-images/update-pass-status.md): ### Update the status of the Wallet pass
- [Delete Custom Price](https://docs.loyalty.dog/api-reference/passes->-pass-payment/delete-custom-price.md): ### Delete pass custom price
- [Get Pass Price](https://docs.loyalty.dog/api-reference/passes->-pass-payment/get-pass-price.md): ### Get pass custom price
- [Update Custom Price](https://docs.loyalty.dog/api-reference/passes->-pass-payment/update-custom-price.md): ### Update pass custom price
- [Get Pass Values](https://docs.loyalty.dog/api-reference/passes->-pass-values/get-pass-values.md): Retrieve the placeholder values of a specific pass.
- [Put Pass Values](https://docs.loyalty.dog/api-reference/passes->-pass-values/put-pass-values.md): Update the placeholder values of a specific pass.
- [Update Pass Placeholder](https://docs.loyalty.dog/api-reference/passes->-pass-values/update-pass-placeholder.md): Update a single placeholder value of a specific pass.
- [Delete Pass](https://docs.loyalty.dog/api-reference/passes/delete-pass.md): Delete a specific pass by its type identifier and serial number.
- [Get Pass](https://docs.loyalty.dog/api-reference/passes/get-pass.md): Retrieve a specific pass by its type identifier and serial number.
- [Get Pass Json](https://docs.loyalty.dog/api-reference/passes/get-pass-json.md): Retrieve detailed information of a specific pass in JSON format.
- [Get Pass Type Identifier](https://docs.loyalty.dog/api-reference/passes/get-pass-type-identifier.md): Fetch information about passes with a specific type identifier for the current user.
- [Get Pass Url](https://docs.loyalty.dog/api-reference/passes/get-pass-url.md): Retrieve the URL of a specific pass by its type identifier and serial number.
- [Get Pass Wallet Object](https://docs.loyalty.dog/api-reference/passes/get-pass-wallet-object.md)
- [Get Passes](https://docs.loyalty.dog/api-reference/passes/get-passes.md): Retrieve all passes associated with the current user.
- [Get Save Pass To Wallet Url](https://docs.loyalty.dog/api-reference/passes/get-save-pass-to-wallet-url.md)
- [Push Update To Pass](https://docs.loyalty.dog/api-reference/passes/push-update-to-pass.md): Send a push notification update for a specific pass.
- [Send Pass To Email](https://docs.loyalty.dog/api-reference/passes/send-pass-to-email.md): Send a specific pass to a user's email.
- [Post Signup Activate](https://docs.loyalty.dog/api-reference/post-signup-activate.md): Step 3 (confirm): verify the Stripe SetupIntent succeeded, create the Stripe Customer + trial Subscription, and atomically flip the User to status='active'. Wraps `services/signup.py::activate_user_from_setup_intent` (which already handles idempotency, the `pending`-only status guard, SetupIntent st…
- [Post Signup Integration Choice](https://docs.loyalty.dog/api-reference/post-signup-integration-choice.md): Step 2 of the dash signup funnel: record the merchant's wordpress|standalone pick on a `pending` User row and bump the TTL.
- [Post Signup Pending](https://docs.loyalty.dog/api-reference/post-signup-pending.md): Create or resume a pending signup. Returns the User's id as `pendingId`.
- [Post Signup Setup Intent](https://docs.loyalty.dog/api-reference/post-signup-setup-intent.md): Step 3 (mount): create a Stripe SetupIntent for the pending row and return the `clientSecret` the frontend uses to mount Stripe's PaymentElement. The `pending_user_id` is stamped into the SetupIntent's metadata so the Phase 11 webhook can correlate Stripe events back to the User.
- [Create Scanner](https://docs.loyalty.dog/api-reference/scanners/create-scanner.md): Creates a new scanner with the provided data under the current user's account.
- [Delete Scanner](https://docs.loyalty.dog/api-reference/scanners/delete-scanner.md): Deletes a scanner and all associated events.
- [Get All Scanners](https://docs.loyalty.dog/api-reference/scanners/get-all-scanners.md): Retrieves a paginated list of all scanners associated with the current user.
- [Get Scanner Information](https://docs.loyalty.dog/api-reference/scanners/get-scanner-information.md): Retrieves detailed information about a specific scanner by its ID.
- [Update Scanner Information](https://docs.loyalty.dog/api-reference/scanners/update-scanner-information.md): Updates the specified scanner with new data.
- [Get Pass Json](https://docs.loyalty.dog/api-reference/templates/get-pass-json.md)
- [Create App Key](https://docs.loyalty.dog/api-reference/token/create-app-key.md): Create an application-specific key for accessing other APIs.
- [Disable Mfa](https://docs.loyalty.dog/api-reference/token/disable-mfa.md): Disable MFA. Requires a valid TOTP code to confirm intent.
- [Get Token Info](https://docs.loyalty.dog/api-reference/token/get-token-info.md): Retrieve user information associated with the current access token.
- [Login For Access Token](https://docs.loyalty.dog/api-reference/token/login-for-access-token.md): Authenticate a user and issue a JWT access token based on valid credentials.
- [Logout](https://docs.loyalty.dog/api-reference/token/logout.md): Revoke the current session token. Subsequent requests with this token return 401.
- [Mfa Status](https://docs.loyalty.dog/api-reference/token/mfa-status.md): Return whether MFA is enrolled for the current user.
- [Setup Mfa](https://docs.loyalty.dog/api-reference/token/setup-mfa.md): Generate a TOTP secret and return the provisioning URI. Call verify-setup to complete enrollment.
- [Verify Mfa Login](https://docs.loyalty.dog/api-reference/token/verify-mfa-login.md): Complete the MFA login challenge. Returns a full JWT with mfa_verified=True.
- [Verify Mfa Setup](https://docs.loyalty.dog/api-reference/token/verify-mfa-setup.md): Verify the first TOTP code to confirm enrollment and enable MFA on the account.
- [Create Webhook](https://docs.loyalty.dog/api-reference/webhooks/create-webhook.md): Create a new webhook for the current user.
- [Delete Webhook](https://docs.loyalty.dog/api-reference/webhooks/delete-webhook.md): Delete a specific webhook by ID.
- [Disable Webhook](https://docs.loyalty.dog/api-reference/webhooks/disable-webhook.md): Disable a specific webhook by ID.
- [Enable Webhook](https://docs.loyalty.dog/api-reference/webhooks/enable-webhook.md): Enable a webhook and verify its endpoint by sending a verification token.
- [Get All Webhooks](https://docs.loyalty.dog/api-reference/webhooks/get-all-webhooks.md): Retrieve all webhooks associated with the current user based on search parameters.
- [Get Webhook Information](https://docs.loyalty.dog/api-reference/webhooks/get-webhook-information.md): Retrieve information for a specific webhook by ID.
- [Update Webhook Information](https://docs.loyalty.dog/api-reference/webhooks/update-webhook-information.md): Update the information of a specific webhook.
- [Authentication](https://docs.loyalty.dog/authentication.md): How to authenticate against the LoyaltyDog API with bearer tokens and app keys.
- [Reporting](https://docs.loyalty.dog/guides/reporting.md): Pull program performance metrics out of LoyaltyDog.
- [Wallet passes](https://docs.loyalty.dog/guides/wallet-passes.md): Issue Apple Wallet and Google Wallet passes from LoyaltyDog templates.
- [Webhooks](https://docs.loyalty.dog/guides/webhooks.md): Receive real-time events from LoyaltyDog instead of polling.
- [Welcome to LoyaltyDog](https://docs.loyalty.dog/index.md): Build loyalty programs, gift cards, and wallet passes on top of the LoyaltyDog platform.
- [Clover](https://docs.loyalty.dog/integrations/clover.md): Run LoyaltyDog on Clover devices.
- [Build a custom integration](https://docs.loyalty.dog/integrations/custom.md): Connect any system to LoyaltyDog by calling the REST API directly.
- [Eposnow](https://docs.loyalty.dog/integrations/eposnow.md): Connect Eposnow terminals to your LoyaltyDog loyalty program.
- [Integrations overview](https://docs.loyalty.dog/integrations/overview.md): First-party LoyaltyDog integrations for major commerce, POS, and automation platforms.
- [Shopify](https://docs.loyalty.dog/integrations/shopify.md): Connect a Shopify storefront to LoyaltyDog.
- [Square](https://docs.loyalty.dog/integrations/square.md): Award loyalty points and issue gift cards from Square POS transactions.
- [WordPress / WooCommerce](https://docs.loyalty.dog/integrations/wordpress.md): Connect a WordPress + WooCommerce store to LoyaltyDog.
- [Zapier](https://docs.loyalty.dog/integrations/zapier.md): No-code automations between LoyaltyDog and thousands of other apps.
- [Connect an MCP client](https://docs.loyalty.dog/mcp/clients.md): Wire the LoyaltyDog MCP server into Claude Desktop, Claude Code, Cursor, and Windsurf.
- [Install the MCP server](https://docs.loyalty.dog/mcp/installation.md): Clone, configure, and run the LoyaltyDog MCP server locally.
- [MCP overview](https://docs.loyalty.dog/mcp/overview.md): Query LoyaltyDog from Claude, Cursor, Windsurf, and other Model Context Protocol clients.
- [Quickstart](https://docs.loyalty.dog/quickstart.md): Make your first authenticated LoyaltyDog API call in under five minutes.
- [Changelog](https://docs.loyalty.dog/resources/changelog.md): Notable changes to the LoyaltyDog API and developer surface.
- [Status](https://docs.loyalty.dog/resources/status.md): Current LoyaltyDog platform status and incident history.
- [Support](https://docs.loyalty.dog/resources/support.md): How to get help with the LoyaltyDog platform.

## OpenAPI Specs

- [openapi](https://api.loyalty.dog/openapi.json)

## Optional

- [API status](https://status.loyalty.dog)
- [Marketing site](https://loyalty.dog)
- [GitHub](https://github.com/loyaltydog)