v50

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

Create a new sandbox account

Create a new account for an existing connection (company/provider pair)

post/sandbox/connections/accounts

Request body

company_idstring uuid required
provider_idstring required

The provider associated with the access_token

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

Optional, defaults to Organization products (company, directory, employment, individual)

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 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