GuidesAPI ReferenceChangelog
Log In
Hey! These docs are for version 2021-04-29, which is no longer officially supported. Click here for the latest version, 2023-11-22!

New API Version 2022-09-09

We have launched a new API version: 2022-09-09!


Tax Forms

Tax forms are now out of Beta and launched to General Availability!


Direct Deposit Switch Updates

We have made important updates to our direct deposit switch user flow. The types of switches enabled by the new flow are as follows:


Tax forms (Beta) support

We created a new tax_forms job, which retrieves W-2 and 1099 documents from an end user's payroll account and makes them available via an API. The new API endpoints are Get tax form and List tax forms for a payroll account corresponding with the new tax_forms.added webhook event. To learn more, check out the Tax Forms guide.


New API Version 2022-06-22

We have launched a new API version: 2022-06-22


User Model

You can now incorporate your existing user model into Pinwheel to simplify your integration and improve coverage.


Percentage-based Direct Deposit Switching

Added the following fields to the Employer and Platform resources:


Added monitoring_status query to GET /accounts

Changed REST API endpoint
GET /v1/accounts
* Added a new optional query parameter monitoring_status which allows an additional way to filter data, now based on the accounts monitoring_status value

Sandbox for On Demand Updates

Sandbox re-authentication testing scenarios are now available for On Demand Updates. To learn more check out the On Demand Updates Sandbox guide