Getting started

An introduction to the basics of the Codat Portal using a practical exercise


Supported browsers

The Codat Portal is only supported using the latest version of Google's Chrome browser. If you have issues using the portal in other browsers, please try again using Chrome.

To get started with Codat, follow these 3 simple steps:

  1. Explore: get familiar with the Portal and review some sample data we provided.
  2. Connect: try connecting a company using Link.
  3. Explore use cases: explore our products and see how they can help you get the most out of your new company's data.


We use the Codat Sandbox to provide mock accounting, commerce, and banking data. Our Sandbox gives you access to all the data types and operations supported by Codat.

Step 1: Explore

  1. Sign in to the Codat Portal. In this exercise, we'll be focusing on reviewing the data of a sample Company, but there's much more to explore in the Portal.

    For more details, go to Using Codat's Portal.

  2. In the navigation bar, click on Companies. A list of connected companies appears. Every company on the list represents one of your SMB customers.

    We already created the first company for you:


A Codat demo company.

A company view includes some useful information about the connected SMB customer, including their data connections and their status. To learn more about data connection statuses, go here.

  1. Click on the sample company to open the detailed company view. From here you can access the data shared by the SMB customer (or, in this case, sourced from our Sandbox).

    Take some time to explore the view and learn more about what's included here.

  2. Click Export data to generate a data report spreadsheet. Reviewing sample data should give you a good understanding of how Codat displays financial information.

You're now one step closer to starting working with live data. But first, learn how to connect with your SMBs.

Step 2: Connect

To connect with an SMB, you can use Link or build your own authorization journey.

In this exercise, we'll be connecting an SMB using Link, our pre-built, conversion-optimized, and customizable authorization flow.

  1. Create a company.

  2. Find the company that you created for the SMB and click Request data next to the company name.

    Copy the Link URL from the modal window displayed and open it in the new tab.

  3. Follow the Link flow and select Codat Sandbox as your source of accounting, commerce, and banking data.


Link view, with Codat Sandbox selected as the banking data source.

Once you have an idea of how Link works, you can try:

Step 3: Explore use cases

You can build a completely custom solution using Codat's flexible API products. For our out-of-the-box solutions, explore other Codat products:

  • Sync for Commerce: a solution that allows you to push merchants' data from your payments, eCommerce, or point-of-sale (POS) platform into each merchant's accounting platform.

    To find out more about Sync for Commerce, you can read our dedicated documentation.

    When enabled, Sync for Commerce will appear under the Products tab in the Portal.

  • Assess: a solution that helps you make smarter credit decisions on small businesses.

    It enables your SMBs to pull the latest data from the operating systems they are already using. You can use that data for automating decisions and surfacing new insights on the SMB.

    To find out more about Assess, you can read our Assess documentation.

    When enabled, Assess will appear as an additional tab in your Companies view. If you already have Assess enabled, read How to get started.

Did this page help you?