Add to Apple Wallet and Health Guidelines

The Add to Apple Wallet and Health button gives people a visual cue that they can securely download and store their COVID-19 vaccination information in the Apple Health app and save a vaccination card to Apple Wallet.

Download button artwork (36.8 MB)

Basic requirements

  • The Add to Apple Wallet and Health button shown in these guidelines should appear only in association with your HealthKit-compatible verifiable vaccination records using either the SMART Health Cards or EU Digital COVID Certificate frameworks.

  • Only use button artwork provided by Apple. Do not modify or alter any artwork provided by Apple.

  • Use the appropriate credit line and, when appropriate, trademark symbols in all communications related to Apple Wallet and Apple Health. View legal requirements.

Before you start

  • Verify that your organization’s patient record system is capable of generating:
  • When validating your implementation, use a test patient account populated with synthetic data. If creating a test patient isn't possible with your implementation, use the best practices defined by your organization during validation.

Implementing the Add to Apple Wallet and Health button

The Add to Apple Wallet and Health artwork is designed to be used as a button in apps, web pages, and email, or included as a badge with a QR code on printed material. The button should appear only in association with your HealthKit-compatible verifiable vaccination records that use either the SMART Health Cards or EU Digital COVID Certificate frameworks.

Verify minimum iOS compatibility

Verify that a user’s device is an iPhone with the minimum iOS version that supports your implemented framework. The feature won't work on devices with a version of iOS that doesn't support your implemented framework or on iPad.

For the SMART Health Cards framework, the minimum supported version is iOS 15.1. For the EU Digital COVID Certificate framework, the minimum supported version is iOS 15.4. Implement the following checks to ensure compatibility:

  • iOS app: Check for HealthKit availability by using HKHealthStore.isHealthDataAvailable and check the iOS version by using NSProcessInfo.operatingSystemVersion.
  • Web page: Check the browser user agent. An example user agent for this type of device would be: Mozilla/5.0 (iPhone; CPU iPhone OS 15_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko).
  • Email:
    • SMART Health Cards framework: Near the Add to Apple Wallet and Health button, let the user know that the button only works on devices running iOS 15.1 or later.
    • EU Digital COVID Certificate framework: Near the Add to Apple Wallet and Health button, let the user know that the button only works on devices running iOS 15.4 or later.

Transform the QR Code URL

To implement the Add to Apple Wallet and Health button in an app, web page, or email, transform the URL for each unique QR code and include it as the URL for the Add to Wallet and Health button.

SMART Health Cards framework
Replace the leading shc:/ with https://redirect.health.apple.com/SMARTHealthCard/. The long string of numbers after shc:/ must not be modified or altered during this process because this string contains the vaccination record data.

EU Digital COVID Certificate framework
Replace the leading HC1: with https://redirect.health.apple.com/EU-DCC/#. The long string of alphanumerical characters after HC1: must be URL-encoded (ref: https://www.rfc-editor.org/rfc/rfc3986#section-3.5) and appended.

Validate the transformed URL

The Add to Apple Wallet and Health button should invoke the transformed URL as a direct link that iOS will automatically recognize, prompting the user to add the vaccination record to Health and create a vaccination card in Wallet. Validate that you can tap the button in the appropriate app, web page, or email.

Adding the button to apps, web pages, and emails

Use the scalable SVG artwork provided by Apple for buttons on your apps, web pages, and emails. Place the button directly below the SMART Health Card or EU Digital COVID Certificate QR code and other information related to the user’s vaccination record.

Since users can open the web page or email on a wide range of devices, include a sentence such as, “To add this pass to Wallet and Health, open this email on your iPhone or iPod touch.”

Localization

Use only the localized artwork provided by Apple. Do not create your own localized version. Apple will provide localized versions of the button for regions where the feature is supported by local healthcare organizations.

Background color

Place the button on a clear, uncluttered background. Use a white, black, or very dark grey background for maximum legibility.

Clear space for onscreen use

The minimum clear space for onscreen layouts is .1X where X is the height of the button. Always use the button at a size that's clearly legible in the media resolution of your communication.

iOS app

Place the button directly below the SMART Health Card or EU Digital COVID Certificate QR code and other information related to the user’s vaccination record.

