Alkami

Overview

This integration is easy to install, requires no custom coding, and includes the following features:

• Fully integrated in-app sharing: When members tap on a CTA, they can access their pre-generated referral link and refer friends via email, SMS, social, or QR code without ever leaving digital banking.
• Secure authentication with SSO: Securely verify and share member identity with Extole using JWT (JSON Web Tokens.)

Prerequisites

Before you Start

Add your Extole team to your digital banking staging and production sites

Add your Extole team to both environments so that they can assist with testing and troubleshooting.

Whitelist your digital banking staging and production domains for your Extole Program

Go to Tech Center > Domains > Branded Program Domain and click the Edit icon.

• Under Production Sites Extole Should Support Requests From - add the URL of your production digital banking site. Select "This domain and any subdomains" as the type.
• Repeat the same process for Testing Sites Extole Should Support Requests From but with URL of your staging digital banking site.

Integration Set Up

Step 1: Set-up referral microsite

To configure your referral page, go the Extole campaign editor for your referral campaign, select the Microsite creative experience, and edit the copy and creative.

When a member taps on a navigation menu item or banner within in Alkami, they'll be taken to an embedded version of the microsite.

Step 2: Set up the Alkami integration in the Extole platform

1. Go to your Program dashboard and create a promo link. Make sure to name your promo link appropriately (e.g Alkami Embedded) so that you can track downstream analytics in your Extole dashboard.
2. Then, navigate to Security > Create Access Token. Create and copy your access token and store it in a safe place, as you will not be able to access it beyond this point.
3. Lastly, navigate to Partners > Alkami and install the Alkami integration. Update the promotion URL with the promo link you created above and clickApply Changes.

Step 3: Set up a Standard SSO in the Alkami Platform

Please see the prerequisites before completing this step.

1. In your your Staging Admin Alkami account, navigate to Set-Up > Standard SSO > Create Default SSO
2. In the Default SSO configuration, update the Name to ExtoleReferrals and the Description to Extole Referrals and Rewards SSO. Then, grab your Bank Identifier and paste it in a separate document or your notes app.
3. Delete the default SSO configuration and copy and paste the following configuration. Replace the "MY_ID" from Step #3.2 above, and "MY_TOKEN" with the Token from Step #2.2 above.
   JSON

   {
     "BankIdentifier": "MY_ID",
     "ProviderName": "ExtoleReferrals",
     "Description": "Extole Referrals and Rewards SSO",
     "HttpRequest": {
       "DisplayLocation": "Inline",
       "Uri": "{{ Http('http') }}",
       "Method": "Get"
     },
     "Services": [
       {
         "Key": "http",
         "Http": {
           "Request": {
             "Uri": "https://api.extole.io/v5/zones/authorize",
             "Method": "POST",
             "ContentType": "application/json",
             "Headers": {
               "Authorization": "Bearer MY_TOKEN"
             },
             "Body": "{\"email\": \"{{ Email }}\", \"first_name\": \"{{ FirstName }}\", \"last_name\": \"{{ LastName }}\", \"member_id\": \"{{ MemberIdentifier }}\"}"
           },
           "Response": {
             "ResponseType": "Json",
             "OnSuccess": "$.redirectUrl"
           }
         }
       }
     ]
   }

Step 4: Create your navigation menu item and banners in Alkami staging

In the Alkami admin, create new menu item and name it Refer a Friend. In addition to the menu item, you can also place banner adds on your Alkami Dashboard. Connect the menu item

Step 5: QA and push to production

QA the experience in staging to ensure that everything performs flawlessly for your members. After successful QA, repeat steps 3 and 4 in your production environment.

FAQs

How does this integration work?

When a member logs into online banking and taps on a Refer a Friend CTA, Alkami will send a real-time request to Extole's API to federate the members identity and fetch the promote link.

{
  "method": "POST",
  "url": "https://api.extole.io/v5/zones/authorize",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {access_token}"
  },
  "body": {
    "email": "[email protected]",
    "first_name": "Jane",
    "last_name": "Doe",
    "member_id": "246810"
  }
}

In real-time, Extole will then respond with the promote link and a signed JWT to verify the members identify.

{
    "redirectUrl": "https://alkami-sandbox.extole.io/alkami_embedded?jwt={jwt_key}"
}

Members will then be able to access the Extole content from the promote link within digital banking. Extole will use the email address from the initial request to automatically generate their referral link. Name and member ID are then stored on the Extole profile for rewarding, reporting, and personalization.

Is this integration available for our mobile banking app?

Yes, in addition to desktop, the Extole and Alkami integration is fully supported and optimized for your mobile banking app. The referral microsite is mobile-responsive and is embedded directly within your mobile banking experience. On mobile devices, members can also share via SMS, QR code, or their favorite app.

I'm not able to preview the experience in Alkami, but I don't see any errors.

Most Extole programs have a rule to check that a users email is on the eligible members list before they are allowed to share. To by-pass this check, you can add the emails of any users to your audience in the Extole platform before testing.

What member data does Alkami share with Extole?

The following member data is securely transmitted from Alkami to Extole via SSO.