Document

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

PreviousCustomer NextTenant

Last updated 5 months ago

Get Document

get

Download a document based on its ID.

Authorizations

Query parameters

tenantIdstring · guidRequired

FuseSign Tenant ID

documentIdstring · guidRequired

FuseSign Document ID

Responses

application/json

objectOptionalExample:

{"DocumentId":"e41dad96-e73f-4073-9e38-fb0e1f39d0f2","BundleId":"e063a94a-2847-4f7e-a207-b3141486c823","Meta":"document_lookup_key","DisplayName":"Document Name","EstimatedSize":1000,"SignedPDFDownloadUrl":"https://signed.document/download"}

application/json

get

GET /api/Document/Get HTTP/1.1
Host: localhost:3003
Accept: */*

{
  "Example 1": {
    "DocumentId": "e41dad96-e73f-4073-9e38-fb0e1f39d0f2",
    "BundleId": "e063a94a-2847-4f7e-a207-b3141486c823",
    "Meta": "document_lookup_key",
    "DisplayName": "Document Name",
    "EstimatedSize": 1000,
    "SignedPDFDownloadUrl": "https://signed.document/download"
  }
}

Upload Document from URL

post

Provide a URL of a document for later use in a bundle. This will consume the tenants inbox space. Use the returned Document Id in a Bundle Create request

Authorizations

Query parameters

tenantIdstring · guidRequired

FuseSign Tenant ID

urlstring | nullableRequired

Document URL

Responses

application/json

objectOptionalExample:

{"DocumentId":"e41dad96-e73f-4073-9e38-fb0e1f39d0f2","BundleId":"e063a94a-2847-4f7e-a207-b3141486c823","Meta":"document_lookup_key","DisplayName":"Document Name","EstimatedSize":1000,"SignedPDFDownloadUrl":"https://signed.document/download"}

application/json

post

POST /api/Document/UploadUsingURL HTTP/1.1
Host: localhost:3003
Accept: */*

{
  "Example 1": {
    "DocumentId": "b6053d44-b2ef-475c-a6c5-1431e68b0edb",
    "BundleId": "7f686036-c6e4-434e-93a3-546e58d70cb1",
    "Meta": "document_lookup_key",
    "DisplayName": "Document Name",
    "EstimatedSize": 1000,
    "SignedPDFDownloadUrl": "https://signed.document/download"
  }
}

List Pending

get

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

Authorizations

Query parameters

tenantIdstring · guidRequired

FuseSign Tenant ID

Responses

application/json

object[]OptionalExample:

{"DocumentId":"e41dad96-e73f-4073-9e38-fb0e1f39d0f2","BundleId":"e063a94a-2847-4f7e-a207-b3141486c823","Meta":"document_lookup_key","DisplayName":"Document Name","EstimatedSize":1000,"SignedPDFDownloadUrl":"https://signed.document/download"}

get

GET /api/Document/ListPending HTTP/1.1
Host: localhost:3003
Accept: */*

200Success

[
  {
    "DocumentId": "e41dad96-e73f-4073-9e38-fb0e1f39d0f2",
    "BundleId": "e063a94a-2847-4f7e-a207-b3141486c823",
    "Meta": "document_lookup_key",
    "DisplayName": "Document Name",
    "EstimatedSize": 1000,
    "SignedPDFDownloadUrl": "https://signed.document/download"
  }
]

Download Signed Document

get

Download the pdf document in it's current state (signed or unsigned)

Authorizations

Query parameters

tenantIdstring · guidRequired

FuseSign Tenant ID

bundleIdstring · guidRequired

FuseSign Bundle ID

documentIdstring · guidRequired

FuseSign Document ID

Responses

application/json

stringOptional

get

GET /api/Document/Download HTTP/1.1
Host: localhost:3003
Accept: */*

404

File not found

text

Delete Document

post

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

Authorizations

Query parameters

tenantIdstring · guidRequired

FuseSign Tenant ID

documentIdstring · guidRequired

FuseSign Dcoument ID

Responses

application/json

objectOptional

application/json

post

POST /api/Document/Delete HTTP/1.1
Host: localhost:3003
Accept: */*

{
  "Result": true,
  "Message": "text",
  "Error": "text",
  "Errors": [
    {
      "Property": "text",
      "ErrorMessage": "text",
      "ErrorCode": "text"
    }
  ]
}

Download Document Audit

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

Query parameters

tenantIdstring · guidRequired

FuseSign Tenant ID

bundleIdstring · guidRequired

FuseSign Bundle ID

documentIdstring · guidRequired

FuseSign Document ID

Responses

application/json

stringOptional

get

GET /api/Document/DownloadAudit HTTP/1.1
Host: localhost:3003
Accept: */*

404

File not found

text

Download Document without Audit

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

Query parameters

tenantIdstring · guidRequired

FuseSign Tenant ID

bundleIdstring · guidRequired

FuseSign Bundle ID

documentIdstring · guidRequired

FuseSign Document ID

Responses

application/json

stringOptional

get

GET /api/Document/DownloadDocumentNoAudit HTTP/1.1
Host: localhost:3003
Accept: */*

404

File not found

text

Upload Document

post

Upload a file for later use in a bundle. This will consume the tenants inbox space. Use the returned Document Id in a Bundle Create request

Authorizations

Body

tenantIdstringRequired

Tenant which the file belongs to

metastringOptional

The Metadata string to associate with this file

filestring · binaryRequired

The PDF file to be uploaded

Responses

application/json

objectOptionalExample:

{"DocumentId":"e41dad96-e73f-4073-9e38-fb0e1f39d0f2","BundleId":"e063a94a-2847-4f7e-a207-b3141486c823","Meta":"document_lookup_key","DisplayName":"Document Name","EstimatedSize":1000,"SignedPDFDownloadUrl":"https://signed.document/download"}

application/json

post

POST /api/Document/Upload HTTP/1.1
Host: localhost:3003
Content-Type: multipart/form-data
Accept: */*
Content-Length: 49

{
  "tenantId": "text",
  "meta": "text",
  "file": "binary"
}

{
  "Example 1": {
    "DocumentId": "89550f43-62e8-4939-b819-b4229ec3ea71",
    "BundleId": "2570a915-0f32-4563-9869-de5b49d9e37b",
    "Meta": "document_lookup_key",
    "DisplayName": "Document Name",
    "EstimatedSize": 1000,
    "SignedPDFDownloadUrl": "https://signed.document/download"
  }
}