Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Please use your Access Token

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]))

Response

200 - application/json

OK

id
string
required

The Finch UUID of the token being introspected

connection_id
string
required

The Finch UUID of the connection associated with the access_token

connection_status
object
required
client_id
string
required

The client ID of the application 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.

company_id
string

The Finch UUID of the company associated with the access_token.

account_id
string
deprecated

[DEPRECATED] Use connection_id to associate tokens with a Finch connection instead of this account ID

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

customer_email
string | null

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

authentication_methods
object[]
username
string | null

The account username used for login associated with the access_token.

payroll_provider_id
string
deprecated

[DEPRECATED] Use provider_id to identify the provider instead of this payroll provider ID.

manual
boolean

Whether the connection associated with the access_token uses the Assisted Connect Flow. (true if using Assisted Connect, false if connection is automated)

entities
object[]

Array of detailed entity information for each connected account in multi-account mode