# info.description
Use the api to sign electronic documents

# paths./SeliSign/Commands/AddDocument.post.description
<param name="command"></param> Payload information:
            
            MessageCoRelationId: String representing the message co relationId ID for this command.
            
            DocumentId: String representing the document ID.
            
            Title: Set the title of the contract.
            
            SignatureClass: Set the signature classisfication for a document. Use 0,1,2,3 for EsigWithCoordinates, Advanced, AdvancedSwisscom, and QualifiedSwisscom respectively.
            
            FilesToBeSigned: List of files to be signed in this contract. Upon saving your files in storage service, set the information of the files here.
            
            BulkSignatureDocumentId: Set the id of the bulk contract of which this contract is part of.
            
            IsOffloaded: Set this to true if queue offloaded execution of this command is desired.
            
            Tags: Array of tags. Set this to tag a contract with a slug of distinct values.
            
            ESignatureTemplateFileIds: Array of source file ids of the e-signature template against which this contract is generated.
            
            ESignatureTemplateId: Id of the e-signature template against which this contract is generated.

# paths./SeliSign/Commands/AddDocumentWithOwner.post.summary
Add a document with an owner. An owner can assign signatories and prepare documents for signatures.

# paths./SeliSign/Commands/AddDocumentWithOwner.post.description
<param name="command"></param> Payload information:
            
            OwnerPersonId: String representing the document owner's person ID.
            
            MessageCoRelationId: String representing the message co relationId ID for this command.
            
            DocumentId: String representing the document ID.
            
            Title: Set the title of the contract.
            
            SignatureClass: Set the signature classisfication for a document. Use 0,1,2,3 for EsigWithCoordinates, Advanced, AdvancedSwisscom, and QualifiedSwisscom respectively.
            
            FilesToBeSigned: List of files to be signed in this contract. Upon saving your files in storage service, set the information of the files here.
            
            BulkSignatureDocumentId: Set the id of the bulk contract of which this contract is part of.
            
            IsOffloaded: Set this to true if queue offloaded execution of this command is desired.
            
            Tags: Array of tags. Set this to tag a contract with a slug of distinct values.
            
            ESignatureTemplateFileIds: Array of source file ids of the e-signature template against which this contract is generated.
            
            ESignatureTemplateId: Id of the e-signature template against which this contract is generated.

# paths./SeliSign/Commands/AddSignatory.post.description
<param name="command"></param> Payload information:
            
            PersonId: String representing the person ID.	
            
            DocumentId: String representing the document ID.
            
            SignatoryID: String representing the signatory ID.
            
            EnterpriseRole: String representing the enterprise role of the signatory. Only applicable for signature class: advanced applied documents.
            
            ContractRole: Contract role of the signatory. Use 0,1 for Signer, Reviewer respectively.

# paths./SeliSign/Commands/AggregatedESignature.post.summary
Perform multiple commands simultaneously for a document.

# paths./SeliSign/Commands/AggregatedESignature.post.description
<param name="command"></param> Payload information:
             
             MessageCoRelationId: String representing the message co relationId ID for this command.
            
             AddDocument: AddDocumentCommand.
             
             AddDocumentWithOwner: AddDocumentWithOwnerCommand.
             
             AddSignatories: Array of AddSignatoryCommands.
             
             SetSignatureCoordinates: SetSignatureCoordinatesCommand.
             
             RolloutDocument: RolloutDocumentCommand.
             
             ExecutableCommands: The executable commands list.
             
             Send either AddDocumentCommand or AddDocumentWithOwnerCommand and not both and not without either of them.
             Send an array of AggregatedESignatureExecutableCommand in the ExecutableCommands field. Only the commands you set will be executed in orderly fashion.
             Use 0 for AddDocument,1 for AddDocumentWithOwner, 2 for AddSignatories, 3 for SetSignatureCoordinates, 4 for RolloutDocument respectively.

# paths./SeliSign/Commands/ArchiveDocument.post.description
<param name="command"></param> Payload information:
             
             DocumentIds: Array of document ids to be archived.

# paths./SeliSign/Commands/CancelWorkflows.post.summary
Cancel the workflows of the DocumentIds provided.

# paths./SeliSign/Commands/CancelWorkflows.post.description
<param name="command"></param> Payload information:
             
             DocumentIds: Array of document ids to be canceled.

# paths./SeliSign/Commands/CreateSignDocuments.post.summary
Create audit log files and zipped report for a document.

# paths./SeliSign/Commands/CreateSignDocuments.post.description
<param name="command"></param> Payload information:
            
            DocumentId: String representing the document ID.

