Sign in
Identities

Suspend Wallet Identity

This API method allows the calling application to mark a Wallet Identity as SUSPENDED (by setting Wallet Identity status equal to SUSPENDED). That change would block this Wallet Identity from being used so it can't be used to access a Wallet.

patch/wallet/{walletId}/identity/{identityId}/suspend

Path parameters

walletIdstring string required

EES AIR Wallet ID

identityIdstring string required

EES AIR Wallet Identity ID

Request body

EmptyPatchPayload required

Response

OK

identityIdstring required

EES AIR Wallet Identity ID

walletIdstring required

EES AIR Wallet ID

typestring required

Type of the Identity, list of possible enum values could be defined per Client as part of the Onboarding process.

friendlyNamestring required

Wallet Identity friendly name

valuestring required

Wallet Identity value

safeValuestring required

Identity Safe Value (e.g. "original value salted and hashed") - safeValue could be than used in external systems like analytics, referencing original identity, provide uniqueness within a retailer, but without exposing sensitive information like card number.

secretstring required

Wallet Identity secret

statestring required

Wallet Identity state, list of possible values could be defined and set-up per Client during Onboarding process.

status'ACTIVE' | 'DELETED' | 'SUSPENDED' | 'LOST' | 'STOLEN' | 'INACTIVE' required

Identity status

dateCreatedstring date-time required

Date this identity was created

lastUpdatedstring date-time required

Date this identity was last updated

mobileWalletstring required

A url that can be used to add this identity to a mobile wallet (like Apple Wallet and Google Pay)

Changes

No recorded changes to this endpoint across all 1 revision of this API.