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": "<string>",
"connection_id": "<string>",
"connection_status": {
"status": "pending",
"message": "<string>",
"last_successful_sync": "2023-11-07T05:31:56Z"
},
"client_id": "<string>",
"client_type": "production",
"connection_type": "provider",
"company_id": "<string>",
"account_id": "<string>",
"customer_id": "<string>",
"customer_name": "<string>",
"customer_email": "<string>",
"authentication_methods": [
{
"type": "assisted",
"connection_status": {
"status": "pending",
"message": "<string>"
},
"products": [
"<string>"
]
}
],
"products": [
"<string>"
],
"username": "<string>",
"provider_id": "<string>",
"payroll_provider_id": "<string>",
"manual": true
}
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": "<string>",
"connection_id": "<string>",
"connection_status": {
"status": "pending",
"message": "<string>",
"last_successful_sync": "2023-11-07T05:31:56Z"
},
"client_id": "<string>",
"client_type": "production",
"connection_type": "provider",
"company_id": "<string>",
"account_id": "<string>",
"customer_id": "<string>",
"customer_name": "<string>",
"customer_email": "<string>",
"authentication_methods": [
{
"type": "assisted",
"connection_status": {
"status": "pending",
"message": "<string>"
},
"products": [
"<string>"
]
}
],
"products": [
"<string>"
],
"username": "<string>",
"provider_id": "<string>",
"payroll_provider_id": "<string>",
"manual": true
}
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?