# paths./SeliSign/Commands/DeclineDocument.post.description
<param name="command"></param> Payload information:		
            
            DocumentId: String representing the document ID.
            
            DeclineMessage: String representing the decline message.
            
            TwoFactorAuthenticationId: String representing the two factor authentication ID.
            
            TwoFactorAuthenticationCode: String representing the two factor authentication code.

# paths./SeliSign/Commands/RemoveSignatory.post.description
<param name="command"></param> Payload information:
            
            DocumentId: String representing the document ID.
            
            SignatoryId: String representing the signatory ID.

# paths./SeliSign/Commands/RemoveSignatureCoordinate.post.summary
Remove a signature cooridnate of a signatory in a file from a document.

# paths./SeliSign/Commands/RemoveSignatureCoordinate.post.description
<param name="command"></param> Payload information:
            
            DocumentId: String representing the document ID.
            
            SignatoryId: String representing the signatory ID.
            
            CoordinateId: String representing the coordinate ID.

# paths./SeliSign/Commands/ResendInvitation.post.description
<param name="command"></param> Payload information:
            
            DocumentId: String representing the document ID.
            
            SignatoryId: String representing the signatory ID.
            
            TemplateName: String representing the name of the email template.

# paths./SeliSign/Commands/ResetSignature.post.description
<param name="command"></param> Payload information:
             
             DocumentId: String representing the document ID.
            
             SignatoryId: String representing the signatory ID.
             
             Reason: String representing the Reason for resetting this signature.
             
             EmailTemplateName: String representing the name of the email template to be used for sending invitation to SignatoryId.

# paths./SeliSign/Commands/RollbackDocument.post.summary
Resend document to assigned signatories. Roll back is generally used in case of any problems regarding the initial roll out document.

# paths./SeliSign/Commands/RollbackDocument.post.description
<param name="command"></param> Payload information:
            
            TemplateName: String representing the email template name.
            
            String representing the document ID.

# paths./SeliSign/Commands/RolloutBulkESignatureDocuments.post.summary
Perform  AggregatedESignature action for each document created agaist the BulkESignatureDocumentId.

# paths./SeliSign/Commands/RolloutBulkESignatureDocuments.post.description
<param name="command"></param> Payload information:
             
             BulkESignatureDocumentId: String representing ID of the bulk esignature document.

# paths./SeliSign/Commands/RolloutDocument.post.summary
Rolls out a contract to be signed. Signatories, signature coordinates, text fields are set and invitations are sent to the signatories.

# paths./SeliSign/Commands/RolloutDocument.post.description
<param name="command"></param> Payload information:
            
            TemplateName: String representing the name of the email template to be used for sending invitation to signatories.
            
            DocumentId: String representing the document ID.

# paths./SeliSign/Commands/SetSignatureCoordinate.post.summary
Set coordinates for a signature placeholder for a file on the document.

# paths./SeliSign/Commands/SetSignatureCoordinate.post.description
<param name="command"></param> Payload information:
            
            DocumentId: String representing the document ID.
            
            SignatoryId: String representing the signatory ID.
            
            CoordinateId: String representing the coordinate ID.
            
            X: Set X-coordinates on the document for esignature.
            
            Y: Set Y-coordinates on the document for esignature.
            
            Width: The value of the width of the space allocated for Esignature.
            
            Height: The value of the height of the space allocated for Esignature.
            
            PageNumber: Integer value representing the page number. Starts with 0.
            
            FileId: String representing the file ID.
            
            Order: The order of the signatory for which this coordinate is being set.

# paths./SeliSign/Commands/SetSignatureCoordinates.post.summary
Set signature coordinates on a document for signatories.

# paths./SeliSign/Commands/SetSignatureCoordinates.post.description
<param name="command"></param> Payload information:
            
            DocumentId: String representing the document ID.
            
            StampCoordinates: The stamp coordinates to be placed in a document.
            
            TextFieldCoordinates: the text fields with values that needs to be placed in a document.
            		
            StampPostInfoCoordinates: the stamp information that needs to be placed in a document.

# paths./SeliSign/Commands/SetSignatureCoordinatesAndRollout.post.description
<param name="command"></param>
            
            TemplateName: String representing the name of the template.
            
            DocumentId: String representing the document ID.
            
            StampCoordinates: The stamp coordinates to be placed in a document.
            
            TextFieldCoordinates: the text fields with values that needs to be placed in a document.
            
            StampPostInfoCoordinates: the stamp information that needs to be placed in a document.

# paths./SeliSign/Commands/SetSigningOrders.post.summary
Set signing orders for the signatories of a document.

# paths./SeliSign/Commands/SetSigningOrders.post.description
<param name="command"></param> Payload information:			
            
            DocumentId: String representing the document ID.
            
            SequentialSignatureEnabled: Set to true if sequential signing of the document is intended.
            
            SignatorySigningOrders: List of Signatories and their signing orders to be enforced.

# paths./SeliSign/Commands/SignDocument.post.description
<param name="command"></param> Payload information:
            
            DocumentId: String representing the document ID.
            
            SignedDocumentFileId: String representing the signed document file ID.
            
            TwoFactorAuthenticationId: String representing the two factor authentication ID.
            
            TwoFactorAuthenticationCode: String representing the two factor authentication code.
            
            SignatureCoordinates: Value of signature coordinates.
            
            SignatureFormFieldValueCoordinate: these are mapped to signature postinfo coordinates -> FormField entity saved while set siganture coordiantes and rollout rollout.

# paths./SeliSign/Commands/SignDocumentOnBehalf.post.summary
Allow the document owner to sign a document on behalf of an assigned signatory.

# paths./SeliSign/Commands/SignDocumentOnBehalf.post.description
<param name="command"></param> Payload information:
            
            SignatoryId: String representing the signatory ID.
            
            DocumentId: String representing the document ID.
            
            SignedDocumentFileId: String representing the signed document file ID.
            
            TwoFactorAuthenticationId: String representing the two factor authentication ID.
            
            TwoFactorAuthenticationCode: String representing the two factor authentication code.
            
            SignatureCoordinates: Value of signature coordinates.
            
            SignatureFormFieldValueCoordinate: these are mapped to signature postinfo coordinates -> FormField entity saved while set siganture coordiantes and rollout rollout.

# paths./SeliSign/Commands/SignDocuments.post.description
<param name="command"></param> Payload information:
             
             SignatureImageFileId: the image file containing signature which is to be applied to all SignatureCoordinates.
            
             TwoFactorAuthenticationId: String representing the two factor authentication ID.
             
             TwoFactorAuthenticationCode: String representing the two factor authentication code.
             
             Documents: The list of documents containing signature coordinates.

# paths./SeliSign/Commands/SynchronizeDocument.post.summary
Synchronizes a document initiated with advanced class which executes methods to keep the document in sync with siging hub.

# paths./SeliSign/Commands/SynchronizeDocument.post.description
<param name="command"></param> Payload information:
            
            DocumentId: String representing the document ID.

# paths./SeliSign/Commands/UnArchiveDocument.post.description
<param name="command"></param> Payload information:
             
             DocumentIds: Array of document ids to be archived.

# paths./SeliSign/Commands/UpdateDocument.post.description
<param name="command"></param> Payload information:
            
            MessageCoRelationId: String representing the message co relationId ID for this command.
            
            Title: String representing the title of the document.
            
            DocumentId: String representing the document ID.
            
            SignatureClass: Set the signature classisfication for a document. Use 0,1,2,3 for EsigWithCoordinates, Advanced, AdvancedSwisscom, and QualifiedSwisscom respectively.
            
            FilesToBeSigned: List of files to be signed in this contract. Upon saving your files in storage service, set the information of the files here.

# paths./SeliSign/Commands/UpdateSignatory.post.summary
Update contract role of a signatory in a document.

# paths./SeliSign/Commands/UpdateSignatory.post.description
<param name="command"></param> Payload information:	
            
            DocumentId: String representing the document ID.
            
            SignatoryID: String representing the signatory ID.
            
            ContractRole: Contract role of the signatory. Use 0,1 for Signer, Reviewer respectively.

# paths./SeliSign/Queries/CheckDocumentProgress.post.description
<param name="query"></param> Payload information:
            
            DocumentId: String representing the document ID.
            
            DocumentProgress: Int representing the document progress to be checked. 
            Use 0 for AddDocument, 1 for AddSignatories, 2 for SetSignatureCoordinates, 3 for SetTextFieldCoordinates, 4 for SetSignaturePostInfoCoordinates, 5 for RollOutDocument, 6 for SignDocument, 7 for DocumentComplete respectively.

# paths./SeliSign/Queries/GetDocument.get.description
<param name="query"></param> Payload information:
            
            DocumentId: String representing document ID.

# paths./SeliSign/Queries/GetDocumentCounts.get.summary
Gets count of sent, received, signed, unsigned document counts for the current user.

