POST
/
auth
/
token

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

The access token for the connection.

connection_id
string
required

The Finch UUID of the connection associated with the access_token.

account_id
string
requireddeprecated

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

client_type
enum<string>
required

The type of application associated with a token.

Available options:
production,
development,
sandbox
company_id
string
requireddeprecated

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

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 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.

Was this page helpful?

Create a new Connect session for reauthenticationProviders