About the Taxport REST API

Learn how to authenticate, access available endpoints, and implement typical integration patterns for searching forms, retrieving form and recipient data, and generating PDF eStatements in Taxport.

The Taxport eStatements REST API provides programmatic access to tax form and recipient data within the Taxport system. You can search, retrieve, and generate tax documents directly from your backend systems, streamlining your tax reporting workflows.

Available endpoints

Authentication

Authenticate requests to the Taxport REST API endpoints.

Download OpenAPI specification

Recipient search

Search for resident and non-resident recipients in the Taxport system using TIN, account number, recipient ID, or other identifiers. Access comprehensive recipient information including custom fields and indicators.

Recipients: Download OpenAPI specification
Non-resident recipients: Download OpenAPI specification

Forms

Search for resident and non-resident tax forms using various criteria including TIN, account number, and form ID. Retrieve detailed form information and summary payer and recipient information with pagination support. If you know the alias and form ID, you can retrieve its metadata: form type, tax year, transmittal correction type, transmit status, and print status.

Tax forms: Download OpenAPI specification
Non-resident tax forms: Download OpenAPI specification
Tax form metadata: Download OpenAPI specification

eStatements

Generate PDF eStatements for individual or aggregated tax forms. These APIs produce official tax documents that can be distributed electronically to recipients or integrated into your document management systems.

eStatement form: Download OpenAPI specification
Aggregate eStatement forms: Download OpenAPI specification

Combined eStatements

Generates a combined PDF e-statement document that aggregates multiple tax forms for a single recipient into one consolidated statement.

Download OpenAPI specification

Enabling the Taxport REST API

You need an active subscription for eStatements to use the eStatements endpoints and generate PDFs. Contact your Sovos representative or support team to get your API credentials and complete the activation process.

You will also need to configure at least one print resource in Taxport to use when an eStatement is generated.

Accessing the Taxport REST API

The Taxport REST API is accessible through secure endpoints with OAuth2 authentication. You will need:

An active Taxport subscription
API client credentials (client ID and client secret)
A print resource configured for the eStatement endpoint
An alias configuration to define which tax years and forms are available for eStatements

Authenticating API requests

All API requests use OAuth2 client credentials flow for authentication:

Get access token: Send your client credentials to the authentication endpoint to receive a bearer token.
Include bearer token: Pass the access token in the Authorization header of all API requests.

Note:

Access tokens have a limited lifespan. Your application should handle token refresh as needed.

API workflow

Typical integration pattern

Authenticate: Get an access token using your client credentials.
Search: Use the form search or recipient search APIs to locate records.
Retrieve details: Access detailed information about forms or recipients.
Generate documents: Use the eStatement form endpoint to create a PDF for a single tax form, the aggregate eStatement forms endpoint to create a rolled-up PDF for multiple forms grouped by a grouping key, or the combined eStatements endpoint to create a consolidated PDF for a single recipient.

Search requirements

Both search APIs require

An Alias field (Unique databases for each environment and tax year)
At least one identifier: TIN, account number, record ID, or externally provided unique ID

Response formats

All APIs return JSON responses with consistent error handling.

200: Successful operation with data
400: Bad request
401: Unauthorized
403: Forbidden
404: Not found
500: Internal server error

Getting started

To begin using the Taxport REST API:

Contact your Sovos representative to get API credentials.
Review the OpenAPI specifications for detailed endpoint documentation.
Work with professional services if applicable to configure resources in Taxport.
Implement proper error handling and token management in your application.

Testing the REST API

We recommend using tools like Postman or similar API testing platforms to familiarize yourself with the endpoints before implementing your integration.

For additional support or questions about the Taxport REST API, contact support.

1099 Reporting