API

Get started with the SurePrep API

Before interested users can integrate SurePrep and TaxCaddy APIs into their workflows, configure your firm to use our APIs.

Enable your domain

Follow these steps to enable the SurePrep API for your domain:
  1. Go to https://production.sureprep.com and sign in as a
    Firm System Administrator
    user.
  2. Select
    Admin
    from the dropdown menu.
  3. Select
    Account Setup
    , then
    Enable API
    .
  4. Mark the
    Enable API access
    checkbox to enable API access for your firm. Refresh the page to display the API navigation tab.
note
If your firm plans to use TaxCaddy API calls, contact SurePrep Support at support@sureprep.com to enable the TaxCaddy API for your domain.

Account Admin setup

With proper authorization and FileRoom setup, your application can securely communicate with the SurePrep API. Depending on the version your firm is implementing, your Account Admin setup process will include creating the necessary records for API usage.
Version 7 users
When using Version 7 of SurePrep and TaxCaddy APIs, the next step after enabling APIs for your firm is to add a
New Application
for each user. This generates a unique
Client ID
and
Client Secret
for each application.
note
You can view the
App Management
tab within your firm's
Account Admin
starting November 25, 2024.
  1. Once you've enabled the API for your firm, go to the
    App Management
    tab at
    Admin
    API
    .
  2. Select
    New Application
    .
  3. Enter a name for the
    New Application
    .
  4. The
    Access credentials
    window will appear asking you to confirm the creation of your new application. Select
    Continue
    to create your application, otherwise, select
    Cancel
    to return to the
    App Management
    screen.
  5. You have 60 seconds to copy your newly generated
    Client ID
    and
    Client Secret
    . After this time elapses, you will need to return to the
    App Management
    screen.
    note
    You can use the
    Copy
    feature to copy each of these values to your clipboard. If you'd like to review these values, select
    Show/Hide
    to reveal them.
  6. If your 60 seconds elapses before you're able to copy your
    Client Secret
    , you can
    Regenerate
    a new one to save to your records.
  7. Once you have the
    Client ID
    and
    Client Secret
    , you can use the V7
    GetToken (POST)
    API call to get an API Authorization token. SurePrep uses the token to authenticate the user for each API call made.
Version 5 users
When using Version 5 of SurePrep and TaxCaddy APIs, the next step after enabling APIs for your firm is to add API users, create an API token, and prepare firm default settings.
  1. Once you've enabled an API for your firm, a
    Firm System Administrator
    must then create users capable of utilizing the API.
  2. After the new API user credentials have been created, they must now
    Generate
    an API key to authenticate their API requests.
     
  3. Once you have the
    USERNAME
    ,
    PASSWORD
    , and
    API Key
    , you can use the V5
    GetToken (POST)
    API call to get an API
    AuthToken
    . SurePrep uses the token to authenticate the user.

TaxCaddy user account setup

If your firm plans to use the API to make TaxCaddy calls, you will need to complete the following task:
  1. Contact SurePrep Support to enable the TaxCaddy API for your domain.
  2. Certain TaxCaddy calls require the user to have administrative access.

Domain Setup

Adjusting domain settings will let your application run seamlessly and give you greater control over the process. Before you get started, you may want to consider making the following configurations: 
Field
Required/Optional
Description
Office Location
Required
, at least 1 Office Location must be configured.
Add your firm's Office Location to your domain settings. Office Location is required to calculate billing, API calls, and restrictions based on location (if enabled).
Tax File Activation
Required
, must activate a tax file to import/export tax software data to/from SurePrep.
Connect your firm’s tax software with SurePrep. Go to
FileRoom
Admin
Account Setup
Tax File Activation
.
Custom Status
Optional
Add custom statuses to your domain settings. FileRoom, SPbinder, and API can change binder status. The API can then use custom status to determine the next course of action.
Print on status change
Optional
The domain can automatically print a binder when a status change is triggered based on the configuration. Contact your SurePrep Support to enable this option.
Download path
Optional
Setup a default download path where SurePrep can download files to a designated folder.
API firm default settings
Optional
Set firm default settings that your API calls can fall back on if a parameter is missing. You can also automate tasks according to firm preferences. Go to
FileRoom
Admin
API
Firm Defaults
.

Related content

This article applies to:

  • Product: SurePrep