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:

Set up

Get Started with SurePrep API

GetToken

Use these methods to get firm-related information you can use in other method calls.

ServiceTypes (Lookup Method)

BinderTemplates (Lookup Method)

OfficeLocations (Lookup Method)

BinderStatusList (Lookup Method)

CreateBinder: You don't need to call this method again when adding additional documents to binders with leadsheets. You can directly call “UploadBinderDocuments”(#5).

UploadBinderDocuments: Call this method individually for every document you need to add before calling the "SubmitBinder"(#6) method.

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.

Update owner, member, or office location

Follow these steps to update an owner, member, or office location:

Set up
:

Get Started with SurePrep API

GetToken

Update owner, member, or office location
:

OfficeLocations (Lookup Method): Use this method to get firm-related information to use in other method calls.

UpdateOwnerMember

Update Owner

CreateBinder: While adding additional documents, you can use this method to update the binder owner.

Update binder status

Follow these steps to update binder status:

Set up
:

Get Started with SurePrep API

GetToken

Lookup Method

BinderStatusList (Lookup Method): Use this method to get firm-related information you can use in other method calls.

Change Status
:

ChangeBinderStatus

Update Project ID

Use case for updating a binder's project ID

Follow these steps to update the project ID:

Set up
:

Get Started with SurePrep API

GetToken

Update Project ID

UpdateProjectID

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