Manage member identities

Keep your ID Vault up to date from your loyalty program: create members, add and replace cards, and delete members on request.

Signing up a member is only the start. Your loyalty program keeps the member's data in your ID Vault up to date for as long as they are a member, through Aera's Identity Services API.

📘

Endpoints and fields

This page explains which operation to use when. For the endpoints, authentication and all fields, see the Identity Services API in the API reference.

Which operation when

SituationOperations
New memberAdd a new Identity, with the member number as loyalty
Sign-up started on the terminalPartial update of an existing Identity: add the member number
New cardAdd an Identifier to an existing Identity
Replaced cardDelete an Identifier, then Add an Identifier
Changed detailsUpdate an existing Identity, or Partial update
Find a memberSearch for Identities by an Identifier · Find Identities by ConsumerId
Member leaves, or asks to be deletedDelete an existing Identity. This deletes all data about the person

The operation names are the ones used in the Identity Services API.

Complete a temporary identity

A sign-up on the terminal creates a temporary identity with the card and the mobile number. When the customer has signed up in your loyalty program, add the member number. Add it twice:

  • as a loyalty value, so the terminal returns it at checkout
  • as an identifier of type LOYALTY, so you can find the identity by member number
{
  "loyalties": [
    { "loyaltyType": "PARTNER_REWARDS", "loyaltyValue": "MEMBER123456" }
  ],
  "identifiers": [
    { "identifierType": "LOYALTY", "identifierValue": "MEMBER123456" }
  ]
}

Loyalty values don't need to be unique. Identifiers must be: each one points to exactly one identity.

Add a new member

Create the identity with the member number and the cards in one call.

Example: new member with a payment card
{
  "identity": {
    "attributes": [
      { "attributeType": "MOBILE_NUMBER", "attributeValue": "+4791234567" }
    ],
    "identifiers": [
      { "identifierType": "LOYALTY", "identifierValue": "MEMBER123456" },
      {
        "identifierType": "PAY_CARD",
        "identifierValue": "************1761",
        "bin": "540481",
        "cardScheme": "MASTERCARD",
        "encryptionKey": { "keyId": "0", "encryptionType": "RSAOAEP" },
        "encryptedValue": "<encrypted card number>",
        "paymentAccountReference": "512381d9f8e0629211e3949a08002"
      }
    ],
    "loyalties": [
      { "loyaltyType": "PARTNER_REWARDS", "loyaltyValue": "MEMBER123456" }
    ]
  }
}
Example: BankAxept card stored by account number
{
  "identity": {
    "loyalties": [
      { "loyaltyType": "PARTNER_REWARDS", "loyaltyValue": "MEMBER123456" }
    ],
    "identifiers": [
      { "identifierType": "ACCOUNT_NUMBER", "identifierValue": "12345678911" },
      { "identifierType": "LOYALTY", "identifierValue": "MEMBER123456" }
    ]
  }
}

Add a new card

Find the identity, for example by mobile number, then add the card as a new identifier. Card numbers must be encrypted: see PAR and encrypted card data.

{
  "identifier": {
    "identifierType": "PAY_CARD",
    "identifierValue": "************1761",
    "bin": "540481",
    "cardScheme": "MASTERCARD",
    "encryptionKey": { "keyId": "0", "encryptionType": "RSAOAEP" },
    "encryptedValue": "<encrypted card number>",
    "paymentAccountReference": "512381d9f8e0629211e3949a08002"
  }
}

Move existing members to Aera

Already have a member register with consents? Create the identities through the API, without a sign-up on the terminal. For large numbers, write a small program that calls the API, or ask Aera to import the data as a paid assignment. You are responsible for the data quality and for sending the data securely.

Let members add their own card

Aera's Hosted Identity Page lets the customer add a payment card themselves. Ask Aera if it fits your use case: it was built for other purposes, and the card is stored as a merchant-initiated (MIT) card.

Delete a member

A delete on the identity removes all data about the person. Use it for "delete me" requests under GDPR.

Next


Did this page help you?