Sign in
Management

Introspect

Read account information associated with an access_token

get/introspect

Headers

Finch-API-Versionstring date required

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

Response

OK

idstring required

The Finch UUID of the token being introspected.

connection_idstring required

The Finch UUID of the connection associated with the access_token.

client_idstring required

The client ID of the application associated with the access_token.

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

The type of application associated with a token.

connection_type'provider' | 'finch' required

The type of the connection associated with the token.

  • provider - connection to an external provider
  • finch - finch-generated data.
company_idstring required

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

account_idstring required

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

customer_idstring nullable required

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

customer_namestring nullable required

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

customer_emailstring nullable required

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

productsstring[] required

An array of the authorized products associated with the access_token.

usernamestring required

The account username used for login associated with the access_token.

provider_idstring required

The ID of the provider associated with the access_token.

payroll_provider_idstring required

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

manualboolean required

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

Changes