URL Parameters

URL parameters (or query strings) are a way to structure additional information for a Uniform Resource Locator (URL). Parameters are added to the end of a URL after a question mark ? symbol and can be used to track information about a click. Unique URL parameters added to your Account Opening URL allow your institution to track where an application came from, for example, from a digital ad or a specific campaign on your website.

The structure of the URL with parameters includes the base URL, the key, and the value. For example:

https://fi_name-open.uat.narmitech.com/welcome?ad_campaign=Fall2023

The base URL includes everything up to the question mark ? symbol. The key is ad_campaign and the value is Fall2023

Multiple parameters can be included when separated by the ampersand & symbol. For example, this is a URL with multiple key-value pairs:

https://fi_name-open.uat.narmitech.com/welcome?key=value&key=value&key=value

You can also combine URL parameters with pre-selected products on the application by using the ampersand & symbol. For example, this is a URL with the parameter ad_campaign=Fall2023 and the product-specific link selected=11:

https://fi_name-open.uat.narmitech.com/welcome?ad_campaign=Fall2023&selected=11

For more information on custom URLs for pre-selected products, go to Product-Specific Links.

Narmi has the ability to write the values of these parameters to the core, but only for institutions using Symitar or ESBs. Narmi can also pass the unique URL parameter to Alloy. Alloy would need to find the value in the metadata field.

To add URL parameters to your Account Opening URL, follow the requirements and configuration below.

Requirements

There are two requirements for URL parameters:

1. In order to write the value to the core, there must be a corresponding AccountCreatableField that exists in your core. Note: Narmi has the ability to write the values of these parameters to Symitar or ESBs cores only. 
2. Your institution must configure the key Narmi writes to the core within the Allowed URL Parameters Institution Setting of the Admin Platform. This is described in the Institution Settings Configuration section below.

Note: Some cores may have default validations on the fields that we post these values to. For example, some cores only allow integer values less than 9999 for one of their fields. Please check your core setup to ensure you're aware of any limitations.

Institution Settings Configuration

To configure the Allowed URL Parameters institution setting:

1. From the Admin Platform sidebar, select Configurations > Institution settings, and search for "allowed url parameters."
   
   
2. To the right of the setting, select Edit.
   
   
3. On the page that appears, select Add item and enter your custom key(s) in the blank field under string. In the image below, the example key is ad_campaign. Do not add spaces between words, instead use an underscore _ to separate words within the value name. Separate multiple keys with the ampersand & symbol, for example: ad_campaign&promotion&special.
   
   
4.  Select Save Changes.

Once the above is complete, you can distribute your new URL.

Tracking Applications in the Admin Platform

Any URL parameters that are successfully written to the core will be visible in the application view of the Admin Platform. You can also track applications using the Consumer Account Applications report or Business Account Applications report.

To track via the application view:

1.  From the Admin Platform sidebar, select Account opening > Applications, then select a specific application to view its details.
   
   
2. On the scrollable sidebar that opens, scroll to the Metadata section where you can see the key and value displayed. 

To track via reports:

1. From the Admin Platform, select Reports.
2. Under Reports, next to the Consumer Account Applications report or Business Account Applications report, select Download.
3. Open the *.CSV file that was downloaded to your desktop. In the metadata column, the key and value will be displayed.