Finch IDs (UUIDs) remain constant for all company connections that utilize the same authentication method. However, if you have multiple access tokens for a company connection, and they were generated via different authentication methods, the Finch IDs may not be consistent across these tokens. For instance, if an employer first authenticates with credentials (username/password), and then later authenticates again using an API token auth method, the two access tokens generated from these authentications may have different Finch IDs. This is because the underyling employment system IDs used to identify an employee or payment may be different depending on the authentication method, and Finch maps its UUIDs to those underlying employment system IDs. You should keep this in mind when incorporating Finch integrations into your application.
API responses can return null
values for some fields. This can happen for a few different reasons—
Ensure your Finch integration is resilient to null
values.
In some cases, requests to the Finch API may return a 202 accepted
. This is the response Finch returns when the connection is created, but data is not yet available. After data is available, this response will no longer be sent. This is often the case for async operations.
Requests that may return a 202 response include:
All applications should be built to account for these 202 responses. The key behaviors your application should exhibit are:
Examples of 202 Responses:
Finch IDs (UUIDs) remain constant for all company connections that utilize the same authentication method. However, if you have multiple access tokens for a company connection, and they were generated via different authentication methods, the Finch IDs may not be consistent across these tokens. For instance, if an employer first authenticates with credentials (username/password), and then later authenticates again using an API token auth method, the two access tokens generated from these authentications may have different Finch IDs. This is because the underyling employment system IDs used to identify an employee or payment may be different depending on the authentication method, and Finch maps its UUIDs to those underlying employment system IDs. You should keep this in mind when incorporating Finch integrations into your application.
API responses can return null
values for some fields. This can happen for a few different reasons—
Ensure your Finch integration is resilient to null
values.
In some cases, requests to the Finch API may return a 202 accepted
. This is the response Finch returns when the connection is created, but data is not yet available. After data is available, this response will no longer be sent. This is often the case for async operations.
Requests that may return a 202 response include:
All applications should be built to account for these 202 responses. The key behaviors your application should exhibit are:
Examples of 202 Responses: