POST api/Document/DigitalSignatureCompleteDocumentInTransaction

Completes a document in a digital signature transaction

Request Information

URI Parameters

None.

Body Parameters

Input parameter

WorkPoint365.WebAPI.Model.Document+DigitalSignatureCompleteDocumentInTransactionParameter
NameDescriptionTypeAdditional information
SignedPdfBytes

The PDF document as a byte array.

Collection of byte

None.

TransactionID

The transacation id

string

None.

FileName

The file name with extension to complete

string

None.

SigningStatus

The signing status

WorkPoint365.WebAPI.Model.Document+SigningStatus

None.

Message

An optional message

string

None.

UndeclareOriginalDocumentOrAppendixFileAsRecord

The document undeclaration behaviour. If set to true, the original document is undeclared as record

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "SignedPdfBytes": "QEA=",
  "TransactionID": "sample string 1",
  "FileName": "sample string 2",
  "SigningStatus": 10,
  "Message": "sample string 3",
  "UndeclareOriginalDocumentOrAppendixFileAsRecord": true
}

application/xml, text/xml

Sample:
<Document.DigitalSignatureCompleteDocumentInTransactionParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
  <FileName>sample string 2</FileName>
  <Message>sample string 3</Message>
  <SigningStatus>InProgress</SigningStatus>
  <TransactionID>sample string 1</TransactionID>
  <UndeclareOriginalDocumentOrAppendixFileAsRecord>true</UndeclareOriginalDocumentOrAppendixFileAsRecord>
  <SignedPdfBytes>QEA=</SignedPdfBytes>
</Document.DigitalSignatureCompleteDocumentInTransactionParameter>

Response Information

Resource Description

Collection of WorkPoint365.WebAPI.Model.Document+DigitalSignatureError
NameDescriptionTypeAdditional information
ErrorType

Error type

WorkPoint365.WebAPI.Model.Document+DigitalSignatureError+Type

None.

Text

Text

string

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.