CreateProcedureRequestDto Data Type

A Dto holding inputs to create a document signature procedure from OC side.

Implemented Interfaces
Serializable
Properties
name data type description
procedure SignProcedureDto Gets the procedure.
filesToSign array of SignFileRequestDto Gets the files to sign.
withInternalMember boolean Checks if is with internal member.
absolutePaths boolean

Example

{
  "procedure" : {
    "name" : "...",
    "description" : "...",
    "start" : true,
    "members" : [ {
      "fileObjects" : [ { }, { } ],
      "firstname" : "...",
      "lastname" : "...",
      "email" : "...",
      "phone" : "...",
      "user" : "...",
      "internal" : true,
      "id" : "..."
    }, {
      "fileObjects" : [ { }, { } ],
      "firstname" : "...",
      "lastname" : "...",
      "email" : "...",
      "phone" : "...",
      "user" : "...",
      "internal" : true,
      "id" : "..."
    } ],
    "config" : {
      "email" : {
        "property1" : [ { }, { } ],
        "property2" : [ { }, { } ]
      },
      "webhook" : {
        "property1" : [ { }, { } ],
        "property2" : [ { }, { } ]
      }
    },
    "id" : "..."
  },
  "filesToSign" : [ {
    "name" : "...",
    "filePath" : "...",
    "content" : "...",
    "id" : "...",
    "internalPage" : 12345,
    "externalPage" : 12345,
    "listExternalPositions" : [ {
      "position" : "...",
      "page" : 12345,
      "file" : "..."
    }, {
      "position" : "...",
      "page" : 12345,
      "file" : "..."
    } ],
    "position" : 12345
  }, {
    "name" : "...",
    "filePath" : "...",
    "content" : "...",
    "id" : "...",
    "internalPage" : 12345,
    "externalPage" : 12345,
    "listExternalPositions" : [ {
      "position" : "...",
      "page" : 12345,
      "file" : "..."
    }, {
      "position" : "...",
      "page" : 12345,
      "file" : "..."
    } ],
    "position" : 12345
  } ],
  "withInternalMember" : true,
  "absolutePaths" : true
}