import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
const introspection = await client.account.introspect();
console.log(introspection.id);from finch import Finch
client = Finch(
access_token="My Access Token",
)
introspection = client.account.introspect()
print(introspection.id)package main
import (
"context"
"fmt"
"github.com/Finch-API/finch-api-go"
"github.com/Finch-API/finch-api-go/option"
)
func main() {
client := finchgo.NewClient(
option.WithAccessToken("My Access Token"),
)
introspection, err := client.Account.Introspect(context.TODO())
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", introspection.ID)
}
package com.tryfinch.api.example;
import com.tryfinch.api.client.FinchClient;
import com.tryfinch.api.client.okhttp.FinchOkHttpClient;
import com.tryfinch.api.models.AccountIntrospectParams;
import com.tryfinch.api.models.Introspection;
public final class Main {
private Main() {}
public static void main(String[] args) {
FinchClient client = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build();
Introspection introspection = client.account().introspect();
}
}package com.tryfinch.api.example
import com.tryfinch.api.client.FinchClient
import com.tryfinch.api.client.okhttp.FinchOkHttpClient
import com.tryfinch.api.models.AccountIntrospectParams
import com.tryfinch.api.models.Introspection
fun main() {
val client: FinchClient = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build()
val introspection: Introspection = client.account().introspect()
}require "finch_api"
finch = FinchAPI::Client.new(access_token: "My Access Token")
introspection = finch.account.introspect
puts(introspection)curl --request GET \
--url https://api.tryfinch.com/introspect \
--header 'Authorization: Bearer <token>' \
--header 'Finch-API-Version: <finch-api-version>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tryfinch.com/introspect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Finch-API-Version: <finch-api-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "b0202497-f8f2-4bb7-adfc-18c4a0c07916",
"connection_id": "8289c95e-9162-4221-a850-b8ee135d3d20",
"connection_status": {
"status": "connected",
"message": "This employer is working as expected",
"last_successful_sync": "2025-03-28T12:00:00.000Z"
},
"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"
]
}
],
"entities": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Acme Corp",
"source_id": "acme-corp-123",
"status": "connected"
},
{
"id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"name": "Acme Subsidiary LLC",
"source_id": "acme-subsidiary-456",
"status": "connected"
}
]
}Introspect
Read account information associated with an access_token
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
const introspection = await client.account.introspect();
console.log(introspection.id);from finch import Finch
client = Finch(
access_token="My Access Token",
)
introspection = client.account.introspect()
print(introspection.id)package main
import (
"context"
"fmt"
"github.com/Finch-API/finch-api-go"
"github.com/Finch-API/finch-api-go/option"
)
func main() {
client := finchgo.NewClient(
option.WithAccessToken("My Access Token"),
)
introspection, err := client.Account.Introspect(context.TODO())
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", introspection.ID)
}
package com.tryfinch.api.example;
import com.tryfinch.api.client.FinchClient;
import com.tryfinch.api.client.okhttp.FinchOkHttpClient;
import com.tryfinch.api.models.AccountIntrospectParams;
import com.tryfinch.api.models.Introspection;
public final class Main {
private Main() {}
public static void main(String[] args) {
FinchClient client = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build();
Introspection introspection = client.account().introspect();
}
}package com.tryfinch.api.example
import com.tryfinch.api.client.FinchClient
import com.tryfinch.api.client.okhttp.FinchOkHttpClient
import com.tryfinch.api.models.AccountIntrospectParams
import com.tryfinch.api.models.Introspection
fun main() {
val client: FinchClient = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build()
val introspection: Introspection = client.account().introspect()
}require "finch_api"
finch = FinchAPI::Client.new(access_token: "My Access Token")
introspection = finch.account.introspect
puts(introspection)curl --request GET \
--url https://api.tryfinch.com/introspect \
--header 'Authorization: Bearer <token>' \
--header 'Finch-API-Version: <finch-api-version>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tryfinch.com/introspect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Finch-API-Version: <finch-api-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "b0202497-f8f2-4bb7-adfc-18c4a0c07916",
"connection_id": "8289c95e-9162-4221-a850-b8ee135d3d20",
"connection_status": {
"status": "connected",
"message": "This employer is working as expected",
"last_successful_sync": "2025-03-28T12:00:00.000Z"
},
"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"
]
}
],
"entities": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Acme Corp",
"source_id": "acme-corp-123",
"status": "connected"
},
{
"id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"name": "Acme Subsidiary LLC",
"source_id": "acme-subsidiary-456",
"status": "connected"
}
]
}Authorizations
Please use your Access Token
Headers
Header used to specify the version for a given API request. Current version is 2020-09-17.
([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))Response
OK
The Finch UUID of the token being introspected
The Finch UUID of the connection associated with the access_token
Show child attributes
Show child attributes
The client ID of the application associated with the access_token
The type of application associated with a token.
development, production, sandbox The type of the connection associated with the token.
provider- connection to an external providerfinch- finch-generated data.
finch, provider An array of the authorized products associated with the access_token.
The ID of the provider associated with the access_token.
The Finch UUID of the company associated with the access_token.
[DEPRECATED] Use connection_id to associate tokens with a Finch connection instead of this account ID
The ID of your customer you provided to Finch when a connect session was created for this connection
The name of your customer you provided to Finch when a connect session was created for this connection
The email of your customer you provided to Finch when a connect session was created for this connection
Show child attributes
Show child attributes
The account username used for login associated with the access_token.
[DEPRECATED] Use provider_id to identify the provider instead of this payroll provider ID.
Whether the connection associated with the access_token uses the Assisted Connect Flow. (true if using Assisted Connect, false if connection is automated)
Array of detailed entity information for each connected account in multi-account mode
Show child attributes
Show child attributes
Was this page helpful?