Switching to the new Link

Enabling Link

Codat's new Link product can be enabled by activating the toggle under Authorisation Flow > Authorisation Flow Settings > Link.

Please see below for detailed information about changes that my require additional steps on your side. Should you have any questions or concerns regarding your implementation and how it may be affected by these changes, please do not hesitate to reach out to our Support Team.

Changes that might require your action

If you've been using the old version authorization flow and introduced settings that you'd like to keep in Link, Codat will automatically copy them over for you. There are, however, some functionalities which may require additional steps on your side:

Portal

Function

Change

Action required?

Redirection > Redirect parameter

Before: Redirect parameter had to be set separately and the Authorisation Complete Redirection URL was auto-filled.
Now:

  • The Redirect parameter box has been removed.

  • Redirect parameter is now set directly in the Authorisation Complete Redirection URL box.

No, the redirect parameter will be copied to Link.

Authorisation Complete Redirection Url

Before: Redirect parameter had to be set separately and the Authorisation Complete Redirection URL was auto-filled.
Now: Redirect parameter is now set directly in the Authorisation Complete Redirection URL box.

If this field is left empty:

  • It will not be possible to complete the linking flow and be redirected to the website of your choice. This means that instead of the "Continue" button, your customers will see the standard "You may close this window" message.

  • It will not be possible to leave and cancel the linking flow (no "Exit" button on the Introduction page).

No, the redirect parameter will be copied to Link.

Redirects for errors

Before: For errors, users were sent to the Link error page when no {statusText} or {statusCode} redirect query parameters were set.
Now: For errors, users will be sent to the redirect website address even if no {statusText} or {statusCode} redirect query parameters were set.

No, the redirect parameter will be copied to Link.

Holding page

Before: With a redirect parameter set, the holding page with the "Continue" button was displayed.
Now: With a redirect parameter set, no holding page with the "Continue" button is displayed. You'll be taken immediately to the redirect website address.

No, the redirect parameter will be copied to Link.

Branding and brand colours

Before: Primary and secondary colours could be set
Now: Only primary colours can be set

No, all branding set up in the original authorisation flow will be carried over to Link, but for the time being only primary colours are available in the user interface.

Data security

Before: The default Data security URL was Codat's security page: https://www.codat.io/security/
Now: The default Data security URL is Codat's privacy policy page: https://www.codat.io/privacy-policy/

No, but you can provide a link to your data security policy on the Authorisation Flow tab.

Link URLs

The way Link URLs are displayed in the Codat Portal has changed (see the details below).

No, the changes refer to the way Link URLs are displayed in the Codat Portal. The 'Invite Company' and 'Add new company' links will redirect to links.codat.io.

'Invite company' link

The URL in the 'Invite company' window has changed.

Before: https://link.codat.io/intro/{clientId:guid}
After: https://link.codat.io/client/:clientId?user={userId}

No, the changes refer to the way Link URLs are displayed in the Codat Portal.

'Add new company' link

The URL in the 'Add Company' window has changed.
For a company without any data connections:

Before: https://link.codat.io/{companyId:guid}/link
After: https://link.codat.io/company/:companyId

No, the changes refer to the way Link URLs are displayed in the Codat Portal. Note that the URL is returned under GET /companies and GET /connections requests and responses.

'View Link URL' link

The URL in the 'Link URL' window has changed.

For a company without any data connections:

Before: https://link.codat.io/{companyId:guid}/link
After: https://link.codat.io/company/:companyId

For a company with a linked or deauthorized data connection:

Before: https://link.codat.io/start/{companyId:guid}/{dataConnectionId:guid}
After: https://link-api.codat.io/companies/:companyId/connections/:connectionId/start

No, the changes refer to the way Link URLs are displayed in the Codat Portal. Note that the two URLs are returned under GET /companies and GET /connections requests and responses.

Offline connector

Link will direct users to the flow when an offline package is selected in the same way as it would direct users to a web page for authorisation of an online accounting package.

For more information about the Link flow for two of our accounting platforms, please refer to Sage 50 and QuickBooks Desktop sections.

Xero accounting platform - company confirmation page

Before: An additional company confirmation page could be set up in the linking flow by activating the Show Company Name Confirmation Page toggle in the Codat Portal under the Authorisation Flow tab. Xero users connecting to Codat could first select their organisation on the Xero page and then confirm their choice in the Link flow.
Now: The company confirmation page can be configured under Integrations > Accounting > Xero > Manage.

No, the company confirmation page is available in the Link.

OpenID query parameters

Before: Authorisation process could be configured to use OpenID.
Now: The feature is also available in the Link.

Note, however, that OpenID query parameters are available for accounting integrations ONLY. This means that if you enable any of the commerce or banking integrations in addition to the accounting integrations, OpenID parameters will not be available.

Also, please note that at the moment only Xero, QuickBooks Online and Sandbox are available in Link.

No, the feature is now also available in the Link.

Reserved parameter: dataConnectionId

Before: dataConnectionId could be used as a custom query parameter.
Now: It is referred to as connectionId and can only be used as a reserved parameter.

The feature is still a work in progress and will be soon available.

📘

Switching back to the old authorisation flow

Switching back to the old authorisation flow will revert the settings to their previous configuration.

API

This change in the authorization flow may apply to you if you:

  • have built the authorization flow directly to API and you're not using the Codat custom-branded Link flow, or
  • you are using the Codat custom-branded Link flow and are initiating the flow via API using the redirect field.

Function

Change

Action required?

Authorization flow with one data connection

Before:
With a single data connection, the links in the redirect field and dataConnections.linkUrl were the same and they took you directly to the authorization page of the connected platform.

Now:
With a single data connection, the link in the redirect field takes you to the Codat Link flow page, while the link in the dataConnections.linkUrl field takes you directly to the authorization page of the connected platform.

Yes, build the authorization flow to the dataConnections.linkUrl
field rather than the Redirect field.

Configuring redirect URLs

Additionally, if you have configured a dynamic redirect URL as part of your Link flow, you will need to also configure a list of allowed redirect URLs as part of switching over to the new Link. Follow our guide on configuring allowed redirect URLs to configure your list of allowable redirect URLs.


Did this page help you?