Finch automated integrations sync data from HR and payroll providers every 24 hours. For our assisted integrations, data is refreshed every 7 days.
Automated | Assisted | |
---|---|---|
Coverage (Read) | 30+ Providers | 175+ Providers |
Coverage (Write) | 5 Providers | 20+ Providers |
Request new providers | No | Yes |
Default data syncs | 24 hours | 7 days |
Write deductions | 24 hours | 2 business days |
On-demand data syncs | Yes | No |
Configuration period | None | 1-2 weeks |
Custom fields | Yes | No |
Authentication Method(s) | OAuth, API token, or Credentials | 3rd-Party Admin Credentials |
Connection Monitoring | Yes | Yes |
Pricing | All plans | Pro & Premier plans only |
Product | Integration Type | Configuration Period |
---|---|---|
Organization | Assisted | 2 weeks |
Payroll | Assisted | 2 weeks |
Deductions | Assisted | 1 week |
developers@tryfinch.com
to enable the Assisted Connect Flow. Then follow the instructions below.
manual
flagmanual=true
so your user can see all providers that support assisted integrations. After granting your application access, you can retrieve an authorization code
and exchange it for an access_token
as usual.
access_token
and begin making pull and push requests immediately. However, with assisted integrations, there is a delay from when the access_token
is created to when you can use it to make data requests.
Until the access_token
is ready for use, Finch will return an empty response from data endpoints with the HTTP status code 202
indicating the request is valid but data is still pending. When the access_token
is ready, data endpoints will return data with the HTTP status code 200
as usual.
Finch Data Retrieved Header
Since the data is retrieved and refreshed on a periodic cadence, you may want to know the freshness of the data returned by an API call. You can use the Finch-Data-Retrieved
header to get the date and time in ISO-8601 format the data was retrieved.
connection_status
on the /introspect
endpoint.
STATUS | DESCRIPTION |
---|---|
Pending | The employer has created a token, and we are waiting for access to its provider. |
Processing | We have received an invitation from the employer’s provider with the correct permissions and are in the process of pulling their data for the first time. |
No Account Set Up | The employer has created a token, but we have not received an invitation to its system. Please instruct the employer to follow the instructions in Finch Connect to add Finch as a third-party admin. |
Improper Permissions | The employer has added Finch successfully, but with improper permissions. Please instruct the employer to re-add Finch following the instructions in Finch Connect. |
Connected | The connection is set up and Finch is able to access the required data. |
Disconnected | All accounts for this employer have been disconnected. |