POST
/
auth
/
token
import Finch from '@tryfinch/finch-api';

const finch = new Finch();

async function main() {
  const createAccessTokenResponse = await finch.accessTokens.create({ code: '<your_authorization_code>' });

  console.log(createAccessTokenResponse.access_token);
}

main();
{
  "access_token": "7e965183-9332-423c-9259-3edafb332ad2",
  "account_id": "ac3a2af9-ce03-46c4-9142-81abe789c64d",
  "client_type": "production",
  "company_id": "4ab15e51-11ad-49f4-acae-f343b7794375",
  "connection_type": "provider",
  "products": [
    "directory",
    "employment",
    "individual"
  ],
  "provider_id": "gusto"
}

Headers

Finch-API-Version
string
default: 2020-09-17required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Content-Type
string
default: application/jsonrequired

Used to indicate the original media type of the resource

Body

application/json
client_id
string
required
client_secret
string
required
code
string
required
redirect_uri
string

Response

200 - application/json
access_token
string
required
account_id
string
required

The Finch uuid of the account used to connect this company.

client_type
enum<string>
required

The type of application associated with a token.

Available options:
production,
development,
sandbox
company_id
string
required

The Finch uuid of the company associated with the access_token.

connection_type
enum<string>
required

The type of the connection associated with the token.

  • provider - connection to an external provider
  • finch - finch-generated data.
Available options:
provider,
finch
products
string[]
required

An array of the authorized products associated with the access_token.

provider_id
string
required

The payroll provider associated with the access_token.