📌 Purpose

After setting up your retailer brand in AIR, a default set of identity types will be created, including CARD, CONSUMER_ID, MOBILE and EMAIL. This recipe guides you through creating an additional identity type for your organization where auto generated identity values are required. This setup will allow for the value of the identity to be auto generated and define the available variables that can be used to customize the value to your requirements. A wallet Identity is a way to identify themselves as a loyalty member across various channels.

See the Create Identity Type API reference for additional options that can be configured against identities.

🖼 Recipe Overview

In this recipe, you will set up an additional identity for a member ID that has requirements for specific characters to be generated. We will use a mix of wildcards for any numeric value and set placeholders for upper case letters. After all steps are completed, your brand will have a new identity type that can be created and used across the Eagle Eye platform and available in the wallet.

📋 Prerequisites

Ensure you have:

• Access to Eagle Eye APIs
• Your company unit’s clientId and secret
• The unitId for your top-level company brand
• Name for the new identity type

📤 Outputs

As you complete each step, note these outputs for future API calls and program validation:

📒 Steps

Step 1: Create Your Identity Type

• 1.1 Choose a name for your new identity type. We will use MEMBER_ID for this example.
• 1.2 Define auto generate format

• 1.3 Recommended configurations:
  • defaultState: EARNBURN
  • defaultState: ACTIVE

Step 2: Call POST /units/unitId/walletConfig/identityTypes

Send the setup request to create your identity type in the platform.

• 2.1 Use the POST /units/unitId/walletConfig/identityTypes endpoint
• 2.2 Pass in your company's unitId value in the request URL

{
    "name": "MEMBER_ID",
    "configuration": {
        "defaultStatus": {
            "value": "ACTIVE"
        },
        "defaultState": {
            "value": "EARNONLY"
        },
        "format": {
            "value": "A#######~"
        },
        "autoGenerateValueFlag": {
            "value": true
        },
        "allowInputValueFlag": {
            "value": true
        },
        "maxGenerationAttempts": {
            "value": 3
        }
    }
}

{
    "id": "21674",
    "name": "MEMBER_ID",
    "configuration": {
        "defaultStatus": {
            "value": "ACTIVE"
        },
        "defaultState": {
            "value": "EARNONLY"
        },
        "format": {
            "value": "A#######~"
        },
        "autoGenerateValueFlag": {
            "value": true
        },
        "allowInputValueFlag": {
            "value": true
        },
        "maxGenerationAttempts": {
            "value": 3
        }
    }
}

Repeat this step for every identity type needed.

✅ Business Readiness Checklist

Use these checks to confirm your identity type is set up correctly:

• Create a new identity in a wallet using Create Wallet Identity
• Verify auto generate rules are working as new identities are created
• Verify default state and status are set upon create of a new identity in a wallet if the state and status are left out of the create identity request

🔧 Troubleshooting Tips