Skip to main content
GET
JavaScript

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.

Pattern: ([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))

Query Parameters

entity_ids
string<uuid>[]

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

Required array length: 1 element
Example:

Response

Basic company data

id
string<uuid>
required

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

The legal name of the company.

entity
object | null
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.