Customize Connect

Connect handles standard credential submissions requirements without any setup required. Your Connect instance can also be customized in a few ways to fit your company's requirements.

📘
Are you looking for the legacy Connect customization documentation?
Documentation about how to customize the Legacy Connect originally launched with Utility Cloud can be found here. This documentation refers to the version of Connect that was launched with the Dashboard on January 4, 2024.

There are two primary ways to configure Connect. One way is adjusting settings that apply across all end-users from the Dashboard > Configuration > Connect page. The other is by customizing Connect for a particular end-user via URL query parameters.

General Customizations

Branding

Connect provides the ability to set your organization's brand image and the brand name you want all customers to see when Connect first opens. These fields can be configured in Connect from the Dashboard > Config > Connect page. We recommend using a square, 500 x 500 .png or .jpg image format for the best presentation.

Legal documents

Connect provides the ability to set the Terms of Service and Privacy Policy. If either is set, Connect will require that the user checks the box saying they acknowledge these. If you do not have a Terms of Service or Privacy Policy, no consent mechanism will show. These fields can be configured in Connect from the Dashboard > Config > Connect page.

As you make changes to the branding or legal contracts, you can see a preview of what it will look like in Connect. Changes are not deployed until you click the button to publish changes.

User-specific Customizations

You can modify Connect for each user session by modifying the Connect URL.

The Connect URL structure consists of the Base URL (https://platform-connect.arcadia.com) followed by an Organization ID (unique for each customer), and then URL parameters. A question mark is used to indicate the start of the parameters and an ampersand is used to separate any following parameters. The standard syntax of the URL looks like this:

https://platform-connect.arcadia.com/<Organization Id>?parameter1=<Parameter1 Value>&parameter2=<Parameter2 Value>

URL & Workflow configurations

You can modify Connect’s behaviour by including URL query parameters, which let you tailor the workflow, restrict providers, or enable sandbox testing.

Option name	Description	URL query parameter name	Allowed values
Provider ID	By passing in a `providerId`, Connect will skip the provider selection and start the user off on the credentials page. This will also disable the back button and the breadcrumbs.	providerId	Provider UUID
Correlation ID	By passing in a `correlationId`, you can tag a Connect session with a unique identifier from your system. This ensures that any data returned from the connected credentials can be tied back to the correct user or record in your application. Without a correlation ID, requests in the Dashboard cannot be directly linked to your internal users. Learn more	correlationId	Any string
Use Case Limit	By passing in statements or intervals as the `useCaseLimit` value, Connect will restrict the list of potential providers presented to users to only those supporting the use-case specified. This parameter only applies if your organization has subscribed both data products. If your organization has only one of the two products subscribed, the providers presented in Connect are automatically limited.	useCaseLimit	`intervals` or `statements`
API Mode	By passing in an `apiMode` value, you can choose whether Connect runs in the sandbox environment (for testing and automation) or the live environment (for production use with real customer data). If not specified, the default is `live`. Learn more about sandbox mode here.	apiMode	`sandbox` or `live`

Examples

Here are some examples of how to customize Connect for each user session using URL query parameters:

Option name	Example
`providerId`	`https://platform-connect.arcadia.com/<Organization Id>?providerId=your-provider-uuid`
`correlationId`	`https://platform-connect.arcadia.com/<Organization Id>?correlationId=your-unique-id-123`
`useCaseLimit`	`https://platform-connect.arcadia.com/<Organization Id>?useCaseLimit=statements`
`apiMode`	`https://platform-connect.arcadia.com/<Organization Id>?apiMode=sandbox`

Combined example

You can also pass multiple parameters together by separating them with &:

https://platform-connect.arcadia.com/\<OrganizationId>?providerId=prv_provider_uuid&correlationId=your-correlation-id-456&apiMode=sandbox