📌 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 additional identity types for your organization. This setup ensures wallets can found using identities. A wallet Identity is simply the information a customer shares during a purchase, which allows your company to connect to their wallet.

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 mobile app identifier. By the end, your brand will have a new identity type that can be created and used in other API calls 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. We will use APP for this recipe.
• 1.2 Recommended configurations:
  • defaultState: EARNONLY (ensures this identity cannot burn points immediately)
  • 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": "APP",
	"configuration": {
		"defaultState": {
			"value": "EARNONLY"
		},
		"defaultStatus": {
			"value": "ACTIVE"
		}
	}
}

{
    "id": "5895",
    "name": "APP",
    "configuration": {
        "defaultState": {
            "value": "EARNONLY"
        },
        "defaultStatus": {
            "value": "ACTIVE"
        }
    }
}

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 POST wallet/{walletId}/identity
• Verify default state and status are set upon create of a new identity in a wallet

🔧 Troubleshooting Tips