Developer Docs
Dock
Technical Changelog
Version 1.1.16

API Doc Version 1.1.16

What's New

POST /documents/export

Export template in the specified document content type

POST /documents/word/export-in-word-async

Export In Word

POST /documents/process-dock-request

Process Dock Request

GET /documents/retrieve-request-status

Get Request Status

POST /documents/configuration/download-artifact

Download Artifact

GET /documents/configuration/template/key_id

Retrieve Templates by key_id

GET /documents/configuration/template/tenant_id

Retrieve Templates by tenant_id

GET /documents/configuration/all/template

Get All Template Configurations

DELETE /documents/configuration/templates/{template_id}

Delete a Template Record

POST /documents/configuration/upload-file-on-local

Upload File On Local

GET /documents/configuration/get-file-from-local

Get File From Local

POST /documents/configuration/generate-presigned-url

Generate Presigned URL

GET /documents/configuration/events

Get all events

GET /documents/configuration/document-notification-bookmarks

Get bookmarks against event name

GET /documents/configuration/get_documents_against_type

Get documents against type

What's Deleted

PATCH /documents/configuration/template/update-by-name/{template_name}

Update Template Configuration

GET /documents/configuration/template/

Get All Template Configurations

What's Deprecated

POST /documents/word/plan/export-repayment-plan-in-word

Export Repayment Plan In Word

What's Changed

POST /documents/word/plan/export-repayment-plan-in-word

POST /documents/word/export-in-word

Parameters:

Added: version in header

Template Version

Request:

Changed content type : application/json

New required properties:

  • template_name
  • template_type

  • Added property template_name (string)

    Template Name

  • Added property broker_id (string)

    Broker Id to get specific broker template

  • Added property download_template (boolean)

    If false open Generated Document in new tab

  • Deleted property tenant_id (string)

    Tenant Id

  • Deleted property generated_doc_content_type (string)

    The Generated Document Content Type

  • Changed property generate_base64 (boolean)

    The Generated Base64 of Document

POST /documents/pdf/export-in-pdf

Request:

Changed content type : application/json

New optional properties:

  • template_url_or_base64_string

  • Added property template_type (string)

    Template Type

  • Added property broker_id (string)

    Broker Id to get specific broker template

  • Added property signature_placeholders (array)

    Items (object):

    • Property image (string)

      Image Url or Base64 String

    • Property page_number (string)

      Relavant signature page number

    • Property x0 (integer)

      Signature x0:coordinate

    • Property x1 (integer)

      Signature x1:coordinate

    • Property y0 (integer)

      Signature y0:coordinate

    • Property y1 (integer)

      Signature y1:coordinate

    • Property signature_rect_position (string)

      Specify signature rect starting position top or bottom

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property template_rendered_html (string)

      Generated Document Html String

    • Added property image_metadata (object)

      Image Metadata (Placeholder Name,Coordinates,Page Number,Page Size)

GET /documents/list/{template_name}

POST /documents/configuration/upload-file

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property template_rendered_html (string)

      Generated Document Html String

    • Added property image_metadata (object)

      Image Metadata (Placeholder Name,Coordinates,Page Number,Page Size)

POST /documents/configuration/upload-file-as-base64

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property template_rendered_html (string)

      Generated Document Html String

    • Added property image_metadata (object)

      Image Metadata (Placeholder Name,Coordinates,Page Number,Page Size)

GET /documents/configuration/get-file-by-key/{key}

POST /documents/configuration/get-file-by-tag

POST /documents/configuration/convert-file-to-base64

POST /documents/configuration/get-file-info

POST /documents/configuration/storage/s3/create-s3-configuration

GET /documents/configuration/storage/s3/get-s3-configuration/{tenant_id}

PATCH /documents/configuration/storage/s3/update-s3-Configuration

POST /documents/configuration/template/

Create or Update Template Configurations

Request:

Changed content type : application/json

New required properties:

  • template_type

  • Added property template_type (string)

  • Added property template_html (string)

  • Added property broker_id (integer)

Return Type:

New response : 200 OK

Successful Response

Deleted response : 201 Created

Successful Response

GET /documents/configuration/template/get-by-name/{template_name}

POST /documents/configuration/template/get-base64-template

POST /documents/pdf/export-merged-pdf

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property template_rendered_html (string)

      Generated Document Html String

    • Added property image_metadata (object)

      Image Metadata (Placeholder Name,Coordinates,Page Number,Page Size)

Version 1.1.17Version 1.1.15