POST
/
sandbox
/
connections
/
accounts
import Finch from '@tryfinch/finch-api';

const client = new Finch({
  accessToken: 'My Access Token',
});

async function main() {
  const account = await client.sandbox.connections.accounts.create({
    company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    provider_id: 'provider_id',
  });

  console.log(account.account_id);
}

main();
{
  "connection_id": "a237a1c3-1a5e-44ae-a8fd-81f76fd715c2",
  "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
  "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  "provider_id": "gusto",
  "authentication_type": "credential",
  "products": [
    "company"
  ],
  "access_token": "7eb55bcf-6593-4040-afac-252ee1f78e20"
}

Authorizations

Authorization
string
header
required

Please use base64 encoded client_id:client_secret

Body

application/json
company_id
string
required
provider_id
string
required

The provider associated with the access_token

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

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

Response

200 - application/json
OK
connection_id
string
required

The ID of the new connection

company_id
string
requireddeprecated

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

provider_id
string
required

The ID of the provider associated with the access_token

account_id
string
requireddeprecated

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