Skip to main content

Solutions

Law firms

Tax, audit & accounting firms

Corporations

Governments

Products

Legal

Trade & supply

Tax, audit & accounting

Corporate tax

Risk & fraud

Books

Recommended products

Questions? We are here to help.
Contact us

Purchase

Buy solutions

Buy books

Contact sales

Questions? We are here to help.

Resources

Insights

Events

Product training

Product communities

Developers

API

SurePrep API - Binder use cases

SurePrep API Use Cases can help you visualize and plan how to integrate your application with SurePrep. You can walk through the process of identifying methods, creating steps, and running tasks using the SurePrep API.

Create binders (including adding additional documents)

Use this workflow to create binders and add additional documents.
Use case for creating, maintaining, and submitting binders.
Follow these steps to create a binder:
  1. Set up
    1. Get Started with SurePrep API
  2. Use these methods to get firm-related information you can use in other method calls.
  3. CreateBinder: You don't need to call this method again when adding additional documents to binders with leadsheets. You can directly call “UploadBinderDocuments”(#5).
  4. UploadBinderDocuments: Call this method individually for every document you need to add before calling the "SubmitBinder"(#6) method.
  5. SubmitBinder: Call this method only once after you've uploaded all the binder documents.
Update binder details.
You can use any of these workflows to update binder details. There are multiple methods available to update different binder details.
Use case for updating owner members
Update owner, member, or office location
Follow these steps to update an owner, member, or office location:
  1. Set up
    :
    1. Get Started with SurePrep API
  2. Update owner, member, or office location
    :
    1. OfficeLocations (Lookup Method): Use this method to get firm-related information to use in other method calls.
  3. Update Owner
    1. CreateBinder: While adding additional documents, you can use this method to update the binder owner.
Update binder status
Use case for changing a binder's status
Follow these steps to update binder status:
  1. Set up
    :
    1. Get Started with SurePrep API
  2. Lookup Method
    1. BinderStatusList (Lookup Method): Use this method to get firm-related information you can use in other method calls.
  3. Change Status
    :
Update Project ID
Use case for updating a binder's project ID
Follow these steps to update the project ID:
  1. Set up
    :
    1. Get Started with SurePrep API
  2. Update Project ID

Print and download documents

You can use either of these workflows to print and download documents from the binder. There are multiple ways to initiate the printing of documents for the binder.
Print
Use case for downloading a document
Follow these steps to print and download documents:
  1. Setup
    :
    1. Get Started with SurePrep API
  2. Check Binder Status
    1. Call the preferred method.
  4. Receive Print Completed Notification
    : PushDocumentType (Webhook)
  5. Download Documents
    :
Print on status change
Use case for downloading a document
Follow these steps to print on status change and then download documents:
  1. Setup
    :
    1. Get Started with SurePrep API
  2. Receive Print Completed Notification
    :
    1. PushDocumentType (Webhook): You can trigger print based on binder status change. This lets you begin directly from this webhook method.
  3. Download Documents

Get binder information

Use these workflows to get and/or display general binder details (Status or BinderID, for example).
Get Status, States, and Localities
Use case for getting statuses, states, and localities for a binder
Follow these steps to get binder Status, States, and Localities:
  1. Setup
    1. Get Started with SurePrep API
  2. Get States, Status, and Localities
    1. Call the preferred methods.
Get binder details
Use case for getting binder details
Follow these steps to get binder information:
  1. Setup
    1. Get Started with SurePrep API
  2. Get Binder Information
    : GetBinderDetails
Get binder audit log
Use case for getting a binder audit log
Follow these steps to get a binder's audit log:
  1. Setup
    1. Get Started with SurePrep API
  2. Get binder audit log
    : GetBinderAuditLog

Get information about pending items

Use any of these workflows to get and/or display pending item details.
Use case for getting information about pending items in a binder
Follow these steps to get pending items:
  1. Setup
    1. Get Started with SurePrep API
  2. Get Pending Items Information
    1. Call the preferred methods.

Open binders from your portal

Use this workflow to access binders from your portal.
Use case for downloading a PBFX file
Follow these steps to open the binder from your portal:
  1. Setup
    1. Get Started with SurePrep API

This article applies to:

  • Product: SurePrep

Related Content

error-icon

Triva isn't available right now.

Check out the support page for our phone number and hours

error-close