Skip to main content
POST
JavaScript

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.

Pattern: ([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))
Content-Type
string
default:application/json
required

Used to indicate the original media type of the resource

Body

application/json
client_id
string<uuid>
required

The client ID for your application

client_secret
string
required

The client secret for your application

code
string
required

The authorization code received from the authorization server

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

entity_ids
string<uuid>[]
required

An array of entity IDs that can be accessed with this access token

customer_id
string | null

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

customer_name
string | null

The name 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

The Finch UUID of the company associated with the access_token.