Skip to main content

Identity & Sign-In

What it does: Manages how customers create accounts, sign in, manage their profile, and control privacy settings.

Why it matters: Every loyalty interaction, order history, saved address, and personalised offer depends on a customer being authenticated. Without sign-in, customers can only use guest checkout β€” they have no access to rewards, order history, or saved preferences.


Feature Table​

FeatureProblem It SolvesWhat It DoesHow It WorksDependenciesPrerequisitesLimitationsImpacted Metrics
Create Account with EmailNew customers need a way to registerLets customers sign up with an email address and a one-time PINCustomer enters email β†’ receives OTP β†’ verifies β†’ account created; session token issuedIdentity/SSO service, Email deliveryEmail service active for marketOTP rate-limited per device (prevents abuse)Sign-up conversion rate
Sign In with Email + OTPReturning customers need to access their accountPasswordless sign-in via email OTPCustomer enters email β†’ receives OTP β†’ verifies β†’ session resumedIdentity/SSO service, Email deliveryAccount must existOTP attempt limit with backoffLogin success rate, session duration
Sign In / Register with GoogleCustomers prefer social login over emailOne-tap Google account link for sign-in or registrationGoogle OAuth2 flow β†’ Identity service exchanges token β†’ account created or linkedGoogle OAuth, Identity/SSOGoogle OAuth enabled for marketRequires Google account; market enablement decisionSocial login adoption rate
Sign In / Register with Apple IDiOS users expect native Apple sign-inSign in with Apple for iOS/macOS customersApple OAuth flow β†’ token exchanged β†’ account created or linkedApple Sign-In, Identity/SSOApple developer config per marketApple only; requires Apple accountiOS sign-up rate
Edit ProfileCustomers need to update their detailsLets signed-in customers update their name, DOB, and contact infoProfile update call to Identity service; changes persisted in CRMIdentity/SSO, CRMCustomer must be signed inFields vary by market configurationProfile completion rate
View & Change Communication PreferencesCustomers must control how they are contactedShows and updates email/push/SMS opt-in status per channelReads from CRM; customer updates trigger CMP sync and audit trailCRM, CMP, Push providerSigned in; consent framework active for marketAudit trail mandatory; changes loggedEmail/push opt-in rate
Delete AccountCustomers have a right to erasure (GDPR)Initiates account deletion request across all connected systemsSends deletion request to Identity; cascades to CRM, LoyaltyIdentity/SSO, CRM, Loyalty serviceCustomer must be signed in; no pending ordersDeletion may take time to propagate; loyalty data deletedDeletion request rate
Sign OutCustomers need to end their session securelyEnds the session, clears tokens, unregisters pushSession invalidated in Identity; push token unregisteredIdentity/SSO, Push providerActive sessionNoneN/A
View Terms & Conditions / Privacy PolicyCustomers must be able to see what they agreed toRenders the latest legal documents for the market's localeFetches versioned document from Legal CMS; CDN-cachedLegal CMS, CMPNone (available to guests)Content managed by Legal team, not Byte HeliumLegal compliance
Cookie Consent SettingsRegulatory requirement in many marketsShows cookie categories; lets customers accept/rejectCMP provides consent widget; preferences stored with timestampCMPNone (available to guests)Market must configure CMP categoriesConsent acceptance rate

Technical Sources​

πŸ“Ž Technical Source: Create Account with Email
  • FRD References: FRD-HEL-001
  • TRD Domain: Identity & Sign-In
  • Key Interfaces / APIs: Auth Email, OTP Verify, Session Mint
  • Data Contracts: Session (accessToken, refreshToken, expiry)
  • Source Summary:
    • OTP verified via Identity service; rate-limited per device (429 backoff)
    • Session token stored in device secure keystore (iOS/Android)
    • Auth endpoints SLO: 99.95% monthly availability
    • Backward compatible SemVer; 90-day deprecation window
    • PII masking applied in all logs
πŸ“Ž Technical Source: Sign In with Google / Apple
  • FRD References: FRD-HEL-003, FRD-HEL-004, FRD-HEL-027, FRD-HEL-028, FRD-HEL-029, FRD-HEL-030
  • TRD Domain: Identity & Sign-In
  • Key Interfaces / APIs: OAuth Google Callback, OAuth Apple Callback, Session Mint
  • Data Contracts: Session (accessToken, refreshToken, expiry)
  • Source Summary:
    • OAuth2 flow: IdP β†’ Identity service β†’ session token
    • Existing account: linked; new account: created in same flow
    • No PAN or sensitive data in OAuth payload
    • Market enablement: both providers configurable per market
    • 90-day API deprecation window
πŸ“Ž Technical Source: Delete Account
  • FRD References: FRD-HEL-067
  • TRD Domain: Identity & Sign-In + CRM + Loyalty
  • Key Interfaces / APIs: Account Delete Request/Status
  • Data Contracts: Account erasure request (userId, timestamp, status)
  • Source Summary:
    • GDPR-compliant erasure flow; cascades to CRM and Loyalty
    • Deletion is asynchronous; status available via polling
    • Loyalty balance and history permanently deleted
    • Audit log retained for compliance (anonymised)
    • Blocks re-use of same email for configurable period

See it in the wiki

The Identity domain maps to the customer-facing sign-in and account flows documented in the Front-end Guide: Access Account & Manage Profile