Tapping the button adds a vaccination record to Apple Health and Apple Wallet.

Including Add to Apple Wallet and Health artwork on printed vaccination cards

  • When you provide a printed version of the SMART Health Card or EU Digital COVID Certificate, you may choose to include information about how to add a vaccination record to Apple Health and a vaccination card to Apple Wallet.
  • The Add to Apple Wallet and Health button should appear only in association with a SMART Health Card or EU Digital COVID Certificate and must be accompanied by a QR code or download link.
  • Users can use the Camera app to scan a QR code from a web page, email, or printed material to add the SMART Health Card or EU Digital COVID Certificate vaccination record to Apple Health and a vaccination card to Apple Wallet.

Artwork

Use the scalable EPS artwork provided by Apple in your printed SMART Health Card or EU Digital COVID Certificate.

Clear space and size requirements

On printed SMART Health Cards, the minimum button size for the Add to Apple Wallet and Health button is 8 mm in height and the maximum size is 25 mm in height. Do not reduce or enlarge the button beyond these sizes. Minimum clear space is one-quarter the height of the button.

QR codes

The recommended minimum QR code size for optimum scanning is 40 mm for each dimension.

Button and QR code alignment

We recommend that the QR code and Add to Apple Wallet and Health button align to equal width. If they're not equal width, you can align the QR code to the left or center.

Clear space

Allow minimum clear space around the Add to Apple Wallet and Health button. Make sure you also comply with the requirements for clear space (called a quiet zone) for the QR code. QR codes must be printed on a light background and their clear space must be the same color. If your layout has a dark background, don't extend the QR code’s clear space behind the Add to Apple Wallet and Health button. The QR code's clear space should surround only the QR code, and the Add to Apple Wallet and Health button shouldn't touch the QR code’s clear space on dark backgrounds.

Editorial guidelines

Suggested messaging

Use messaging that describes Apple Wallet in communications promoting Wallet-compatible verifiable vaccination records. Place your messaging near the Add to Apple Wallet and Health button that accompanies the verifiable vaccination record or in general product communications to describe compatibility with Wallet.

Use the following suggested messaging to describe the Add to Apple Wallet and Health feature or develop your own copy that follows the guidelines below.

“Adding your verifiable vaccination information to Apple Wallet and the Apple Health app allows you to securely store your vaccination record in the Health app and enables you to quickly present your vaccination card from Wallet.”

Referring to Apple apps

Using the name Apple Wallet or Wallet

  • When using the name Apple Wallet or Wallet in headlines or copy, always typeset Wallet with an uppercase W followed by lowercase letters. Typeset Apple with an uppercase A followed by lowercase letters. Apple Wallet is set as two words.
  • If a headline is typeset in all uppercase, the words Apple Wallet within the headline can also be all uppercase.
  • You can refer to the Wallet app from Apple or Apple Wallet on the first mention of the app. In subsequent references, just Wallet can be used.
  • In communications in the United States, use the registered trademark symbol (®) the first time Apple appears in body copy.

Using the name Apple Health or Health

  • You can refer to the Apple Health app or the Health app from Apple. After first mention, Health app can be used. Typeset Apple with an uppercase A followed by lowercase letters, and Health with an uppercase H followed by lowercase letters.
  • Don't refer to Apple Health data. Health data belongs to the user, not Apple.

Avoid mistakes

  • Do not create your own version of the Add to Apple Wallet and Health button. Only the Apple-provided artwork shown in these guidelines is approved by Apple.
  • Do not let the Add to Apple Wallet and Health button dominate your layout as the primary message or main graphic. It must be secondary to your main message and product or company identity.
  • Do not obstruct the badge or button with text, graphics, violators, or images.
  • Do not display a dimmed version of the button.
  • Do not use the Wallet icon alone.
  • Do not use the Health icon alone.
  • Do not flip, rotate, or animate the artwork.
  • Do not add visual effects such as shadows, glows, or reflections to the mark.
  • Do not use graphics or images from Apple’s website.
  • Do not imitate Apple communications.
Do not change the font, color, or any other elements of the button.
Do not tilt or animate the button.
Do not use the Apple Wallet app icon on its own.
Do not use the Apple Heath app icon on its own.