GET
/
introspect

Authorizations

Authorization
string
headerrequired

Please use your Access 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.

Response

200 - application/json
connection_id
string

The Finch UUID of the connection associated with the access_token.

connection_status
object
client_id
string

The client ID of the application associated with the access_token.

client_type
enum<string>

The type of application associated with a token.

Available options:
production,
development,
sandbox
connection_type
enum<string>

The type of the connection associated with the token.

  • provider - connection to an external provider
  • finch - finch-generated data.
Available options:
provider,
finch
company_id
string
deprecated

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

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[]
products
string[]

An array of the authorized products associated with the access_token.

username
string

The account username used for login associated with the access_token.

provider_id
string

The ID of the provider 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)