GET
/
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": "1234567890",
  "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

​
Authorization
string
header
required

Please use your Access Token

Headers

​
Finch-API-Version
string
default:2020-09-17
required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Response

200 - application/json
Basic company data
​
id
string

A stable Finch id (UUID v4) for the company.

​
legal_name
string | null

The legal name of the company.

​
entity
object | null

The entity type object.

​
primary_email
string | null

The email of the main administrator on the account.

​
primary_phone_number
string | null

The phone number of the main administrator on the account. Format: XXXXXXXXXX

​
departments
array | null

The array of company departments.

​
ein
string | null

The employer identification number.

​
locations
array | null
​
accounts
object[] | null

An array of bank account objects associated with the payroll/HRIS system.

Was this page helpful?

Directory