import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
const introspection = await client.account.introspect();
console.log(introspection.id);
{
"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"
]
}
]
}
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);
{
"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"
]
}
]
}
Please use your Access Token
Header used to specify the version for a given API request. Current version is 2020-09-17.
OK
The response is of type object
.
Was this page helpful?