Account tagging implementation checklist

  • Updated

An account tagging solution enables your customer accounts to be flagged as belonging to various consumer audiences. Updating records in your customer database with a verified status builds a deeper relationship with your customers and makes it easier for them to take advantage of offers as they can be utilized whenever the customer is logged in.

This checklist outlines the necessary steps for implementing an account tagging solution.

  • Set offer discount method to Account Tagging

  • Create program landing / Brand-built marketing pages

    • This will be the page that leads to the SheerID form
    • The CTA that leads to SheerID, should only lead the user to the SheerID form if they are already logged in
    • Documentation: Landing page best practices
  • Pass consumer's account ID to SheerID

    • When loading the SheerID form, and account ID for the consumer should be passed to SheerID as externalUserId
    • This key must be required to avoid user dead-ends
    • We recommend using a key of externalUserId
    • Documentation: Passing a consumer's account ID
  • Webhook upon success

    • When a consumer is successfully verified SheerID will send a webhook notifier to an endpoint
    • Verification events needed: eligible only
    • Documentation: Setting up webhooks
  • Call the SheerID's /details endpoint

    • Upon receiving a verificationId from the SheerID webhook:
      • Confirm the notifierEventType (expected value "notifierEventType":"SUCCESS"
      • Use the verificationId to call our /details endpoint
    • To help with re-verification we recommend saving the date/timestamp of the verification
      • The /details endpoint will return 2 timestamps, "created" and "updated." You will want to use the "created" timestamp because it is locked-in when the verification is created. It does NOT change. Whereas the "updated" timestamp changes any time the verification data is updated. If, for some reason, the verification data was changed a month after the user verified, the "updated" timestamp would be off by a month, resulting in the user being prompted to re-verify at the wrong time.
    • Documentation: Get Details
  • Update program copy

    • Ensure your copy is tailored to your brand and audience
    • Documentation: Customizing text
  • Configure a recommended redemption limit

  • Configure a redirect URL (i.e. the success page CTA)

Testing checklist

  • Ensure the SheerID form cannot be accessed without externalUserID
  • Ensure customers are able to start a new verification when they access the verification form from your account page
  • Ensure that consumer accounts are flagged as student/educator/first responder, etc. when they reach success
  • Ensure CTAs in the success, reminder, and failure emails lead to the expected customer experience

Up-level your implementation with an optional 'Just-in-time check' upon success

What is a just-in-time check?

A just-in-time check is a two step process:

  1. Call SheerID's /searchByExternalUserId endpoint using the consumer Id you pass to the SheerID form
  2. Use the results that are returned to confirm that the user has a recent verification with a currentStep of 'success'

Why add one? While the success webhook will be the primary method of flagging an account as verified, a just-in-time check on success is a great backup to the SheerID webhook. It ensures that a customer doesn't 'beat' the webhook.

Read more about the /searchByExternalUserId endpoint here.

Was this article helpful?

/