Management
Introspect
Deductions
Documents
Management
Sandbox
- POSTCreate a new Sandbox Connection
- POSTCreate a new sandbox account
- PUTUpdate a sandbox account
- GETGet configurations for sandbox jobs
- PUTUpdate configurations for sandbox jobs
- POSTAdd a new sandbox payment
- PUTUpdate sandbox individual
- PUTUpdate sandbox employment
- POSTAdd new individuals to a sandbox company
- PUTUpdate a sandbox company's data
- POSTEnqueue a new sandbox job
Development Guides
Management
Introspect
Read account information associated with an access_token
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.id);
}
main();
{
"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
}
Authorizations
Please use your Access Token
Headers
Header used to specify the version for a given API request. Current version is 2020-09-17.
Response
200 - application/json
OK
The response is of type object
.
Was this page helpful?
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.id);
}
main();
{
"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
}