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
Organization
Company
Read basic company data
GET
https://api.tryfinch.com
/
employer
/
company
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
async function main() {
const company = await client.hris.company.retrieve();
console.log(company.id);
}
main();
{
"id": "514aa2b7-898f-4ce7-bc05-c2fe993713e8",
"legal_name": "Acme, Inc.",
"entity": {
"type": "corporation",
"subtype": "s_corporation"
},
"ein": "12-3456789",
"primary_email": "founders@acme.com",
"primary_phone_number": "+14475678901",
"departments": [
{
"name": "Engineering",
"parent": null
},
{
"name": "Platform",
"parent": {
"name": "Engineering"
}
}
],
"locations": [
{
"line1": "628 Bear Ave",
"line2": "Apt A",
"city": "Schenectady",
"state": "NY",
"postal_code": "94301",
"country": "US"
}
],
"accounts": [
{
"routing_number": "123456789",
"account_name": "CHECKING ACCOUNT",
"institution_name": "BANK OF AMERICA, N.A.",
"account_type": "checking",
"account_number": "98765432"
}
]
}
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
Basic company data
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 company = await client.hris.company.retrieve();
console.log(company.id);
}
main();
{
"id": "514aa2b7-898f-4ce7-bc05-c2fe993713e8",
"legal_name": "Acme, Inc.",
"entity": {
"type": "corporation",
"subtype": "s_corporation"
},
"ein": "12-3456789",
"primary_email": "founders@acme.com",
"primary_phone_number": "+14475678901",
"departments": [
{
"name": "Engineering",
"parent": null
},
{
"name": "Platform",
"parent": {
"name": "Engineering"
}
}
],
"locations": [
{
"line1": "628 Bear Ave",
"line2": "Apt A",
"city": "Schenectady",
"state": "NY",
"postal_code": "94301",
"country": "US"
}
],
"accounts": [
{
"routing_number": "123456789",
"account_name": "CHECKING ACCOUNT",
"institution_name": "BANK OF AMERICA, N.A.",
"account_type": "checking",
"account_number": "98765432"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.