The Connections page is where you can find detailed information on each connected employer.
Create a New Connect Link
To create a new connection, you must first generate an invitation link. You can do this on the Connections homepage under Actions > Create a New Connect Link.
From here, you will be take through the process to create a unique and unchangeable Finch Connect URL for each employer. The fields prompted in this modal mirror the body of the POST/connect/sessions API request, an alternative option to create a new Finch Connect session.
Download a CSV of your Connections
From the Actions dropdown, you can also choose to export your connections as a CSV file. This can help streamline connection management across your internal teams without requiring Dashboard access. You must select the type of connection you want to download a CSV file for (i.e.: Live, Staged, or Disconnected).
Filter by Live, Staged, and Disconnected
The tabs at the top of the connections panel allow you to switch between viewing live, staged, and disconnected connections.
Live connections
The employer has completed the Finch Connect flow. These connections have a connection_id and an access token that will be used to sync data. If there are any errors or if re-auth is needed, it will be flagged as a connection status; connections in a Re-Auth state are still considered live connections.
Staged connections
The session is active, but a connection has not yet been established. The employer has not yet completed the Finch Connect flow. These connections do not have a connection_id or an access token.
Disconnected connections
The connection is no longer active and the access token(s) associated with the connection is no longer usable.
Sort Connections by Name or ID
Company
This column includes two unique identifiers
Company Name: The company name that is pulled from the underlying payroll system. This may or may not align with the name you use to identifier this company (i.e.: legal name vs. DBA)
Company ID: The Finch-generated UUID that is constructed using an ID from the underlying payroll system. If you have questions about a connection or need troubleshooting assistance from our support team, please provide our team with the Connection ID, a unique identifier for the connection.
Connection ID
A unique identifier created when an employer successfully authenticates. Note this different than the Company ID.
Customer
This column includes two unique identifiers:
Customer Name: The customer name your team passes to Finch when creating a Finch Connect session, either through the Finch Dashboard or the Finch API.
Customer ID: The customer ID your team passes to Finch when creating a Finch Connect session.
Please note that these IDs will remain blank for legacy connections that were created prior to the session_id release. Our team will eventually have a solution for you to backfill this information.
Sort Connections by Status, Type, and Timestamp
Connection Status
The current state of the connection. This status could change. For example, if a connection breaks and an employer must reconnect through Finch, the status will update from Connected to Reauth.
Connection Type
There are 3 different connection types you might see depending on a couple of factors:
Automated: Data syncs are automatic (24 hour refresh) and deductions are automatic (if applicable)
Assisted: Data syncs are assisted (7 day refresh) and deductions are assisted (if applicable)
Automated, Assisted: Data syncs are automatic and deductions are assisted
Timestamps
Connected: Timestamp the connection was created
Last Synced: Timestamp of the last completed job
Provider
The HRIS or payroll provider the customer is connected to for the specified connection