Azure Connectors Node.js SDK
    Preparing search index...

    Typed client for the signinghub connector.

    Hierarchy (View Summary)

    Index
    addCheckboxCheckBox addInitialsInitial addInPersonInPerson addPackagePackage addQrqrCode addRadioRadioBox addSignatureSignature addTextBoxTextBox addWorkflowWorkflowGroup addWorkflowWorkflowPlaceholder addWorkflowWorkflowUser approvePackage approvePackageGatekeeper declinePackage declinePackageGatekeeper deleteAttachmentAttachment deleteDocumentDocument deleteFieldsDocumentField deletePackagePackage deleteWorkflowWorkflowUser deleteWorkSpaceSharedSpace downloadAttachmentAttachment downloadDocumentsDocumentBytes downloadPackagePackageBytes downloadWorkflowEvidenceReportBytes fieldsAutoAssignField fieldsAutoPlace fieldsFillFormFields finishPackage getAttachmentAttachments getContact getDocumentsCertifyPolicy getDocumentsDocumentDetails getEnterpriseDocumentsEnterpriseWorkflowAccess getFieldAllDocumentFields getPackageAllPackages getPackagePackageDetails getSettingTemplates getTemplateEnterpriseTemplates getWorkflowPermissionWorkflowPermissions getWorkflowWorkflowDetail getWorkflowWorkflowHistory getWorkflowWorkflowReminder getWorkflowWorkflowUsers getWorkSpaceSharedSpace initialsFill moveFolderPackage renameDocumentsDocument renamePackagePackage signingBulkSignDocuments signingBulkSignStatus signingSignDocument startWorkflowWorkflow submitPackage updateCheckboxCheckBox updateDocumentsCertifyPolicy updateEnterpriseDocumentsEnterpriseWorkflowAccess updateInitialsInitial updateInPersonInPerson updateQrqrCode updateRadioRadioBox updateSignatureSignature updateTextBoxTextBox updateWorkflowPermissionWorkflowPermissions updateWorkflowWorkflow updateWorkflowWorkflowPlaceholder updateWorkflowWorkflowPostProcess updateWorkflowWorkflowReminder updateWorkflowWorkflowUser updateWorkflowWorkflowUserOrder updateWorkSpaceSharedSpace uploadAttachmentAttachment uploadDocumentsFromLibrary uploadDocumentsStream workflowApplyTemplate workflowMarkWorkflowCompleted workflowRecallWorkflow
    • Add CheckBox Field

      Parameters

      Returns Promise<AddFieldResponse>

      Business applications can use this service API to add a checkbox to a document in a package. At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users. If width and height parameters are not provided, a default size of 10x10 will be assigned. If either width or height (or both) is provided, the system will compare these provided values with each other. The larger value between width and height will be assigned to both dimensions.

    • Add Initial Field

      Parameters

      Returns Promise<AddFieldResponse>

      Business applications can use this service API to add an initials field to a document in a package. At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

    • Add In-person Field

      Parameters

      Returns Promise<AddFieldResponse>

      Business applications can use this service API to an add in-person signature field to a document in a package. At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users. In order to host an in-person meeting a SigningHub user must be part of the workflow.They must either be added with Role "INPERSON_HOST" or "SIGNER". For the host option they do not require a signature or input field on the document, and the in-person signature field can be signed by the non-SigningHub registered user. Note this is a special workflow scenario whereby it is expected that the SigningHub user and recipient would be in the same location.This type of signature is not intended for use whereby a document is shared with recipients over email link in the normal loose integration method.

    • Add Package

      Parameters

      Returns Promise<AddPackageResponse>

      This service API is used to add/create a document package to hold one or more documents. This package can then be used to add documents and recipients in order to start a new workflow. As previously stated, this call is mandatory if you wish to work with documents. A package must exist before you can upload or add documents to SigningHub.. Even a single document is a part of a package: a package containing one document. Note: A package can be renamed if required once created.

    • Add RadioBox Field

      Parameters

      Returns Promise<AddFieldResponse>

      Business applications can use this service API to add a checkbox to a document in a package. At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users. If width and height parameters are not provided, a default size of 10x10 will be assigned. If either width or height (or both) is provided, the system will compare these provided values with each other. The larger value between width and height will be assigned to both dimensions.

    • Add Digital Signature Field

      Parameters

      Returns Promise<SignatureFieldResponse>

      Business applications can use this service API to add a digital signature field to a document in a package. At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. See Add Users to Workflow for more information.Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

    • Add TextBox Field

      Parameters

      Returns Promise<AddFieldResponse>

      Business applications can use this service API to add a text input field to a document in a package. At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

    • Add Placeholder to Workflow

      Parameters

      Returns Promise<CollaboratorPlaceholderResponse[]>

      Business applications can use this service API to add placeholder to a workflow in a package. A place holder is required when you do not know the identity of the intended recipient in a workflow. Note the placeholder will be added as the last user in the workflow.Hence further work may be required to remove a current user/group, already present in the workflow. Adding a place holder allows you to proceed and add signature and/or input fields to the document, which can then be assigned to individual users at a later stage. While XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"

    • Add Users to Workflow

      Parameters

      Returns Promise<CollaboratorResponse[]>

      Business applications can use this service API to add recipients to a workflow. This call will only add a recipient to the workflow. That is, no fields currently on the document will be automatically assigned to the new recipient(s), nor will this create any new fields. Note the recipient(s) will be added as the last person in the workflow.Hence further work may be required to remove a current recipient(s) already present in the workflow. At least one user must exist in a workflow before fields (input and signature) can be added to the document. Note the input accepts one or more users in a single call. In this specific call the user is a known natural person. However, the same rules apply to Groups and Placeholders. In either of these cases the recipient becomes a Group of users whereby any member of the group can sign the document, or a Placeholder.The latter case is used when you do not know the identity of the intended signatory. Note SigningHub workflow signing order starts at "1". Hence, adding a user to workflow with no current recipient(s) begins a new signing order count.The "signing_order" parameter is mandatory if the workflow type is "custom". Important, using this API call may affect the workflow type.If there are current recipients in a sequential workflow and a new one is added with the same signing order as a current recipient, then that part of the workflow changes automatically from sequential to parallel.Hence, the workflow overall is now of type custom as opposed to purely sequential. Adding a recipient with the same signing order as two or parallel recipients does not change the workflow.There are merely, three or more recipients at that particular point of the workflow; all in parallel order. Note, while XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"

    • Delete Package

      Parameters

      Returns Promise<EmptyResponse>

      Business applications can use this service API to delete a document from the user inbox. The package ID is provided in the resource URL as "{package_id}". If the document status is PENDING, then it is automatically declined as result of delete operation. If the document status is SHARED, then the document is automatically recalled and workflow is stopped before the document is deleted.

    • Delete Shared Space

      Parameters

      Returns Promise<EmptyResponse>

      Business applications can use this service API to delete shared space. The availability of deleting shared spaces is subject to the assigned enterprise user role. To allow this provision Enterprise Admin will enable the ‘Manage Shared Space’ option in Roles>Document Settings.

    • Download Package

      Parameters

      Returns Promise<PackageDownloadPackageBytesResponse>

      Business applications can use this service API to download the document package in binary format. The package ID is provided in the resource URL. If the package contains only one document, the download is the binary PDF document. Alternatively, if the package has more than one document, the download is the binary zip file of all documents. The x-password and x-otp headers are optional. They are required if the document owner set them during the workflow creation phase.

    • Assign Document Field

      Parameters

      Returns Promise<EmptyResponse>

      Business applications can use this service API to assign users to input fields, e.g. signature fields, and hence define the signing order. The fields must already be present in the document and the users must be present in the workflow. The ID of the workflow document is provided in the resource URL, along with the package identifier. When recipients are in a workflow they are numbered, beginning at one and counting up for each extra one.Therefore, if there are three users in a workflow they are numbered "1", "2", and "3" respectfully.This API call allows you to assign a user by their workflow order number, to an input field on the document.

    • AutoPlace Fields

      Parameters

      Returns Promise<AutoPlaceFieldsResponse[]>

      Business applications can call this API to add signature or user defined form fields to a document based upon the search criterion supplied. The placement options are: to the left, to the right, top and bottom. The document is search and all instances of the search criteria met are processed. This allows you to add multiple fields with one call. For example, upload a document and automatically place a signature field to the right of all instances of the word "Sign here:". This saves time and ensures no signatures are missed from the workflow. The API call supports all types of fields; namely electronic, digital, in-person, initials, and text field etc. In addition, the API call supports the "order" variable.This means you can assign a set of signature fields automatically to a single user.Hence, the call can be repeated to place and assign signature fields to more than one user in the workflow. At least one user must exist in a workflow before signature fields can be added to the document in this way.The order number corresponds to the recipient in the workflow. Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. This API call can be used multiple times on the same document.The reason for doing so is to cater for multiple signatories on a document.The recipient or signatory is identified by the "order" variable passed in the call. See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

    • Finish Processing

      Parameters

      Returns Promise<EmptyResponse>

      Business applications can use this service API to finish the document processing after signing all the signature fields. This method is primarily used by native SigningHub mobile apps for iOS and Android, and mobile web use cases. General business applications employing tight integration into their respective portal do not need to call this method. However, when using the Sign Document API (and hence the user is not presented with a visual representation of the document they are requested to sign) calling this API is required in order to ensure the respective workflow continues or completes. For example, once all signatures have been applied using the "blind" Sign Document API call the document will not show as status "Completed" to the owner until this API is invoked. The document owner will see a status of "In Progress" until this API is called. Within native SigningHub mobile apps and mobile web use cases, this call is necessary to ensure that each user completes their respective actions with respect to SigningHub.For example, after a signatory has signed a document in SigningHub App, this method is invoked by the application to ensure the workflow continues to process and the next signatory is notified, and the document status is available via the configured call-back URL.

    • Get Contacts

      Parameters

      • recordPerPage: number
      • pageNo: number
      • contentType: string
      • accept: string
      • options: GetContactOptions = {}

      Returns Promise<ContactResponse[]>

      Business applications can use this service API to retieve contacts from both personal and enterprise contacts for the current user. It is possible to search based upon the criterion supplied under the "x-search-text" header.Furthermore, it is possible to search a user's specific contacts or that of the enterprise to which the user belongs. The search response information contains the user email address and respective user name.

    • Get Workflow User Authentication (Document Opening) of Enterprise Package

      Parameters

      Returns Promise<EnterpriseAccessResponse>

      Business applications can use this service API to get the access security settings enabled for the package. Recipients for whom the security is configured are identified by the order in the URL. Package ID is also identified in the request URL. Recipients will not be able to access document package outside the scope of this duration if the access security is enabled. Document owner can also configure authentication based security of the package for a recipient.

    • Get Packages

      Parameters

      Returns Promise<GetPackagesResponse[]>

      Business applications can use this service API to get a list of documents filtered by different statuses. Users can divide the records into pages by providing a number of records per page.

    • Get Templates

      Parameters

      Returns Promise<TemplateResponse[]>

      Business applications can use this service API to get list of templates for the current user. It is possible to search based upon the criterion supplied under the "x-search-text" header.Furthermore, it is possible to search a user's personal templates or the enterprise templates as allowed against their user role by their enterprise admin.

    • Get Workflow History

      Parameters

      Returns Promise<WorkflowHistoryResponse>

      Business applications can utilize this service API to retrieve the list of actions performed on a document. The package ID is provided in the resource URL. The search field (x-search-text header) is intended for email, document name, action, infokey, and infovalue.

    • Get Workflow Reminder

      Parameters

      Returns Promise<ReminderResponse>

      Business applications can use this service API to update the reminders for the recipients that has already been added to a workflow. Normally this call is useful after a template has been applied to a document and business applications want to override the reminders settings within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow recipient is identified by the order at which it is added to the workflow.

    • Bulk Sign Packages

      Parameters

      Returns Promise<BulkSignResponse>

      Business applications can use this API to sign/share/sign and share multiple documents (both electronic and digital) without displaying the documents to the end user. This API needs information from the business application about document packages and the details of signatures, in-person and initials fields. On the successful completion of bulk signing transaction, the API will return the statuses and transaction ids of the document packages. Unlike the Sign Document API, this API not only signs a document package but also marks it as approved and reviewed based on whether the recipient is a Signer, Editor or Reviewer. Any document package for which the status returns as COMPLETED has been signed, approved or reviewed by this API. Bulk Signing works with all the signing-time authentication methods. If SIGN is passed as bulk_action and package is in Draft state, Sign and Share will be performed automatically. You must call this API after the Pre Bulk Sign Documents API. In case you need to make changes in any of the document before signing, the Fill Form Fields API should be called before calling the Pre Bulk Sign Document API. Remember, any mandatory input fields on a document require completing before this API will successfully complete; whereas, the auto-populated fields (like Name, Email, Date, Job Title, etc.) will be automatically filled. The signatory is identified by the access token presented in the call. Therefore, authentication of the signatory is required prior to making this call. You cannot authenticate as an Enterprise Admin with the scope variable, and sign a document on behalf of a user. The access token must be issued to the signatory as a result of direct authentication. Once document is signed, the verification response can be seen from the Bulk Signing Status API. First or Second Factor OTP Usage for Authentication In case OTP authentication is turned on for the server side signing operation, the client applications will need to generate an OTP for the mobile number using the Bulk Sign Authentication via OTP API call. Respective business applications must retrieve the OTP from the use and submit it when making the API call. This is done using the "x-otp" header in the request.

    • Bulk Signing Status

      Parameters

      Returns Promise<BulkSignStatusResponse>

      Business applications can use this API to get the status of a specific bulk signing transaction along with the details of document packages that were processed by the Bulk Signing Packages API. You must call this API after the Bulk Signing Packages API. The signatory is identified by the access token presented in the call. Therefore, authentication of the signatory is required prior to making this call. You cannot authenticate as an Enterprise Admin with the scope variable, and sign a document on behalf of a user. The access token must be issued to the signatory as a result of direct authentication. For RAS signing, the ACTION property will be REMOTE_AUTHORIZATION_REQURIED and the STATUS property will be PENDING, indicating that the request needs to be authorized using the mobile device. If the signing process fails in some document due to different levels of assurance configured and the user wants to re-initiate the signing process to complete the signing process on failed documents, the ACTION property will be REINITIATE_SIGNING_PROCESS, and the STATUS property will be PENDING.

    • Sign Document

      Parameters

      Returns Promise<SignDocumentResponse>

      Business applications can use this service API to sign a document (both electronic and digital) without displaying the document to the end user using SigningHub. For example, a business application may have another method to display the document to the user, and only the signing functionality of SigningHub is required, or for bulk operations it may be justified to sign without requiring the user to view and approve every document individually. If there are changes to be saved in the document before signing, Fill Form Fields API should be called before calling the Sign Document API. Note any mandatory input fields on a document require completing before this API will successfully complete. The signatory is identified by the access token presented in the call.Therefore, authentication of the signatory is required prior to making this call.You cannot authenticate as an Enterprise Admin with the scope variable, and sign a document on behalf of a user.The access token must be issued to the signatory as a result of direct authentication. When this call completes it is important that if the signatory was the last signer for a document that the Finish Document API call is invoked.The reason is because without calling that API the document will remain in a status of "In Progress" to the document owner. Once the API has been called, the status will change to "Completed" for the document owner. Once document is signed, the verification response can be seen from Get Document Verification API. First or Second Factor OTP Usage for Authentication If OTP authentication is turned on for the server side signing operation, client applications will need to generate a OTP for the mobile number using Signer Authentication via OTP API call. Respective business applications must retrieve the OTP from the use and submit it when making the API call. This is done using the "x-otp" header in the request.

    • Share Document Package

      Parameters

      Returns Promise<StartWorkflowResponse[]>

      Business applications can use this service API to share a document package with the signers and start a new workflow. The document should already have been prepared by applying a template and optionally updating the users and actions defined in template. The package ID to be shared is provided in the resource URL.

    • Submit Document

      Parameters

      Returns Promise<EmptyResponse>

      One of the SigningHub roles is called "Editor". This allows a recipient to edit input fields on a document, but does not require a signature. Once completed the recipient submits their changes. The button used in the GUI is called "Submit". This is the equivalent operation for an editor to submit their changes via an API call. Click SigningHub Roles for a description of all available workflow recipient roles.

    • Update CheckBox Field

      Parameters

      Returns Promise<EmptyResponse>

      Business applications can use this service API to update a checkbox field of a document in a package. Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface. It's width and height cannot be updated. They will remain the same as when they were added.

    • Update Workflow User Authentication (Document Opening) of Enterprise Package

      Parameters

      Returns Promise<EmptyResponse>

      Business applications can use this service API to update the package authentications and access duration for the recipients. This API can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request

    • Update Initial Field

      Parameters

      Returns Promise<EmptyResponse>

      Business applications can use this service API to update an initials field of a document in a package. Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged. You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface.

    • Update In-person Field

      Parameters

      Returns Promise<EmptyResponse>

      Business applications can use this service API to update an in-person signature field of a document in a package. Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface.

    • Update RadioBox Field

      Parameters

      Returns Promise<EmptyResponse>

      Business applications can use this service API to update a radio button of a document in a package. Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface. It's width and height cannot be updated. They will remain the same as when they were added.

    • Update TextBox Field

      Parameters

      Returns Promise<EmptyResponse>

      Business applications can use this service API to update a text box of a document in a package. Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged. You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields. The latter can be used when a template was applied or the document was created using the GUI interface.

    • Update Placeholder

      Parameters

      Returns Promise<EmptyResponse>

      Business applications can use this service API to update a placeholder in the workflow. Normally this call is useful after a template has been applied to a document and business applications wants to override the details of a specific place holder within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow place holder is identified by the order at which it is added to the workflow. While XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"

    • Update Workflow Reminders

      Parameters

      Returns Promise<EmptyResponse>

      Business applications can use this service API to update the workflow reminders for a recipient that has already been added to a workflow. Normally this call is useful after a template has been applied to a document and business applications want to override the reminders settings within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow recipient is identified by the order at which it is added to the workflow.

    • Update Workflow User

      Parameters

      Returns Promise<UpdateCollaboratorResponse>

      Business applications can use this service API to update the details of a recipient, group or place holder who has already been added to a workflow. Normally this call is useful after a template has been applied to a document and business applications wants to override the details of a specific user within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow recipient is identified by the order at which it is added to the workflow. Note, while XML type document preparation, only supports role types "SIGNER", "REVIEWER" and "CARBON_COPY".

    • Add or Update Document from Library

      Parameters

      Returns Promise<UploadDocumentLibraryResponse>

      Business applications can use this service API to add a document from the user’s library to a package. Package ID is provided in the URL, the ID of the document should also be provided as “document_id” in the resource URL to identify the library document to be copied. Note a package must already exist before you can add a document using this call.

    • Upload Document

      Parameters

      Returns Promise<UploadDocument>

      Business applications can use this service API to add a document to a document package linked to an enterprise user’s account. The document information is sent in the HTTP request header and document bytes are sent in the HTTP request body. Note SigningHub will convert supported document formats to PDF if the header "x-convert-document" is set to a value of "true". The only case supported where this value is set to "false" is to retain Word format and XML documents. SigningHub supports a wide variety of document formats, each of which can be converted to PDF format upon upload.Click here for the full list. Note PDF documents are not altered upon upload to the system. Note a package must already exist before you can add a document using this call.

    • Apply Workflow Template

      Parameters

      Returns Promise<DocumentDetailsResponse>

      Business applications can use this service API to apply a workflow template to a document. The document ID on which template has to be applied is provided in the resource URL. When document ID is set to 0 then template will be applied to to all of the doucments in a pacakge. While applying the template it is important to remember these two important points: Point 1 - If the template being applied is created using a PDF which already contained form fields then ensure that the document on which this template is now being applied must contain these form fields in advance and SigningHub will NOT create those form fields via the template rather only apply the form data and assign to the respective users. Point 2 - If the template being applied is created where form fields are manually added (hence not present in the PDF originally) via SigningHub e.g. signature field, initial, in-person signature, check boxes, radio buttons, text fields etc. then on applying such a template, these form fields will be created on the target document even if these form fields were already present in the document.

    • Complete Workflow in the Middle (Terminate Workflow)

      Parameters

      Returns Promise<EmptyResponse>

      Business applications can mark the workflow completed even in the middle of the workflow. Use this service API to change the status of the workflow to completed. If there are recipients who have not signed the document yet. Their signature will not be required any more and they will not be able to see the document in their inbox any further. Bearer token should belong to document owner or enterprise admin can use scope variable to get the access token on behalf of document owner to perform this action.