boxBundle

A bundle is a collection of messages, settings, recipients, documents and optionally placeholders.

Gets the details of a bundle.

get

Gets the detailed information of a bundle

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: b7096d68-8288-4d3d-9045-40dfdd58c9a6
BundleIdstring · guidRequired

Bundle Id

Example: 0aa6dde2-3dbe-43e3-a16c-d619f31f9918
Responses
chevron-right
200

Success

application/json
Idstring · guidOptional

Unique bundle ID

TenantIdstring · guidOptional

Bundle Tenant ID

ReviewUrlstring · nullableOptional

This URL will be set if the bundle is active with a link to the review page

DraftUrlstring · nullableOptional

This URL will be set if the bundle is in draft phase and allows for the bundle to be edited.

Subjectstring · nullableOptional

Bundle subject

Bodystring · nullableOptional

Bundle Body message

FromNamestring · nullableOptional

Who the bundle is from (included in email)

DueDatestring · date-time · nullableOptional

The bundle due date (optional)

DueReminderModeone ofOptional

Bundle reminder mode

string · enumOptionalPossible values:
OverdueReminderModeone ofOptional

Bundle overdue reminder mode

string · enumOptionalPossible values:
DateSentstring · date-time · nullableOptional

Date the bundle was sent if it is live

DateCompletedstring · date-time · nullableOptional

Date the bundle was completed if it is finalised

DateArchivedstring · date-time · nullableOptional

Date the bundle was archived if it is archived

LastReminderSentstring · date-time · nullableOptional

Date the last reminder was sent

Stateone ofOptional

Current bundle state

string · enumOptionalPossible values:
ViewModeone ofOptional

The bundle view mode setting. If this is blank the business default is selected and the system falls back to the highest available authentication

string · enumOptionalPossible values:
SigningModeone ofOptional

The bundle signing mode

string · enumOptionalPossible values:
Settingsone of · nullableOptional

Bundle settings object

Metastring · nullableOptional

Bundle lookup metadata

get
/api/Bundle/Get
circle-info

see Bundle Createfor a deep dive with more explanation

Creates a new bundle.

post

Submit a bundle to request to Sign with other options. FuseSign offers two different methods for document signing: Sign Entire Document and Signature Placeholders. Sign Entire Document is default. Whereas placeholder mode requires values in Documents > CustomerInputElements. We recommend uploading your documents to /Document/Upload to use DocumentId.

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Body
Subjectstring · max: 200Optional

Bundle subject

Example: test
BodystringOptional

Bundle Body message

Example: body
CreateModeone ofOptional

Create and send or create as draft

Example: CreateAndSend
string · enumOptionalPossible values:
CreatedBystring · emailOptional

Sets the created by user email. If the user exists and the requestor has permissions, then the bundle will be "created" by the specified user. Will cause an error to throw if the user does not have permissions to do this.

Pattern: ^[^@]+@[^@]+$
DueDatestring · date-time · nullableOptional

The bundle due date (optional)

DueReminderModeone of · nullableOptional

Bundle reminder mode (optional)

string · enumOptionalPossible values:
OverdueReminderModeone of · nullableOptional

Bundle overdue reminder mode (optional)

string · enumOptionalPossible values:
ViewModeone of · nullableOptional

The bundle view mode setting. If this is blank the business default is selected and the system falls back to the highest available authentication

string · enumOptionalPossible values:
RecipientReceiveModeone of · nullableOptional

How the recipients receive signed documents

string · enumOptionalPossible values:
SigningModeone of · nullableOptional

Describe how the document(s) will be processed. I.e. if signature placements are used [I.e. if SENDING SignPlacements then all Documents must have CustomerSignerLocations set. Otherwise CustomerSigners.].

Example: SignPlacements
string · enumOptionalPossible values:
Settingsone ofOptional

Bundle settings object - API related options.

Metastring · max: 1000Optional

Bundle lookup metadata

TeamIdstring · guid · nullableOptional

If assigned - apply this team to the bundle. Verify that the user sending the bundle can send on behalf of this team.

SenderIPstring · nullableOptional

IP Address applied to the bundle Audit. Automatic Field - no need to set.

Responses
chevron-right
200

Success

application/json
Idstring · guidOptional

Unique bundle ID

TenantIdstring · guidOptional

Bundle Tenant ID

