Document

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

Produce the details of a specific document in the system.

get

Authorizations

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 120837a7-c5bd-4bb2-a4f7-6d155bf93a37

DocumentIdstring · guidRequired

Document Id

Example: fc0a7454-3ac1-464f-b18b-cc8077d21782

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

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

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 3b018350-1222-46f1-b3e7-802e8d933647

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

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

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Body

Filestring · binaryOptional

TenantIdstring · guid · min: 1Required

FuseSign Tenant Id

Example: de037523-aee3-46c0-b567-5670b15415f3

Metastring · max: 2048 · nullableOptional

Metadata to attach to document for later use

Example: 3af643e6-f425-4495-aea6-d13081b77e69

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

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": "de037523-aee3-46c0-b567-5670b15415f3",
  "Meta": "3af643e6-f425-4495-aea6-d13081b77e69"
}

{
  "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

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: a62b7faf-c903-4420-94df-06c5539d684a

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

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

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: b7fba9dc-f1a1-470c-a593-157ad3937221

BundleIdstring · guidRequired

Bundle Id

Example: e067e7ea-f07f-460f-a521-f2ccc6129bd6

DocumentIdstring · guidRequired

Document Id

Example: 7402ccb1-a41d-430c-9b0d-c3ac445dacee

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

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

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 7250b82f-9b1f-44a4-847a-8089dbb58000

Body

DocumentIdstring · guid · min: 1Required

Document Id

Example: a861193d-1114-4d05-af50-ac77f8908e1e

Responses

200

Success

application/json

ResultbooleanOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

post/api/Document/Delete

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": "a861193d-1114-4d05-af50-ac77f8908e1e"
}

{
  "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

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 1a897499-9327-43b0-9c1f-69353ea516f9

BundleIdstring · guidRequired

Bundle Id

Example: ae5e07d6-e0f4-43d2-a58d-0f642e2711d8

DocumentIdstring · guidRequired

Document Id

Example: 385bd260-874a-4bbc-8245-a9974e726619

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

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

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: aeff58ed-fb48-445a-9182-2084f857d882

BundleIdstring · guidRequired

Bundle Id

Example: 4a747513-11fc-44cc-87a2-7ca89667367b

DocumentIdstring · guidRequired

Document Id

Example: 33384329-f8a0-43cd-9c55-75dfdf31442c

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

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

binary