Changelog

1.0.6

Feature

  • Release a new API:
    • POST /v1/sign_tasks/consent_file: consent to a task file and keep a record

Enhancement

  • Update task and template related APIs to support new parameters for Consent to File features.
    • Added new parameters stage_setting.viewable_references, reference_settings.force and reference_settings.viewable_in_processing to:
      • POST /open_api/v1/sign_tasks
      • PUT /open_api/v1/sign_tasks
      • POST /open_api/v1/sign_tasks/quick_create
      • PUT /open_api/v1/sign_tasks/settings
      • GET /open_api/v1/templates
      • POST /open_api/v1/templates
      • PUT /open_api/v1/templates
  • Update response to include new fields in StageSetting, TaskSetting and TemplateSetting for new features, affecting the following APIs:
    • Added new fields to:
      • GET /open_api/v1/sign_tasks/read

Deprecated

  • The completed_reference_settings key in TaskSetting and TemplateSetting in the request and response schema will be deprecated in the future. Please use the settings in reference_settings key instead.

1.0.5

Feature

  • Release a new API:
    • POST /v1/file_missions/renew: renew an existing mission to modify PDF files before updating a task or template

Enhancement

  • Update task and template related APIs to support new parameters for Modify Documents features.
    • Added new parameters file_mission_id to:
      • PUT /v1/sign_tasks
      • PUT /v1/templates
  • Update response to include new fields in FileMission for new features, affecting the following APIs:
    • Added new fields files to:
      • POST /v1/file_missions
      • GET /v1/file_missions

Deprecated

  • The upload_link key in FileMission in the response schema will be deprecated in the future. Please use the upload_link key within the new files key instead.

1.0.4

Enhancement

  • Update task and template related APIs to support new parameters for Task Editor and Document Viewing Permission features.
    • Added new parameters stage_type and viewable_source_files to:
      • POST /v1/sign_tasks
      • PUT /v1/sign_tasks
      • POST /v1/templates
      • PUT /v1/templates
    • Added new parameter viewable_source_files to:
      • PUT /v1/sign_tasks/settings
    • Added new option source_file for the file_types parameter in:
      • GET /v1/sign_tasks/download
      • PUT /v1/sign_tasks/download_link
  • Update response to include new fields in DummyStage, SignStage and StageSetting for new features, affecting the following APIs:
    • Added new fields stage_type and viewable_source_files to:
      • GET /v1/sign_tasks
      • GET /v1/sign_tasks/read
      • GET /v1/templates
    • Added new fields stage_type to:
      • GET /v1/sign_tasks/list
      • GET /v1/templates/list
    • Added new field source_file or new files in the .zip to:
      • GET /v1/sign_tasks/download
      • GET /v1/sign_tasks/download_link

1.0.3

Feature

  • Release more APIs, including:
    • GET /v1/groups: get group information
    • PUT /v1/groups/modify: update group information
    • PUT /v1/members/modify: update member information
    • GET /v1/sign_tasks/audit_trails: get the audit trails of the task
    • POST /v1/sign_tasks/review: review a task
    • POST /v1/sign_tasks/confirm: confirm a task
    • POST /v1/templates: create a template
    • PUT /v1/templates: update a template
  • Release more webhook events, including:
    • verified
    • viewed
    • review_verified
    • review_passed
    • review_rejected
    • confirm_verified
    • confirmed

Enhancement

  • Update task and template related APIs to include new fields in the response for new features and enhanced usability, including:
    • GET /v1/sign_tasks
    • GET /v1/sign_tasks/read
    • GET /v1/templates
    • GET /v1/templates/list
  • Update GET /v1/members to include lang field in the response
  • Update POST /v1/sign_tasks and PUT /v1/sign_tasks.
    • add validation for the length of attachment_settings
    • add validation to check for duplicate field_object_ids in field_settings
  • Refactor response schema for DummyStage, SignStage, SignTask, and Template, which affect APIs including:
    • GET /v1/sign_tasks
    • GET /v1/sign_tasks/list
    • GET /v1/sign_tasks/read
    • GET /v1/templates
    • GET /v1/templates/list

Breaking Changes (IMPORTANT!!)

To standardize API schema and enhance data privacy, the following breaking changes have been made:

  • Update POST /v1/sign_tasks/sign.
    • include only task_id in the response
  • Refactor access_info fields, which affect APIs including GET /v1/sign_tasks, GET /v1/sign_tasks/list, and GET /v1/sign_tasks/read.
    • remove manage_tags
    • rename download_attachment to download_attachments
    • rename download_source_file to download_source_files
  • Refactor fields bwtween APIs that retrieve list of objects and APIs that retrieve a single object.
    • remove thumbnail field in GET /v1/sign_tasks/list; use GET /v1/sign_tasks instead
  • Remove sensitive fields from APIs which can be accessed without auditing and identity verification.
    • remove verify_methods field from the stage object in GET /v1/sign_tasks

1.0.2

Feature

  • Release more APIs, including:
    • POST /v1/file_missions: create a mission to merge multiple PDF files before creating a task
    • GET /v1/file_missions: get a file mission
    • POST /v1/groups/seals: create and upload a seal
    • GET /v1/groups/seals/list: get group seal list
    • GET /v1/members: get member information
    • POST /v1/members/signatures: create and upload a signature
    • DELETE /v1/members/signatures: delete a signature
    • GET /v1/members/signatures/list: get member's signature list
    • GET /v1/sign_tasks/read: get task details before signing
    • POST /v1/sign_tasks/consent: consent to quick sign
    • POST /v1/sign_tasks/images: upload an image before filling in the fields
    • POST /v1/sign_tasks/sign: sign a task

Enhancement

  • Update the following APIs to allow searching tasks using these parameters: field_key, field_value, metadata_key, metadata_value, file_name, signer
    • ​​​​​​​​​​​​​​​​​​​​​GET /v1/groups/sign_tasks/list
    • GET /v1/sign_tasks/list
  • Update the following APIs to allow quick signers authenticated via the Code header:
    • GET /v1/sign_tasks/download
    • GET /v1/sign_tasks/download_link
    • PATCH /v1/sign_tasks/signer
  • Update POST /v1/sign_tasks.
    • add file_mission_id in request payload to allow creating a task with multiple PDF files

1.0.1

Feature

  • Release more APIs, including:
    • PUT /v1/sign_tasks: update a task
    • PUT /v1/sign_tasks/settings: update settings of a task
    • PATCH /v1/sign_tasks/signer: change a signer of a task
    • POST /v1/sign_tasks/archive: archive a task
    • GET /v1/sign_tasks/archived_list: get archived task list
    • POST /v1/sign_tasks/unarchive: unarchive a task
    • POST /v1/sign_tasks/discard: discard a task
    • GET /v1/sign_tasks/discarded_list: get discarded list
    • POST /v1/sign_tasks/restore: restore a task
    • POST /v1/sign_tasks/resend: resend a task
    • POST /v1/sign_tasks/save_template: save a task to a template
    • POST /v1/public_forms: create a public form
    • PUT /v1/public_forms: update a public form
    • GET /v1/public_forms/list: get public form list
    • GET /v1/public_forms: get a public form
    • DELETE /v1/public_forms: delete a public form
    • PUT /v1/public_forms/status: update a public form status
    • GET /v1/public_forms/download_csv: download the CSV of public form
    • DELETE /v1/templates: delete a template
    • POST /v1/templates/duplicate: duplicate a template

Enhancement

  • Update GET /v1/sign_tasks/share_link:
    • bundle multiple tasks into one link
  • Update Guides and API Reference documentation for ease of integration.

1.0.0

DottedSign API First Release!