Set up ID lookup
Get your ID Vault, decide what a lookup returns, and order API access for test and production.
Before your POS can look up members, Aera sets up your ID Vault and gives you access to the Identity Services API.
1. Sign the agreement
ID lookup is part of your agreement with Aera. Which features you get, such as cross loyalty, depends on the agreement. Ask your Aera contact.
2. Order access
Email [email protected] with the information listed in Get access. An authorised person at your company must approve the order.
Aera then:
- creates your data client
- sets up your ID Vault with a loyalty concept, so data for different services stays apart
- issues API keys for the test environment, and later for production
Partners and consultants who work for you need their own access. Order it the same way, and tell Aera at once when someone no longer needs it. You are responsible for everyone you give access to.
3. Decide what a lookup returns
Agree with Aera on the loyalty type, for example PARTNER_REWARDS. When a member is found, the terminal returns the loyalty value for that type, usually the member number.
The identifiers used at the terminal:
| Identifier type | Use |
|---|---|
PAY_CARD | International cards such as Visa and Mastercard. The card number must be encrypted. See PAR and encrypted card data |
ACCOUNT_NUMBER | BankAxept cards, stored by the account number |
LOYALTY | The member number, so you can find the identity through the API |
ADDITIONAL_ID | For needs the other types don't cover |
For the full list of identifier types, see the Identity Services API.
4. Turn on ID lookup on the terminals
Ask Aera to enable ID lookup, and enrolment if you need it, on your test terminal first.
Keep it secure
If an API key leaks, or you suspect a data leak or fraud, email [email protected] at once and mark it as a security incident. See Security at Aera.
Updated 6 days ago