GET
/
introspect
curl --request GET \
  --url https://api.tryfinch.com/introspect \
  --header 'Authorization: Bearer <token>' \
  --header 'Finch-API-Version: <finch-api-version>'
{
  "client_id": "25ea8bd8-f76b-41f9-96e3-1e6162021c50",
  "client_type": "production",
  "connection_type": "provider",
  "company_id": "87eb4bc3-f76b-35e7-78d2-8f7822021d73",
  "account_id": "ca23fd65-5a0c-4f8b-a0fa-7853fd6f5768",
  "products": [
    "company",
    "directory"
  ],
  "username": "johndoe@tryfinch.com",
  "payroll_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"
      }
    },
    {
      "type": "credential",
      "connection_status": {
        "status": "connected",
        "message": "This employer is working as expected"
      }
    }
  ]
}

Authorizations

Authorization
string
headerrequired

Please use your Access Token

Headers

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

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

Response

200 - application/json
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

The Finch uuid of the company associated with the access_token.

account_id
string

The Finch uuid of the account used to connect this company.

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.

payroll_provider_id
string

The payroll provider associated with the access_token.

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