Triva isn't available right now.
Check out the support page for our phone number and hours
2026-06-17 Retiring Version 5.0 of SurePrep APIs
Starting August 31, 2026
, SurePrep will no longer support version 5 of SurePrep APIs. If your firm uses any V5.0 integrations, you must migrate to version 7 before this date to avoid service disruption.Version 7 of SurePrep’s API encompasses all endpoints available in version 5.0, while also including additional endpoints exclusive to version 7. Retiring version 5.0 allows us to focus support and development of version 7, ensuring a better and more streamlined experience for all users.
How am I impacted?
SurePrep API are used to automate certain tasks for SurePrep and TaxCaddy without the need for the user to do that task manually (for example, create a binder, or get binder status). You will be impacted if your firm is currently using an older version of API that is scheduled to deprecate. After August 31, 2026, all v5.0 API calls will return errors and fail, halting any automations or integrations you have set up with these endpoints.
You will not be impacted if your firm has already migrated all integrations to version 7.
If you are unsure which version your firm is using, contact your API development engineering team, check the URL of your API calls. Version 5.0 endpoints contain “/V5.0/” in the URL, while version 7 endpoints contain “/V7/”.
For example:
Version 5.0 | Version 7 |
|---|---|
https://api.sureprep.com/ V5.0 | https://api.sureprep.com/ V7 |
https://api.sureprep.com/ V5.0 | https://api.sureprep.com/ V7 |
https://api.sureprep.com/ V5.0 | https://api.sureprep.com/ V7 |
What do I need to do?
To ensure a smooth transition before the August 31, 2026 deadline, your engineering team should follow these steps:
Action item | Description |
|---|---|
Update header URL | Identify all API calls that reference “/V5.0/” in the endpoint URL, and replace “/V5.0/” with “/V7/” across all API calls in your integration. |
Generate your Client ID and Client Secret | In FileRoom, navigate to Admin , API , App Management and select New Application . Your ClientID will be generated automatically; you will also need to create your ClientSecret from this page. See the Related Content section for a link to the Get Started with the SurePrep API article. |
Update your GetToken call | The Username , Password , and APIKey input parameters are deprecated in version 7, replace them with a new ClientID and ClientSecret . |
Update the Authorization header | Replace your existing authentication header with a Bearer Authorization parameter (for example: “Authorization: Bearer ABCD-EFG”). |
Test thoroughly before the deadline | Give yourself ample time to validate your updated integrations before August 31, 2026. |
Differentiating between version 5.0 and version 7 in documentation
In the SurePrep API reference documentation, version 5.0 and version 7 endpoints are listed under their corresponding sections of each API Reference page. We recommend cross-referencing the documentation before the retirement date, as the version 5.0 section will be removed after August 31, 2026.
Frequently asked questions
Frequently asked questions
- Will version 5.0 endpoints still work before the deadline?Yes. Version 5.0 endpoints will continue to function normally until August 31, 2026. However, we strongly encourage firms to begin their migration as early as possible to allow time for any necessary troubleshooting.
- Are there new endpoints in version 7 that were not available in version 5.0?Yes. Version 7 includes additional endpoints that are exclusive to v7 and were not available in version 5.0. All endpoints from version 5.0 are present in version 7, so migration will not remove any existing functionality. To explore the new endpoints available in v7, refer to the version 7 section of the SurePrep API reference documentation.
- Are there breaking changes beyond authentication?The primary breaking changes when migrating from V5.0 to V7 are the updated authentication parameters (ClientIDandClientSecretreplacingUsername,Password, andAPIKey), the updated Bearer tokenAuthorizationheader, and the URL change (/V5.0/ to /V7/). All endpoints available in V5.0 are also available in v7.
- Does this retirement affect TaxCaddy APIs as well?Yes. The version 7 release covers both SurePrep and TaxCaddy APIs. Firms using version 5.0 of TaxCaddy API endpoints are equally affected by the August 31, 2026 retirement and must migrate those integrations to version 7 as well. The same authentication and URL changes in this article apply.
- Are there any cost or licensing changes associated with moving to version 7?Migrating to version 7 does not change your existing licensing or pricing agreement with SurePrep.
- Where can I find version 7 documentation?Full version 7 documentation is available in the SurePrep API reference.
Related Content
-
Announcements
Format:
Article
-
Get started with the SurePrep API
Format:
Article
-
API version 7 changelog
Format:
Article
-
SurePrep API - Binder use cases
Format:
Article
-
SurePrep API - TaxCaddy use cases
Format:
Article