What is a Consumer Record?

The consumer record is a place for details about an individual to be stored. This data is frequently not necessary to be stored in the loyalty platform. It does, however, prove to be useful for several retailers who do not have any other platform to store this data.

📘
PII Data
It's worth noting that if you are planning to store PII data in AIR, GDPR and data removal functionalities in AIR need to be considered and implemented

Consumer Record Data Structure

{
  "type": "INDIVIDUAL",
  "status": "ACTIVE",
  "data": {
    "personal": {
      "title": "",
      "firstName": "",
      "lastName": "",
      "preferredName": "",
      "language": "",
      "gender": "",
      "birthDate": ""
    },
    "address": [
      {
        "name": "default",
        "type": "local",
        "line1": "",
        "line2": "",
        "line3": "",
        "city": "",
        "county": "",
        "state": "",
        "postcode": "",
        "country": ""
      }
    ],
    "contact": [
      {
        "name": "default",
        "type": "email",
        "value": "[email protected]"
      },
      {
        "name": "default",
        "type": "phone",
        "value": "01234567890"
      }
    ],
    "communication": [
      {
        "type": "default",
        "optin": {
          "admin": true,
          "marketing": false
        }
      },
      {
        "type": "email",
        "optin": {
          "admin": true,
          "marketing": false
        }
      },
      {
        "type": "sms",
        "optin": {
          "admin": true,
          "marketing": false
        }
      },
      {
        "type": "push",
        "optin": {
          "admin": true,
          "marketing": true
        }
      }
    ],
    "consent": [
      {
        "type": "mobileAppTerms",
        "accepted": true
      },
      {	
        "type": "profiling",
				"accepted": true
      }
    ],
    "preference": {
      "store": [
        {
          "brand": "banner1",
          "outlets": [
            "0001"
          ]
        }
      ]
    },
    "dimension": [
      {
        "label": "customKey",
        "value": "customValue"
      }
    ]
  }
}

Customisation

Dimensions

The above defines a custom dimension. These are configurable in AIR and by default, no custom dimensions are added.

Type Based Keys

Where a structure in the above has a type key, these can be expanded to hold other types. For example, in the above, consent keys of type profiling and mobileAppTerms are defined by default, an additional type can be added, if required, to support other consent keys.

    "consent": [
      {
        "type": "mobileAppTerms",
        "accepted": true
      },
      {	
        "type": "profiling",
				"accepted": true
      },
      {
        "type": "concentName",
        "accepted": true
      }
    ],