ReviewUrlstring · nullableOptional

This URL will be set if the bundle is active with a link to the review page

DraftUrlstring · nullableOptional

This URL will be set if the bundle is in draft phase and allows for the bundle to be edited.

Subjectstring · nullableOptional

Bundle subject

Bodystring · nullableOptional

Bundle Body message

FromNamestring · nullableOptional

Who the bundle is from (included in email)

DueDatestring · date-time · nullableOptional

The bundle due date (optional)

DueReminderModeone ofOptional

Bundle reminder mode

string · enumOptionalPossible values:
OverdueReminderModeone ofOptional

Bundle overdue reminder mode

string · enumOptionalPossible values:
DateSentstring · date-time · nullableOptional

Date the bundle was sent if it is live

DateCompletedstring · date-time · nullableOptional

Date the bundle was completed if it is finalised

DateArchivedstring · date-time · nullableOptional

Date the bundle was archived if it is archived

LastReminderSentstring · date-time · nullableOptional

Date the last reminder was sent

Stateone ofOptional

Current bundle state

string · enumOptionalPossible values:
ViewModeone ofOptional

The bundle view mode setting. If this is blank the business default is selected and the system falls back to the highest available authentication

string · enumOptionalPossible values:
SigningModeone ofOptional

The bundle signing mode

string · enumOptionalPossible values:
Settingsone of · nullableOptional

Bundle settings object

Metastring · nullableOptional

Bundle lookup metadata

post
/api/Bundle/Create

Get bundle audit history.

get

Get a bundles history, including things like Finalisation, Errors and other actions. We recommend using Webhooks instead where appropriate.

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 20dd5c32-9843-49ca-adb4-3e59a1b555d0
BundleIdstring · guidRequired

Bundle Id

Example: 4bdde320-7410-4c5c-9a2f-43935851ab00
Responses
chevron-right
200

Success

application/json
Idstring · guidOptional

Event ID

DateTimestring · date-timeOptional

Event Time

BundleIdstring · guidOptional

Bundle ID

DocumentIdstring · guid · nullableOptional

Related Document ID

CustomerIdstring · guid · nullableOptional

Related Customer ID

Actionone ofOptional

Event Action type

string · enumOptionalPossible values:
ActionNotesstring · nullableOptional

Event information

IPstring · nullableOptional

Customer IP if applicable

get
/api/Bundle/GetHistory

Retract a bundle.

post

Request bundle retraction. This will cancel the outstanding sign request

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: ad103034-a7da-4e6b-a119-f6e3250ca24b
Body
BundleIdstring · guid · min: 1Required

Bundle Id

Example: d74b7ba0-3861-43ae-a16f-f0eebef5bec4
Reasonstring · min: 1Required

[Mandatory] Reason for retraction

Example: Reason
Messagestring · nullableOptional

[Optional] Additional message

Responses
chevron-right
200

Success

application/json
ResultbooleanOptional
post
/api/Bundle/Retract

Mark Bundle for Archive

post

Mark the bundle as "Closed" which will allow it to be archived

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 7732bcab-aaee-480b-bd8f-2e4dfb0966e7
Body
BundleIdstring · guid · min: 1Required

Bundle Id

Example: 1929c46a-2d04-4d66-baae-d0bc4eedafe3
Responses
chevron-right
200

Success

application/json
ResultbooleanOptional
post
/api/Bundle/MarkReadyForArchive

Gets a list of bundles.

post

Gets a list of bundles for the specified tenant.

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 25d30be5-758c-4713-adfb-3ddc57d40df5
Body
Pageinteger · int32Optional

Search page (50 records per page). 0 Based indexing.

Example: 0
Responses
chevron-right
200

Success

application/json
Pageinteger · int32Optional

Search page

TotalPagesinteger · int32Optional

Total pages

RecordsPerPageinteger · int32Optional

Number of records per page

Countinteger · int32Optional

Number of records returned for this page

post
/api/Bundle/Search

Archive a completed bundle

post

Request bundle Archive. This will schedule any bundle documents for deletion. Bundles can only be archived if they are in a Retracted, Rejected or Finalised state

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 6772da0f-f955-462d-9565-819858b176cc
Body
BundleIdstring · guid · min: 1Required

Bundle Id

Example: dc9d881b-e09e-4ff8-b003-907611fe81ba
Responses
chevron-right
200

