GET
/
introspect
import Finch from '@tryfinch/finch-api';

const client = new Finch({
  accessToken: 'My Access Token',
});

async function main() {
  const introspection = await client.account.introspect();

  console.log(introspection.id);
}

main();
{
  "id": "<string>",
  "connection_id": "<string>",
  "connection_status": {
    "status": "pending",
    "message": "<string>",
    "last_successful_sync": "2023-11-07T05:31:56Z"
  },
  "client_id": "<string>",
  "client_type": "production",
  "connection_type": "provider",
  "company_id": "<string>",
  "account_id": "<string>",
  "customer_id": "<string>",
  "customer_name": "<string>",
  "customer_email": "<string>",
  "authentication_methods": [
    {
      "type": "assisted",
      "connection_status": {
        "status": "pending",
        "message": "<string>"
      },
      "products": [
        "<string>"
      ]
    }
  ],
  "products": [
    "<string>"
  ],
  "username": "<string>",
  "provider_id": "<string>",
  "payroll_provider_id": "<string>",
  "manual": true
}

Authorizations

​
Authorization
string
header
required

Please use your Access Token

Headers

​
Finch-API-Version
string
default:2020-09-17
required

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

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:
production,
development,
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:
provider,
finch
​
company_id
string
required
deprecated

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

​
account_id
string
required
deprecated

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

​
customer_id
string | null
required

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

​
customer_name
string | null
required

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

​
customer_email
string | null
required

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

​
authentication_methods
object[]
required
​
products
string[]
required

An array of the authorized products associated with the access_token.

​
username
string
required

The account username used for login associated with the access_token.

​
provider_id
string
required

The ID of the provider associated with the access_token.

​
payroll_provider_id
string
required
deprecated

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

​
manual
boolean
required

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

Was this page helpful?