---
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` ConnectionStatusDetail, required
    - `status` 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth', required
    - `message` string
    - `last_successful_sync` union — The datetime when the connection was last successfully synced
      - string, date-time
      - string
      - unknown
  - `client_id` string, required — The client ID of the application associated with the `access_token`
  - `client_type` 'development' | 'production' | 'sandbox', required — The type of application associated with a token.
  - `connection_type` 'finch' | 'provider', required — The type of the connection associated with the token. - `provider` - connection to an external provider - `finch` - finch-generated data.
  - `company_id` string — The Finch UUID of the company associated with the `access_token`.
  - `account_id` string — [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection instead of this account ID
  - `customer_id` string, nullable — The ID of your customer you provided to Finch when a connect session was created for this connection
  - `customer_name` string, nullable — The name of your customer you provided to Finch when a connect session was created for this connection
  - `customer_email` string, nullable — The email of your customer you provided to Finch when a connect session was created for this connection
  - `authentication_methods` AuthenticationMethodDetail[]
    - `type` 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth', required — The type of authentication method
    - `connection_status` ConnectionStatusDetail
      - `status` 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth', required
      - `message` string
      - `last_successful_sync` union — The datetime when the connection was last successfully synced
        - string, date-time
        - string
        - unknown
    - `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, nullable — 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 — [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` MultiAccountEntity[] — Array of detailed entity information for each connected account in multi-account mode
    - `id` string, uuid, required — The connection account ID for this entity
    - `name` string, nullable, required — The name of the entity (payroll provider company name)
    - `source_id` string, nullable, required — The source ID of the entity
    - `status` 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth' | 'disconnected', required — The status of the entity connection

---

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