Create your Finch Developer Account, recieve your application credentials, and pilot how Finch works in our sandbox environment.
client_id
and client_secret
) and pilot how Finch works in a safe testing environment with mock data.
client_id
and client_secret
. You will use these credentials to authenticate your application to obtain access tokens in order to call the Finch APIs.client_id
, client_secret
, and future access_token
s to prevent unauthorized access. Here are some methods to securely store these credentials:
client_id
and client_secret
as environment variables within your application. When your application needs to use these credentials, it can access them from the environment variables without exposing them in your source code.client_id
, client_secret
, and access_token
.client_id
and client_secret
, and product scopes.Product Scope | Description | API Endpoint | Read/Write |
---|---|---|---|
Company | Company data, such as company legal name, office addresses, or Employer Identification Number (EIN) | /company | Read Only |
Directory | List all active and inactive employee employees at the company | /directory | Read Only |
Individual | Individual employee data, such as names, contact information, or dates of birth | /individual | Read Only |
Employment | Employment data, such as job title, department, start and end dates, or employee income | /employment | Read Only |
Payment | Company payroll data, such as payment data, such as payment dates or total amounts | /payment | Read Only |
Pay-Statement | Detailed pay statement data, such as gross pay, earnings, employee deductions, or employer contributions | /pay-statement | Read Only |
Benefits | Ability to write back employee deductions or employer contributions directly to the employer’s provider. This is our Deductions product. | /benefits | Read/Write |
Documents | Read company documents such as W4 Forms | /documents | Read Only |
https://your-trusted-domain.com/api/finch/callback
To authorize with Finch, you’ll need to provide one or more redirect URIs. The user will be redirected to the specified URI upon successfully authorizing your application access to their employment system. On redirect, the URI will contain an authorization code
query parameter that must be exchanged with Finch’s authorization server for an access token.
Finch’s embedded Frontend SDKs don’t need to set up a redirect URI. The default redirect URI https://tryfinch.com
is already applied.
The redirect URIs must match one of the following formats—
Protocol | Format | Examples |
---|---|---|
HTTP | A localhost URI with protocol http:// | http://localhost:8000 |
HTTPS | A URI with protocol https:// | https://example.com |
client_id
and client_secret
. You should also have a clear understanding of the Finch products that your application requires. You now have everything necessary to Integrate Finch Connect Into Your Application to begin connecting to employment providers.