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

const finch = new Finch();

async function main() {
  const connectionCreateResponse = await finch.sandbox.connections.create({ provider_id: 'string' });

  console.log(connectionCreateResponse.account_id);
}

main();
{
  "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
  "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",
  "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  "authentication_type": "api_token",
  "products": [
    "employer:company",
    "employer:directory",
    "employer:individual"
  ],
  "access_token": "7eb55bcf-6593-4040-afac-252ee1f78e20"
}

Authorizations

Authorization
string
headerrequired

Please use base64 encoded client_id:client_secret

Body

application/json
provider_id
string
required
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

Response

200 - application/json
company_id
string
required
provider_id
string
required
account_id
string
required
authentication_type
enum<string>
required
Available options:
credential,
api_token,
oauth,
assisted
products
string[]
required
access_token
string
required