Sign in
Management

Create Access Token

Exchange the authorization code for an access token

post/auth/token

Headers

Finch-API-Versionstring date required

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

Content-Typestring required

Used to indicate the original media type of the resource

Request body

client_idstring uuid
client_secretstring
codestring required
redirect_uristring

Example request

{
  "client_id": "6d28c315-5eaa-4071-8ea5-f030eb45edbc",
  "client_secret": "<your_client_secret>",
  "code": "<your_authorization_code>",
  "redirect_uri": "https://example.com"
}

Response

Access Token

access_tokenstring required

The access token for the connection.

token_typestring

The RFC 8693 token type (Finch uses bearer tokens)

connection_idstring required

The Finch UUID of the connection associated with the access_token.

customer_idstring nullable

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

account_idstring required

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

client_type'production' | 'development' | 'sandbox' required

The type of application associated with a token.

company_idstring required

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

connection_type'provider' | 'finch' required

The type of the connection associated with the token.

  • provider - connection to an external provider
  • finch - finch-generated data.
productsstring[] required

An array of the authorized products associated with the access_token.

provider_idstring required

The ID of the provider associated with the access_token.

Changes