Identities

Get Wallet Identity by Identity Id

Changed on

This API method allows the calling application to retrieve Wallet Identity details for a specific wallet.

get/wallet/{walletId}/identity/{identityId}

Request

  • Base URL
    https://wallet.uk.eagleeye.com/2.0
  • URL
    https://wallet.uk.eagleeye.com/2.0/wallet/{walletId}/identity/{identityId}
  • Auth
    API key in header X-EES-AUTH-CLIENT-ID and API key in header X-EES-AUTH-HASH

Path parameters

walletIdstring string required

EES AIR Wallet ID

identityIdstring string required

EES AIR Wallet Identity ID

Response

OK

identityIdstring

EES AIR Wallet Identity ID

walletIdstring

EES AIR Wallet ID

typestring

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

friendlyNamestring

Wallet Identity friendly name

valuestring

Wallet Identity value

safeValuestring

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 sensible information like card number.

secretstring

Wallet Identity secret

statestring

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

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

Identity status

dateCreatedstring

Date this identity was created

lastUpdatedstring

Date this identity was last updated

mobileWalletstring

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

Example response

{
  "dates": {
    "start": "2017-01-17T13:20:48+00:00",
    "end": "2017-01-17T13:20:48+00:00"
  },
  "dateCreated": "2017-01-17T13:20:48+00:00",
  "lastUpdated": "2017-01-17T13:20:48+00:00"
}

Changes

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response's property format changed from date-time to no format for status

    • breaking

      the / response's property format changed from date-time to no format for status

    • breaking

      the / response's property format changed from date-time to no format for status

    • breaking

      the response's property format changed from date-time to no format for status

    • warning

      added the new AALR enum value to the //// response property for the response status

    • warning

      added the new AALR enum value to the //// response property for the response status

    • warning

      added the new AALR enum value to the //// response property for the response status

    • warning

      added the new CILR enum value to the //// response property for the response status

    • warning

      added the new CILR enum value to the //// response property for the response status

    • warning

      added the new CILR enum value to the //// response property for the response status

    • warning

      added the new CLPPR enum value to the //// response property for the response status

    • warning

      added the new CLPPR enum value to the //// response property for the response status

    • warning

      added the new CLPPR enum value to the //// response property for the response status

    • warning

      added the new ELE enum value to the //// response property for the response status

    • warning

      added the new ELE enum value to the //// response property for the response status

    • warning

      added the new ELE enum value to the //// response property for the response status

    • warning

      added the new RF enum value to the //// response property for the response status

    • warning

      added the new RF enum value to the //// response property for the response status

    • warning

      added the new RF enum value to the //// response property for the response status

    • warning

      added the new RFL enum value to the //// response property for the response status

    • warning

      added the new RFL enum value to the //// response property for the response status

    • warning

      added the new RFL enum value to the //// response property for the response status

    • warning

      added the new TBR enum value to the //// response property for the response status

    • warning

      added the new TBR enum value to the //// response property for the response status

    • warning

      added the new TBR enum value to the //// response property for the response status

    • warning

      added the new TBS enum value to the //// response property for the response status

    • warning

      added the new TBS enum value to the //// response property for the response status

    • warning

      added the new TBS enum value to the //// response property for the response status

    • warning

      added the new TERMINATED enum value to the response property for the response status

    • warning

      added the new WLNF enum value to the //// response property for the response status

    • warning

      added the new WLNF enum value to the //// response property for the response status

    • warning

      added the new WLNF enum value to the //// response property for the response status

    • warning

      added the new WTF enum value to the //// response property for the response status

    • warning

      added the new WTF enum value to the //// response property for the response status

    • warning

      added the new WTF enum value to the //// response property for the response status

    • warning

      added the new WTNF enum value to the //// response property for the response status

    • warning

      added the new WTNF enum value to the //// response property for the response status

    • warning

      added the new WTNF enum value to the //// response property for the response status

    • info

      added to the response body allOf list for the response status

    • info

      added to the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response's property pattern /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/ was added for the status

    • info

      the / response's property pattern /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/ was added for the status

    • info

      the / response's property pattern /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/ was added for the status

    • info

      the response's property pattern /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/ was added for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    This list may be incomplete.