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

const client = new Finch();

const createAccessTokenResponse = await client.accessTokens.create({ code: 'code' });

console.log(createAccessTokenResponse.connection_id);
{
  "access_token": "7e965183-9332-423c-9259-3edafb332ad2",
  "token_type": "bearer",
  "connection_id": "bc3a2af9-ce03-46c4-9142-81abe789c64d",
  "customer_id": "1234567890",
  "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<date>
default:2020-09-17
required

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

​
Content-Type
string
default:application/json
required

Used to indicate the original media type of the resource

Body

application/json
​
code
string
required

The authorization code received from the authorization server

​
client_id
string<uuid>

The client ID for your application

​
client_secret
string

The client secret for your application

​
redirect_uri
string

The redirect URI used in the authorization request (optional)

Response

200 - application/json

Access Token

​
access_token
string
required

The access token for the connection

​
token_type
string
required

The RFC 8693 token type (Finch uses bearer tokens)

​
connection_id
string
required

The Finch UUID of the connection associated with the access_token

​
client_type
enum<string>
required

The type of application associated with a token.

Available options:
development,
production,
sandbox
​
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:
finch,
provider
​
products
string[]
required

An array of the authorized products associated with the access_token

​
provider_id
string
required

The ID of the provider associated with the access_token

​
customer_id
string | null

The ID of your customer you provided to Finch when a connect session was created for this connection

​
account_id
string
deprecated

[DEPRECATED] Use connection_id to identify the connection instead of this account ID

​
company_id
string
deprecated

[DEPRECATED] Use connection_id to identify the connection instead of this company ID

⌘I