Skip to main content

Allow users to recover an existing pass

Using the enrolment form to recover an existing pass.

Danny Allen avatar
Written by Danny Allen
Updated over a week ago

With this option enabled in Program Settings, users who have previously enrolled and attempt to re-enroll with identical information will be presented with their original pass to add to Wallet.

Note - This feature is only available for Membership and Loyalty Programs (and other variations of passes that use those pass types).


Terminology

Pass Recovery

A feature that allows users who have previously enrolled in a program to retrieve their original pass if they attempt to re-enroll with identical information.

External ID Autofill

A setting that automatically populates the External ID field with either the user's email address or mobile number. This is crucial for the Pass Recovery feature to function, as the External ID must be unique within a program.

External ID

A unique identifier assigned to a user within a specific program, often their email address or mobile number, used for pass recovery when the Pass ID or Pass Link is unknown.

Program Settings

The administrative section within the system where various features and configurations for a program are managed, including Pass Recovery and External ID Autofill.

Distribution Form

A form used by users to enrol in a program and receive a pass.

Wallet

A digital wallet application (e.g., Apple Wallet, Google Wallet) where users can store and access their digital passes.


Enabling Pass Recovery

External ID Autofill

The external ID Autofill feature must be enabled in order for the recovery function to work. This can be set to add the Email address or the Mobile Number as the External ID automatically.

The external ID must be unique within a Program which is why it needs to be used in any recovery of the pass, where the Pass ID or Pass Link is not known.

Navigate to the program settings

Click on Settings on the top menu, then select "Program Settings"

Select your preferred External ID

In this example I will be using the email address.

The External Id Error Message does not need to be added for this use.


Pass Recovery Settings

Pass Recovery Settings must be enabled in the program settings.

Enable Pass Recovery settings

When looking at the Program Settings, check the box next Allow users to recover an existing pass through our distribution form.

Click Save when done.


Test it's working

How it works

If a user has already enrolled and uses the same information to enrol again, they will receive their original pass.

Enrol a Member

Navigate to the the Distribution page and click on the share button to copy the enrolment page URL.

Enrol your member using the enrolment form

Paste the URL to you browser and complete the form.

View the member in your member list

Navigate to the member list to view the member you just added. Note the PassKit ID.

Try enrolling again

Use the enrolment link to open the form again, and use the same details to enrol again.

Note: The details used to enrol must be identical to the details originally used to enrol.

You will be taken to the landing page after completing the form, but a new pass has not been created, instead the user has been presented with the original pass. You can look in the Membership List again to see that no other pass has been issued.

Try enrolling with the same email address, but a different name

The details used to enrol must be identical to the details originally used to enrol, if they don't match the user will see an error.

Did this answer your question?