API version 7 changelog
We are excited to announce the release of version 7 (V7) of our SurePrep and TaxCaddy APIs. With V7, users can take their implementation of SurePrep’s APIs into the future. Those upgrading from V5 to V7 will need to make minor adjustments to their integrations to ensure proper functionality with the new version. In this changelog, we delineate the necessary changes and showcase the updates that version 7 users can expect.
Breaking changes
When updating to V7, breaking changes are those that are necessary to implement V7. Failure to do so will result in a failed API call.
Changes to Authentication:
- ChangedGetToken- The authentication input parameter will now requireClientIDandClientSecret. To generateClientIDandClientSecret, go toFileRoom,Admin,API, then selectNew Application.
- DeprecatedUsername,Password, andAPIKeyinput parameters.
- ChangedTheHeaderauthentication parameter was updated to a bearerAuthorizationparameter. (for example, "Bearer ABCD-EFG").
- Header URL changed to v7
Changes to all API calls:
Changed
The Header
URL endpoint for all API calls updated from V5.0
to V7
. For example:v5 | v7 |
|---|---|
https://api.sureprep.com/ V5.0 /Authenticate/GetToken | https://api.sureprep.com/ V7 /Authenticate/GetToken |
https://api.sureprep.com/ V5.0 /Binder/CreateBinder | https://api.sureprep.com/ V7 /Binder/CreateBinder |
https://api.sureprep.com/ V5.0 /Lookup/OfficeLocations | https://api.sureprep.com/ V7 /Lookup/OfficeLocations |
Related Content
-
2026-06-17 Retiring Version 5.0 of SurePrep APIs
Format:
Article
