Welcome to our new developer portal! Use the "Ask" button to chat with our AI Agent.
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Suspend/Resume from iCloud

Apple initiated suspension and resumption are actions initiated by the user using iCloud, in particular the Find My service. To learn more, visit the respective pages for Suspension and Resumption.

This section provides an overview of the workflow, including detailed steps, sequence diagrams, and potential error scenarios.

Workflow

Suspension

Below are the high level steps of the suspension workflow:

  1. Suspension initiation : The user activates Lost Mode using the Find My service. This results in all cards on the users Wallet becoming suspended.

  2. Suspension notification: Apple will notify D1 Transit that card(s) should be placed into a suspended state.

Resumption

Below are the high level steps of the resumption workflow:

  1. Resumption initiation : Once the user regains possession of his device, he can initiate the resumption workflow.

  2. Resumption notification: Apple will notify D1 Transit that card(s) should be resumed for active use.

Sequence Diagram

Suspension

The user initiates the suspension workflow by activating Lost Mode via the Find My service. For each card in the user's Wallet, Apple will attempt to suspend the pass on the device, though this is on a best-effort basis since the device could be offline. Additionally, Apple notifies D1 Transit platform of the suspension by sending a managePass request, with the action parameter set to suspend.

D1 Transit then notifies the Transit Issuer so it can put the card to the deny list, ensuring it cannot be used for transit. This step is crucial if the device is offline, as the card may not be suspended immediately.

Error Scenarios

Device is offline

If the device is offline, the request to suspend the card is queued and will be sent to the device as soon as it reconnects.

Resumption

The user initiates the resumption process by authenticating to his device, which is currently in Lost Mode. For each card in the user's Wallet, Apple will attempt to resume the pass on the device, though this is on a best-effort basis since the device could be offline. Apple notifies D1 Transit platform of the resumption by sending a managePass request, with the action parameter set to resume.

D1 Transit then notifies the Transit Issuer. Transit Issuer, if the card is on the deny list, can remove it to allow transit use.

Error Scenarios

Device is offline

If the device is offline, the request to resume the card is queued and will be sent to the device as soon as it reconnects.

Last updated

Was this helpful?