Guide to API documentation in the Thomson Reuters Developer Portal

We're excited to announce that the existing SurePrep and TaxCaddy API documentation have transitioned to the Thomson Reuters Developer Portal. Within this new portal, you can find an updated formatting structure of the API calls integrated into your existing workflows. Additionally, you can find Version 7 API documentation exclusively available in the Thomson Reuters Developer Portal. 

Update to the documentation formatting

With the transition of content from SurePrep's Developer Portal to the Thomson Reuters Portal, we'll update how users can find their intended API documentation. API calls are sorted according to workflow, making it easier to navigate between the most relevant documentation.
For example, when trying to create a client's DRL via API, you can now find the API calls relevant to DRL creation (
CreateDRL
), submission (
SubmitDRL
), and data retrieval (
GetDRLStatus
,
GetDRLOutput
, and
GetDRLPDFDetails
) in 1 location.

Searching the Thomson Reuters Developer Portal

When using the Thomson Reuters Developer Portal to find API documentation, you can filter the API catalog by
Industry
,
Product
, or
Capabilities
. To find all SurePrep-related APIs, mark the
SurePrep
checkbox from the
Products
menu in the navigation bar.
Now, all of SurePrep's API documentation will be available to read. Once you find a tile you'd like to read documentation for, select
View API
.
The
Overview
and
Guide
pages will appear:
  • Overview
    : The
    Overview
    page lists information specific to the usage of the API you've selected, including all calls part of the overall process. For example, you can review the
    GetToken
    documentation as part of the
    API Authentication
    process).
  • Guide
    : The Guide page has general information about using SurePrep APIs, including supported tax software, request limits, and versioning. We recommend that new users review this information and the Get Started with SurePrep API article before implementing SurePrep APIs into your workflow.
API Reference section
All API documentation has an API Reference page that includes technical information regarding the API you've selected (for example input/output parameters and sample code). Select
API Reference
to open this information in a new tab.
On the
API reference
page of your selected API, you'll see both version 7 and version 5 documentation available for each API call. You can select between the 2 using the navigation bar.
Once selected, the selected process' individual API call will appear. Select the API call you'd like to view and the Thomson Reuters Developer Portal will automatically go to the documentation.
Here, you can review the API call's
Header
,
Body
, and
Response
information along with the method's sample code.
Input parameters found in the
Body
section of each call will have definitions, data types, and cardinality for each parameter. You can expand the
Responses
dropdown menus to view definitions for each output parameter.

Related content

Chat now

error-icon

Triva isn't available right now.

Check out the support page for our phone number and hours

error-close