Document

A file (.pdf) that is used for signing.

Produce the details of a specific document in the system.

get

Authorizations

OAuthTokenApiKey

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: ffc2db48-9b39-43c5-8d1e-db781058856e

DocumentIdstring · guidRequired

Document Id

Example: dcb61c18-b233-4085-801a-f45793955f95

Responses

200

Success

application/json

DocumentIdstring · guidOptional

Document ID

BundleIdstring · guid · nullableOptional

Related bundle ID. Can be null if not yet assigned to a bundle

Metastring · nullableOptional

Lookup metadata

DisplayNamestring · nullableOptional

Document Dispay name

EstimatedSizeinteger · int64Optional

Estimated size of the document (Affects inbox limit)

SignedPDFDownloadUrlstring · nullableOptional

URL to download the signed PDF

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

404

Not Found

application/json

get

/api/Document/Get

HTTPcURLJavaScriptPython

GET /api/Document/Get?TenantId=text&DocumentId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "DocumentId": "text",
  "BundleId": "text",
  "Meta": "text",
  "DisplayName": "text",
  "EstimatedSize": 1,
  "SignedPDFDownloadUrl": "text"
}

Uploads a given document into the system to be attached to bundles. Domain must be preapproved in developer settings page.

post

Authorizations

OAuthTokenApiKey

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: bd6639d7-25f3-421b-80e4-363a9fc16cec

UrlstringRequired

Publically accessible Url with a pdf - must be added to your developer domain whitelist

Example: https://domain/document.pdf

Responses

200

Success

application/json

DocumentIdstring · guidOptional

Document ID

BundleIdstring · guid · nullableOptional

Related bundle ID. Can be null if not yet assigned to a bundle

Metastring · nullableOptional

Lookup metadata

DisplayNamestring · nullableOptional

Document Dispay name

EstimatedSizeinteger · int64Optional

Estimated size of the document (Affects inbox limit)

SignedPDFDownloadUrlstring · nullableOptional

URL to download the signed PDF

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

post

/api/Document/UploadUsingURL

HTTPcURLJavaScriptPython

POST /api/Document/UploadUsingURL?TenantId=text&Url=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "DocumentId": "text",
  "BundleId": "text",
  "Meta": "text",
  "DisplayName": "text",
  "EstimatedSize": 1,
  "SignedPDFDownloadUrl": "text"
}

Uploads a given document into the system to be attached to bundles.

post

Authorizations

OAuthTokenApiKey

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Body

multipart/form-data

Filestring · binaryOptional

TenantIdstring · guid · min: 1Required

FuseSign Tenant Id

Example: e3a9a858-2002-4339-9758-33c4c5747e85

Metastring · max: 2048 · nullableOptional

Metadata to attach to document for later use

Example: 51c91786-9290-4958-a450-64b7c1f6bbe2

Responses

200

Success

application/json

DocumentIdstring · guidOptional

Document ID

BundleIdstring · guid · nullableOptional

Related bundle ID. Can be null if not yet assigned to a bundle

Metastring · nullableOptional

Lookup metadata

DisplayNamestring · nullableOptional

Document Dispay name

EstimatedSizeinteger · int64Optional

Estimated size of the document (Affects inbox limit)

SignedPDFDownloadUrlstring · nullableOptional

URL to download the signed PDF

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

404

Not Found

application/json

post

/api/Document/Upload

HTTPcURLJavaScriptPython

POST /api/Document/Upload HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 109

{
  "File": null,
  "TenantId": "e3a9a858-2002-4339-9758-33c4c5747e85",
  "Meta": "51c91786-9290-4958-a450-64b7c1f6bbe2"
}

{
  "DocumentId": "text",
  "BundleId": "text",
  "Meta": "text",
  "DisplayName": "text",
  "EstimatedSize": 1,
  "SignedPDFDownloadUrl": "text"
}

List all documents which have been uploaded which are not yet connected to a bundle.

get

Authorizations