Success

application/json
ResultbooleanOptional
post
/api/Bundle/Archive

Remind a bundle.

post

Send a reminder for a bundle (Requires Emails to be enabled for the bundle)

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: a0914510-e175-4cf4-8a15-de5600b7b106
Body
BundleIdstring · guid · min: 1Required

Bundle Id

Example: 183a6284-9be6-4aa7-910d-749beaf850bc
ReminderNotesstring · nullableOptional

Notes to include in the email

TargetCustomerIdsstring · guid[] · min: 1Required

List of customer IDs (can be retrieved on Bundle/Get

Example: ["e7bc38e6-ebc3-498c-b6b1-197e9531edee"]
Responses
chevron-right
200

Success

application/json
ResultbooleanOptional
post
/api/Bundle/SendReminder

Delete a Bundle Draft

post

For a given bundle in draft state, delete the draft. This will consequently unlink associated documents and customer actions. Documents will not be deleted.

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: f5602bcb-c0ed-4ccb-955e-f88ef16870e6
Body
BundleIdstring · guid · min: 1Required

Bundle Id

Example: fae27b27-6ae5-4939-b1c3-66cc9a619f96
Responses
chevron-right
200

Success

application/json
ResultbooleanOptional
post
/api/Bundle/DeleteBundleDraft

Update the webhook URL for a bundle

post

Update the webhook URL. All future webhooks will be sent to the new URL.

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 96e880c6-c6cb-48a9-8b33-35608b275dbd
Body
BundleIdstring · guid · min: 1Required

Bundle Id

Example: 9289ff5b-5da1-4175-8371-19d40f93822b
EventWebhookUrlstring · min: 1Required

New webhook URL

Responses
chevron-right
200

Success

application/json
ResultbooleanOptional
post
/api/Bundle/UpdateWebhookUrl

List Pending archive bundles

get

Request a list of all bundles which have been finalised/retracted or rejected which are yet to be archived. These bundles and associated documents will be automatically archived in 14 days

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 61c6a72c-a5b9-487f-9443-04a0016e87dd
Responses
chevron-right
200

Success

application/json
Idstring · guidOptional

Unique bundle ID

TenantIdstring · guidOptional

Bundle Tenant ID

ReviewUrlstring · nullableOptional

This URL will be set if the bundle is active with a link to the review page

DraftUrlstring · nullableOptional

This URL will be set if the bundle is in draft phase and allows for the bundle to be edited.

Subjectstring · nullableOptional

Bundle subject

Bodystring · nullableOptional

Bundle Body message

FromNamestring · nullableOptional

Who the bundle is from (included in email)

DueDatestring · date-time · nullableOptional

The bundle due date (optional)

DueReminderModeone ofOptional

Bundle reminder mode

string · enumOptionalPossible values:
OverdueReminderModeone ofOptional

Bundle overdue reminder mode

string · enumOptionalPossible values:
DateSentstring · date-time · nullableOptional

Date the bundle was sent if it is live

DateCompletedstring · date-time · nullableOptional

Date the bundle was completed if it is finalised

DateArchivedstring · date-time · nullableOptional

Date the bundle was archived if it is archived

LastReminderSentstring · date-time · nullableOptional

Date the last reminder was sent

Stateone ofOptional

Current bundle state

string · enumOptionalPossible values:
ViewModeone ofOptional

The bundle view mode setting. If this is blank the business default is selected and the system falls back to the highest available authentication

string · enumOptionalPossible values:
SigningModeone ofOptional

The bundle signing mode

string · enumOptionalPossible values:
Settingsone of · nullableOptional

Bundle settings object

Metastring · nullableOptional

Bundle lookup metadata

get
/api/Bundle/ListPendingArchive
get

Returns the signing URL for a given customer on a bundle. Requires the CanGetSigningLinks developer permission.

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 1ef54f06-749b-47f7-bc7b-5158e844ce61
BundleIdstring · guidRequired

Bundle Id

Example: 0b95c3c4-a375-40e8-9904-2d9a4732b292
CustomerIdstring · guidRequired

Customer Id

Example: 05b65abc-0b23-4804-9b35-d3703ddbe632
Responses
chevron-right
200

Success

application/json
SigningLinkstringOptional
get
/api/Bundle/GetCustomerSigningLink

Last updated