---
title: "Introspect"
method: GET
path: "/introspect"
tags: ["Management"]
---

# Introspect

`GET /introspect`

Read account information associated with an `access_token`

## Headers

- `Finch-API-Version` string, date, required

## Response `200`

OK

- GetIntrospectResponse
  - `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
    - `status` 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'
    - `message` string
    - `last_successful_sync` string, date-time — The datetime when the connection was last successfully synced.
  - `client_id` string, 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_id` string, required — [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection instead of this company ID.
  - `account_id` string, required — [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection instead of this account ID.
  - `customer_id` string, nullable, required — The ID of your customer you provided to Finch when a connect session was created for this connection.
  - `customer_name` string, nullable, required — The name of your customer you provided to Finch when a connect session was created for this connection.
  - `customer_email` string, nullable, required — The email of your customer you provided to Finch when a connect session was created for this connection.
  - `authentication_methods` object[], required
    - `type` 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth' — The type of authentication method.
    - `connection_status` object
      - `status` 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'
      - `message` string
    - `products` string[] — An array of the authorized products associated with the `access_token`.
  - `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] 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)

## Changes

- **2025-04-22** `46640c1b4688` — 1 info
  - the endpoint scheme security `bearerAuth` was added to the API
- **2025-04-14** `ff61a38530df` — 1 info
  - added the required property `id` to the response with the `200` status
- **2025-03-31** `3224f142ed15` — 1 info
  - added the optional property `connection_status/last_successful_sync` to the response with the `200` status

[Change history](https://skmtc.dev/finch-api/apis/api-reference/changes/introspect/get.md)

---

[API](https://skmtc.dev/finch-api/apis/api-reference.md) · [All operations](https://skmtc.dev/finch-api/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/finch-api/api-reference/revisions/73c284d36c1e/schema)