OAuthTokenApiKey

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 305742d1-160d-47d6-9414-648f6860565b

Responses

200

Success

application/json

DocumentIdstring · guidOptional

Document ID

BundleIdstring · guid · nullableOptional

Related bundle ID. Can be null if not yet assigned to a bundle

Metastring · nullableOptional

Lookup metadata

DisplayNamestring · nullableOptional

Document Dispay name

EstimatedSizeinteger · int64Optional

Estimated size of the document (Affects inbox limit)

SignedPDFDownloadUrlstring · nullableOptional

URL to download the signed PDF

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

404

Not Found

application/json

get

/api/Document/ListPending

HTTPcURLJavaScriptPython

GET /api/Document/ListPending?TenantId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "DocumentId": "text",
    "BundleId": "text",
    "Meta": "text",
    "DisplayName": "text",
    "EstimatedSize": 1,
    "SignedPDFDownloadUrl": "text"
  }
]

Download the pdf document in its current state (signed or unsigned)

get

Authorizations

OAuthTokenApiKey

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 15634c6a-21a6-4541-bf41-42d27f0c5a62

BundleIdstring · guidRequired

Bundle Id

Example: 46b4ac74-27ac-448e-a05d-591457d24ff1

DocumentIdstring · guidRequired

Document Id

Example: c3ad2787-318a-4f77-86d4-ef7d0f4e643e

Responses

200

Success

application/octet-stream

string · binaryOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

404

Not Found

application/json

get

/api/Document/Download

HTTPcURLJavaScriptPython

GET /api/Document/Download?TenantId=text&BundleId=text&DocumentId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

binary

If the target document is not attached to a bundle, you can delete it.

post

Authorizations

OAuthTokenApiKey

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 0efdf5a0-b1e9-4030-9cbf-9d9c5f940ffd

Body

*/*

DocumentIdstring · guid · min: 1Required

Document Id

Example: 044ff4df-a599-4d3e-9fff-8ea0b0567897

Responses

200

Success

application/json

ResultbooleanOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

post

/api/Document/Delete

HTTPcURLJavaScriptPython

POST /api/Document/Delete?TenantId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 53

{
  "DocumentId": "044ff4df-a599-4d3e-9fff-8ea0b0567897"
}

{
  "Result": true
}

Download the pdf document audit trail

get

Download document's audit trail. This will only work if the document has been signed (or is a view only document) and Bundle.Settings.AuditType is set to Separate

Authorizations

OAuthTokenApiKey

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 6f4e6ae7-771d-44fb-bf5a-5eab7b7f9b5c

BundleIdstring · guidRequired

Bundle Id

Example: dcd85db4-8cb9-4014-9f8c-248681338f7b

DocumentIdstring · guidRequired

Document Id

Example: 4df60432-354b-4210-86f1-4b7fbf67bc5a

Responses

200

Success

application/octet-stream

string · binaryOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

404

Not Found

application/json

get

/api/Document/DownloadAudit

HTTPcURLJavaScriptPython

GET /api/Document/DownloadAudit?TenantId=text&BundleId=text&DocumentId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

binary

Download a signed document without the audit trail

get

Download a signed document without an audit trail embedded. This will only work if the document is a document with signing actions and has been signed and Bundle.Settings.AuditType is set to Separate

Authorizations

OAuthTokenApiKey

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 8b73f31b-aa30-4af0-95ef-1279945c903e

BundleIdstring · guidRequired

Bundle Id

Example: 72f6b6b2-89b8-44c1-b60e-a4aad5f6afdf

DocumentIdstring · guidRequired

Document Id

Example: 18bed458-4a21-40ec-93a1-20fadf4359d1

Responses

200

Success

application/octet-stream

string · binaryOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

404

Not Found

application/json

get

/api/Document/DownloadDocumentNoAudit

HTTPcURLJavaScriptPython

GET /api/Document/DownloadDocumentNoAudit?TenantId=text&BundleId=text&DocumentId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

binary