Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.tryfinch.com/llms.txt

Use this file to discover all available pages before exploring further.

When launching Finch Connect, set client_id to the client ID for your target environment. In the Finch Dashboard, select your environment from the dropdown, then copy the client ID from the Credentials tab.

​
Sandbox

The Sandbox environment is for testing your integration without affecting live data. Finch provides two sandbox options: Finch Sandbox (sandbox=finch) uses fully mock data generated and managed by Finch. Key features:
  • Create and configure connections programmatically
  • Test the full authorization flow
  • Supports automated and assisted integrations
  • Access a set of sandbox-only API endpoints to create and update mock data directly via API. Unlike Provider Sandbox, there is no backing provider system — all data is managed through the Finch API.”
Provider Sandboxes (sandbox=provider) connect to a supported provider’s demo or trial account and are recommended for end-to-end testing of your integration. Available for a limited number of providers. Data changes are made by logging into the provider’s demo account directly.

​
Development

The Development environment is a production-like environment for testing with live data. It is available to Pro and Premier plan customers upon request. Contact your implementation engineer or email implementation-team@tryfinch.com to request access. Live customer connections can be made in Development using your Development client_id. Consider the following before doing so:
  • Customers connected in Development must go through Finch Connect again, configured with your Production client_id, to connect in Production.
  • Finch UUIDs are not shared across environments. A new Production connection will have entirely new IDs..
  • Gusto and all assisted providers are not supported in Development.
  • Some providers may charge for additional seats created during testing.

​
Production

Production is where all live customer connections should be made. A few things to keep in mind:
  • Many developers make their first Production connections with friendly customers to complete final validation with real data.
  • Demo or trial provider accounts may successfully connect in Production. All Production connections are billable regardless of account type.
  • Production connections are billable. Use the disconnect endpoint to disconnect any test, duplicate, or unused connections promptly.
  • To launch in Production, ensure both client_id and client_secret in your Finch Connect configuration and token exchange are set to your Production values from the Finch Dashboard. Connections cannot move between environments — each environment requires its own credentials and a new authorization flow..