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.account_id);
}

main();
{
  "connection_id": "8289c95e-9162-4221-a850-b8ee135d3d20",
  "connection_status": {
    "status": "connected",
    "message": "This employer is working as expected"
  },
  "client_id": "25ea8bd8-f76b-41f9-96e3-1e6162021c50",
  "client_type": "production",
  "customer_id": 123456789,
  "customer_name": "Acme Inc",
  "customer_email": "example@acme.com",
  "connection_type": "provider",
  "company_id": "87eb4bc3-f76b-35e7-78d2-8f7822021d73",
  "account_id": "ca23fd65-5a0c-4f8b-a0fa-7853fd6f5768",
  "products": [
    "company",
    "directory",
    "individual",
    "benefits"
  ],
  "username": "johndoe@tryfinch.com",
  "provider_id": "gusto",
  "manual": false,
  "authentication_methods": [
    {
      "type": "assisted",
      "connection_status": {
        "status": "pending",
        "message": "This employer has created a token, and we are waiting for access to its provider"
      },
      "products": [
        "benefits"
      ]
    },
    {
      "type": "credential",
      "connection_status": {
        "status": "connected",
        "message": "This employer is working as expected"
      },
      "products": [
        "company",
        "directory",
        "individual"
      ]
    }
  ]
}

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
​
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)

Was this page helpful?

ProvidersDisconnect