Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.rxscale.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Wallet Passes

Wallet passes are digital cards that patients carry on their phones for identity verification. This page explains how telemedicine providers can use wallet passes in their workflow.

​
What Are Wallet Passes?

A wallet pass is a digital card stored in a patient’s Apple Wallet or Google Wallet app. It contains a QR code that can be scanned to verify the patient’s identity. Think of it as a digital membership card that is always available on the patient’s phone. Wallet passes are useful for:
  • Patient verification — Confirming a patient’s identity at a pharmacy or during a consultation.
  • Quick identification — Allowing staff to look up a patient’s information by scanning their QR code.
  • Push notifications — Sending updates to patients directly through their wallet pass.

​
Creating Wallet Passes

You can create wallet passes for your patients using the Management API. When you create a wallet pass:
  1. The system generates a unique wallet pass for the patient.
  2. The patient receives a link to add the pass to their phone.
  3. Once added, the pass is stored in their Apple Wallet or Google Wallet.
Patients need to actively add the pass to their phone. The pass is not installed automatically — they will receive a link and need to tap it to add it.

​
Managing Wallet Passes via API

The Management API provides full CRUD access for wallet passes. All endpoints require an API key with the appropriate permissions (wallet_pass:read, wallet_pass:write).

​
Create or Update a Wallet Pass

Use the create endpoint to issue a new wallet pass for a patient. If a wallet pass already exists for the same template and patient, it will be updated instead of creating a duplicate. 
curl -X POST "https://api.rxscale.com/v1/management/wallet-passes" \
  -H "X-API-Key: {api_key}" \
  -H "Content-Type: application/json" \
  -d '{
    "wallet_pass_template_uid": "wpt-abc123",
    "shop_customer_id": "cust-123",
    "shop_identifier": "my-shop"
  }'
Response (201 Created for new passes, 200 OK for updates): 
{
  "uid": "wp-abc123",
  "wallet_pass_template_uid": "wpt-abc123",
  "external_id": "ext-123",
  "serial_number": "SN-123",
  "ios_download_url": "https://...",
  "android_download_url": "https://...",
  "patient_profile_uid": "pp-abc123",
  "created_at": 1712000000
}
The response includes download URLs for both iOS and Android. Share these links with your patient so they can add the pass to their phone.
The create endpoint uses upsert semantics. You can safely call it multiple times for the same patient and template without creating duplicate passes.

​
Get a Wallet Pass

Retrieve details for a specific wallet pass by its UID: 
curl -X GET "https://api.rxscale.com/v1/management/wallet-passes/{wallet_pass_uid}" \
  -H "X-API-Key: {api_key}"

​
List Wallet Passes

List all wallet passes for a specific customer: 
curl -X GET "https://api.rxscale.com/v1/management/wallet-passes?shop_customer_id=cust-123&shop_identifier=my-shop" \
  -H "X-API-Key: {api_key}"
You can optionally filter by template using the wallet_pass_template_uid query parameter.

​
Delete a Wallet Pass

Revoke a wallet pass when it is no longer needed: 
curl -X DELETE "https://api.rxscale.com/v1/management/wallet-passes/{wallet_pass_uid}" \
  -H "X-API-Key: {api_key}"
Returns 204 No Content on success. The pass is removed from the external wallet pass provider and will no longer be valid on the patient’s phone.

​
List Templates

List available wallet pass templates for a shop: 
curl -X GET "https://api.rxscale.com/v1/management/wallet-passes/templates?shop_identifier=my-shop" \
  -H "X-API-Key: {api_key}"

​
Send Push Notifications

Send push notifications to patients through their wallet passes: 
curl -X POST "https://api.rxscale.com/v1/management/wallet-passes/push-notifications" \
  -H "X-API-Key: {api_key}" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "wallet_pass_uid": "wp-abc123",
      "message": "Your prescription has been signed."
    }
  ]'
When you update a pass, the changes are automatically pushed to the patient’s phone. They do not need to take any action to see the updated information.

​
Automatic Refresh on Patient Profile Changes

When a patient’s profile is updated (e.g. name change after marriage), all existing wallet passes for that patient are automatically refreshed. The updated data is pushed to the wallet pass provider so the patient’s pass always shows current information.

​
Push Notifications

One of the most powerful features of wallet passes is the ability to send push notifications to patients. When a patient has your wallet pass on their phone, you can send them notifications that appear on their lock screen. Common uses for push notifications:
  • Notifying patients that their prescription has been signed.
  • Alerting patients that their order has shipped.
  • Reminding patients about upcoming consultations.
Push notifications are sent through the wallet pass platform, so patients receive them even if they are not actively using your app.

​
Patient Verification via QR Code

The QR code on a wallet pass enables a secure identity verification process:
1

Patient shows their wallet pass

The patient opens their wallet app and displays the QR code on their pass.
2

Staff scans the QR code

A pharmacy staff member or other authorised person scans the QR code using the RxScale system.
3

OTP verification

The system sends a one-time password (OTP) to the patient’s registered phone number via SMS.
4

Identity confirmed

The patient provides the OTP to the staff member. Once verified, the patient’s identity is confirmed.
This two-step verification (QR code plus OTP) ensures that only the actual patient can complete the verification, even if someone else has a copy of the QR code.