Skip to main content
GET
/
employer
/
company
JavaScript
import Finch from '@tryfinch/finch-api';

const client = new Finch({
  accessToken: 'My Access Token',
});

const company = await client.hris.company.retrieve();

console.log(company.id);
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "legal_name": "<string>",
  "entity": {
    "type": "llc",
    "subtype": "s_corporation"
  },
  "primary_email": "[email protected]",
  "primary_phone_number": "<string>",
  "departments": [
    {
      "name": "<string>",
      "parent": {
        "name": "<string>"
      }
    }
  ],
  "ein": "<string>",
  "locations": [
    {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>",
      "name": "<string>",
      "source_id": "<string>"
    }
  ],
  "accounts": [
    {
      "routing_number": "<string>",
      "account_name": "<string>",
      "institution_name": "<string>",
      "account_type": "checking",
      "account_number": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Please use your Access Token

Headers

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

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

Query Parameters

​
entity_ids
string<uuid>[]

The entity IDs to specify which entities' data to access.

Required array length: 1 element
Example:
["550e8400-e29b-41d4-a716-446655440000"]

Response

Basic company data

​
id
string<uuid>
required

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

​
legal_name
string | null
required

The legal name of the company.

​
entity
object
required

The entity type object.

​
primary_email
string<email> | null
required

The email of the main administrator on the account.

​
primary_phone_number
string | null
required

The phone number of the main administrator on the account. Format: E.164, with extension where applicable, e.g. +NNNNNNNNNNN xExtension

​
departments
(object | null)[] | null
required

The array of company departments.

​
ein
string | null
required

The employer identification number.

​
locations
(Location · object | null)[] | null
required
​
accounts
object[] | null
required

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