Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Please use base64 encoded client_id:client_secret

Body

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

The ID of the new connection

entity_id
string<uuid>
required

The ID of the entity for this connection

company_id
string<uuid>
required

The Finch UUID of the company associated with the access_token.

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