# paths./SeliSign/Queries/GetDocumentCounts.get.description
<param name="query"></param> Payload information:
            
            FromCreatedDate: DateTime from which the query is to be applied.
            
            ToCreatedDate: DateTime to which the query is to be applied.

# paths./SeliSign/Queries/GetDocumentCounts.get.parameters[].description
Format - date-time (as date-time in RFC3339). Format - date-time (as date-time in RFC3339).

# paths./SeliSign/Queries/GetDocumentCounts.get.parameters[].description
Format - date-time (as date-time in RFC3339). Format - date-time (as date-time in RFC3339).

# paths./SeliSign/Queries/GetDocumentsToSign.get.summary
Get documents which require signatures using a query request.

# paths./SeliSign/Queries/GetDocumentsToSign.get.description
<param name="query"></param> Payload information:
            
            DocumentStatus: Filter all documents by this document status.
            		
            SignatureClass: Filter all documents by this signature Class.
            
            SearchKey: String representing the key words for searching document.
            
            PageNumber: Integer value for the page number of document.
            
            PageSize: Integer value of the page size.
            
            Sort: Organize list of documents by sorting mechanism.
            
            SortBy: The method by which the document list will be sorted.
            
            IsArchived: Brings archived cancelled documents only.
            
            IsCancelled: Brings workflow cancelled documents only.
            
            IsOwned: Brings created documents only for the current user.
            
            IsReceived: Brings received documents only for the current user.
            
            IsSigned: Brings signed documents only for the current user.
            
            IsUnsigned: Brings unsigned documents only for the current user.
            
            IsSignatoryDetailsAggregated: Set to true of this query is supposed to send signatory details of the documents as well.
            
            IsBulkSignatureDocumentGenerated: Filters all documents generated by a Bulk Esignature document.
            
            BulkSignatureDocumentId: Filters all documents generated by this particular Bulk Esignature document Id.
            
            SentByPersonId: Filters all documents sent to the current user by this person.
            
            FromCreatedDate: Filters all documents created after this date.
            
            ToCreatedDate: Filters all documents created before this date.
            
            Tags: Filters all documents containing these tags. Must be passed as comma seperated values.

# paths./SeliSign/Queries/GetDocumentsToSign.get.parameters[].description
Format - date-time (as date-time in RFC3339). Format - date-time (as date-time in RFC3339).

# paths./SeliSign/Queries/GetDocumentsToSign.get.parameters[].description
Format - date-time (as date-time in RFC3339). Format - date-time (as date-time in RFC3339).

# paths./SeliSign/Queries/GetEsignatureSettings.get.summary
Get Esignature settings through a query request.

# paths./SeliSign/Queries/GetEsignatureSettings.get.description
Get Esignature settings through a query request.

# paths./SeliSign/Queries/GetSignatories.get.summary
Get a list of assigned signatories for the document.

# paths./SeliSign/Queries/GetSignatories.get.description
<param name="query"></param> Payload information:
            
            DocumentId: String representing document ID.		
            
            ReturnAll: if set to true then all signatories of the provided DocumentId is returned.

# paths./SeliSign/Queries/GetSignatoriesForDocuments.post.summary
Fetch a list of assigned signatories for the document Ids provided.

# paths./SeliSign/Queries/GetSignatoriesForDocuments.post.description
<param name="query"></param> Payload information:
            
            DocumentIds: String containing document ids in a comma separated fashion.

# paths./SeliSign/Queries/GetSignatureLog.get.summary
Get a signature log using a query request.

# paths./SeliSign/Queries/GetSignatureLog.get.description
<param name="query"></param> Payload information:
            
            DocumentId: String representing the document ID.

# paths./SeliSign/Queries/GetSignatures.get.description
<param name="query"></param> Payload information:
            
            DocumentId: String representing the document ID.

# paths./SeliSign/Queries/GetSignedDocuments.get.summary
Get signed documents using a query request.

# paths./SeliSign/Queries/GetSignedDocuments.get.description
<param name="query"></param> Payload information:
            
            DocumentId: String representing the document ID.

# paths./SeliSign/Queries/GetSignedFileMaps.get.summary
Get a signed file map using a query request.

# paths./SeliSign/Queries/GetSignedFileMaps.get.description
<param name="query"></param> Payload information:
            
            DocumentId: String representing the document ID.

# paths./SeliSign/Queries/SignatureInProgress.get.summary
Get all signatures in progress using a query request.

# paths./SeliSign/Queries/SignatureInProgress.get.description
<param name="query"></param> Payload information:
            
            DocumentId: String representing the document ID.
            
            SignatoryId: String representing the signatory ID of the signature in progress.