How the state transitions work for passes on AccessGrid

When you issue a mobile wallet pass to either Apple or Google Wallet, it can exist in various states. The goal of this guide is to show you how the state transitions work for passes issued via AccessGrid's API. The code and transitions are accessible via our docs.

These are the states that an access pass can be:

All possible pass states

When you provision a pass and a Card ID is created the state is initiated as `created`. The state only changes to `active` when a user completes the flow of installing a pass to their Apple or Google wallet.

A pass can only be `suspended` if it is `active`. This means that a pass needs to be installed first. If you try to suspend a pass that is not active, you will get a response from the API that says "can not manage a pass that is not active". Use `suspended` when a phone is lost or stolen and you want to immediately disable the credential without deleting the card entirely.

For a pass to be resumed, the pass needs to be in either the `suspended` or `unlink` state initially. Resuming will change the card's state back to `active`.

You can also unlink a card. This disables the card on the user's device, and prevents re-install from the original install URL.
 
Finally, you can delete a card that has been created, active, suspended, unlinked or resumed. This deletes the Card ID forever on all devices that it may be installed on and prevent any future installs.

The image below depicts all possible state transitions for a pass.

AccessGrid states

Feel free to use this diagram as reference for your internal workflow.

Here are the state changes that are permitted.

From "created", an access pass can transition to:

1. Active
2. Deleted

Here's a diagram to visually explain:

From "active", an access pass can transition to:

1. Suspended
2. Deleted
3. Unlinked

The way this happens is either because you the API consumer decided to change it to one of those states, or the phone owner marked the device as lost (causing a transition from active to suspended).

Here's a diagram to visually explain:

From "suspended", an access pass can transition to:

1. Active
2. Deleted
3. Unlinked

The way this happens is either because you the API consumer decided to change it to one of those states, or the phone owner marked the device as found (causing a transition from suspended to active).

Here's a diagram to visually explain:

From "unlink", an access pass can only transition to Deleted. Here's a diagram to visually explain:

From "deleted", an access pass cannot transition to any other states. Here's a diagram to visually explain:

Congrats, you made it to the end of the article. You learned the different states for an Accessgrid issued access pass. If your organization is interested in digitizing the experience of issuing and managing mobile credentials, remember that AccessGrid.com can handle the entire process for you with its API, streamlining operations, saving you effort and reducing errors. If you have any questions or need assistance, just use the chat or email [email protected] for help.