Skip to main content
POST
/
sandbox
/
connections
JavaScript
import Finch from '@tryfinch/finch-api';

const client = new Finch({
  clientID: '4ab15e51-11ad-49f4-acae-f343b7794375',
  clientSecret: 'My Client Secret',
});

const connection = await client.sandbox.connections.create({ provider_id: 'provider_id' });

console.log(connection.account_id);
{
  "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "authentication_type": "credential",
  "products": [
    "<string>"
  ],
  "access_token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "token_type": "<string>"
}

Authorizations

​
Authorization
string
header
required

Please use base64 encoded client_id:client_secret

Body

application/json
​
provider_id
string
required

The provider associated with the connection

​
authentication_type
enum<string>
Available options:
credential,
api_token,
oauth,
assisted
​
products
string[]
​
employee_size
integer

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

200 - application/json

OK

​
connection_id
string<uuid>
required

The ID of the new connection

​
company_id
string<uuid>
required
deprecated

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

​
provider_id
string<uuid>
required

The ID of the provider associated with the access_token.

​
account_id
string<uuid>
required
deprecated

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

​
authentication_type
enum<string>
required
Available options:
credential,
api_token,
oauth,
assisted
​
products
string[]
required
​
access_token
string<uuid>
required
​
token_type
string