Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-2148120293.6 KB
Sandbox

Create a new Sandbox Connection

Create a new connection (new company/provider pair) with a new account

post/sandbox/connections

Request body

provider_idstring required

The provider associated with the connection

authentication_type'credential' | 'api_token' | 'oauth' | 'assisted'
productsstring[]
employee_sizeinteger

Optional: the size of the employer to be created with this connection. Defaults to 20. Note that if this is higher than 100, historical payroll data will not be generated, and instead only one pay period will be created.

Response

OK

connection_idstring uuid required

The ID of the new connection

entity_idstring uuid required

The ID of the entity for this connection

company_idstring uuid required

The Finch UUID of the company associated with the access_token.

provider_idstring uuid required

The ID of the provider associated with the access_token.

account_idstring uuid required

[DEPRECATED] Use connection_id to associate a connection with an access token

authentication_type'credential' | 'api_token' | 'oauth' | 'assisted' required
productsstring[] required
access_tokenstring uuid required
token_typestring