Add a Correlation ID to Connect

Overview

Correlation IDs are unique strings provided by customers used to identify data returned by connected credentials as being related to a specific user within the customer's system.

When your users connect their utility accounts, their request can be viewed alongside all other requests in the Dashboard. Without a Correlation ID, there is no identifier that ties each request back to the customer in your system.

A Correlation ID is an optional parameter that can be appended to your Connect URL. 

There are two possible formats for Correlation IDs:

1. Plaintext: https://arc-connect.arcadia.com/*_?correlationId=_testing123*
2. Hashed: https://arc-connect.arcadia.com/*

Plaintext

Step 1: Submit a test request

To add a Correlation ID, follow these 4 steps:

1. Copy your Live Connect URL from Dashboard > Config > Connect
2. Paste into the address bar and add the Correlation ID (.....?correlationId=)
3. Submit a request via Connect 
4. You can search the Dashboard > Credentials table for the Correlation ID you are interested in. The Credential Detail will link you to the associated accounts and statements.

Step 2: Automating Correlation Id from your system

The Correlation ID can be a variable sourced directly from your system. The best way to source a Correlation ID value depends on how your customers will access Connect.

The example below describes the steps to add a Correlation ID to an email. Similar steps are followed to add a Correlation ID within a webpage.

1. Open the button where the Connect URL will be added.
2. Add a dynamic variable to the end of the URL. For example: https://arc-connect.arcadia.com/organizationId?correlationId=user123

Hashed

Set the Correlation ID value

To set the Correlation ID value, follow these steps:

1. Navigate to the Connect configuration page by selecting the gear in the top right corner.
2. In the field "Correlation ID (optional)", input your desired Correlation ID value.
3. Select "Copy Link" and paste it into a web browser. Note the Correlation ID is no longer in plaintext.
4. Submit a request via Connect.
5. You can search the Dashboard > Credentials table for the Correlation ID you are interested in. The Credential Detail will link you to the associated accounts and statements. You will see the Correlation ID in plaintext within the Dashboard.

Can I automate hashed Correlation IDs?

Today, hashed Correlation IDs cannot be autogenerated. They are only available from the Dashboard interface.