Environments

When launching Finch Connect, you can specify the environment you want to use by setting the client_id to the appropriate value. You can find the client_id for each environment in the Finch Dashboard.

​

Sandbox

The Sandbox environment is a safe space to test your integration with Finch without affecting live data. It is ideal for testing new features, exploring the Finch API, and ensuring your integration is working as expected.

The Finch Sandbox (param sandbox=finch) provides mock data and simulated responses for all API calls. You can create and configure connections, simulate API token flows, and configure data for a connection. The Sandbox environment also supports asynchronous jobs and assisted connections. You can learn more about updating the data using our API Reference here.

The Provider Sandboxes (param sandbox=provider) is a sandbox environment that simulates the behavior of a live provider. It is ideal for testing the Finch Connect flow and ensuring your integration works as expected with a live provider. This sandbox environment is available for supported providers only that provide a demo or trial account. With these connections, you can test changes in the demo/trial account without affecting live data.

​

Development

The Development environment is a test environment where you can test your integration with Finch using your own data in a production-like environment. The main use case for this enviroment would be to connect your company’s HRIS to Finch and test the integration with your own data.

Though possible, we strongly discourage making connections in development with live customers for the following reasons:

• The customer/employer will have to go through Finch Connect in Production, even though they already went through it at least once in Development.
• All IDs (aside from source_ids from the GET /employee endpoint response) will rotate when connecting that customer/employer to Production.
• Not all providers are supported in development due to required resources from our teams to set up the connection and sync data on a regular basis.
• There could be some complication with accountant accounts depending on which provider(s) are connected, including possible charges from the provider for extra seats (if the provider is one that limits the number of seats).

There may be some specific use cases where connecting in Development with select live customers is necessary, but you should always discuss with your Finch representative before doing so.

After you have launched your production application, we recommend treating the development environment/connection as a staging environment for testing new features and changes before moving them to Production. You can do this by keeping the development connection active and connected to your own staging or development environment.

​

Production

The Production environment is where all live customers should be connected. This is where Finch Connect will be used to connect the customer to Finch and where all data will be synced and processed.

• Often, developers will make their first Production connections with friendly customers to complete final testing in production with real data.
• If you have demo or trial accounts with providers, you should connect those in the Provider Sandbox environment, not Production.
• The connections in Production are billable, so you should promptly disconnect any “test” connections, duplicate connections, or other connections you are no longer using to avoid being charged for them.
• When you are ready to move from Sandbox or Development to Production, you will need to update the client_id in your integration to the Production client_id found in the Finch Dashboard.