{"swagger":"2.0","info":{"version":"v6","title":"eSignAnywhere.Api V6","description":"<p>Before you use the API, we recommend you to read the <a href=\"https://service.esignanywhere.net/help#Swagger%2fApiDocumentation\">eSignAnyWhere API concept<\/a>, to get an overview about our programming interface, data types and basic concepts.<\/p><h2>General Concepts<\/h2><ul><li>The application includes user authentication on application level. Therefore, it is required to provide credentials for authorization:<\/li><ul><li>Api token or<\/li><li>Bearer token<\/li><\/ul><p>We recommend to create different API keys for different application integrations, to avoid configuring the samekey in various integration systems.This allows, e.g. in case of sharing a key by mistake, to disable one key while keeping other integrations working with their existing configuration.You can find the settings for the credentials for authorization in your <strong>Settings-&gt;Api Tokens andApps<\/strong>.<\/p><p><strong>Note: <\/strong> The ApiToken must be set as header either as apiToken header or bearer token header.<\/p><li>On status change, our back-end notifies integrations by calling an HTTP(S) endpoint as a callback.<\/li><li>Error handling:<br><ol><li>HTTP 40x for handled errors<br><ul><li>In a HTTP 40x we return an error code and an error info<\/li><\/ul><\/li><li>or HTTP 500 for generic server errors<\/li><\/ol><\/li><li>Callbacks<br><ol><li>Envelope callbacks: This is the basic callback which is fired if the envelope reaches a final state<\/li><li>Envelope status callback: Is fired, based on envelope events/actions<\/li><li>Draft callback: Is fired, if a draft is used or deleted<\/li><\/ol><\/li><\/ul><p>More details about those topics are documented in our online resources:<\/p><p><a href=\"https://service.esignanywhere.net/help#Swagger%2fApiDocumentation\">eSignAnyWhere API concept<\/a><\/p>"},"host":"","basePath":"/api","schemes":["https"],"paths":{"/v6/authorization/whoami":{"get":{"tags":["Authorization"],"summary":"Get information about the authenticated user.","operationId":"Authorization_WhoAmI","consumes":[],"produces":["application/json","text/json"],"parameters":[],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AuthorizationWhoAmIResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/authorization/validate":{"get":{"tags":["Authorization"],"summary":"Check if the authenticated user is authorized to use the API.","operationId":"Authorization_Validate","consumes":[],"produces":["application/json","text/json"],"parameters":[],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/organization/automaticprofile":{"get":{"tags":["AutomaticProfile"],"summary":"Get the available automatic signing profiles.","operationId":"AutomaticProfile_GetAll","consumes":[],"produces":["application/json","text/json"],"parameters":[],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AutomaticProfileGetAllResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/draft/{draftId}":{"get":{"tags":["Draft"],"summary":"Get an overview of a draft.","operationId":"Draft_Get","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"draftId","in":"path","description":"The identifier of the draft.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DraftGetResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/draft/{draftId}/files":{"get":{"tags":["Draft"],"summary":"Get the documents of a draft.","operationId":"Draft_GetFiles","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"draftId","in":"path","description":"The identifier of the draft.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DraftGetFilesResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/draft/{draftId}/elements":{"get":{"tags":["Draft"],"summary":"Get the elements belonging to the documents of a draft.","operationId":"Draft_GetElements","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"draftId","in":"path","description":"The identifier of the draft.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DraftGetElementsResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/draft/{draftId}/configuration":{"get":{"tags":["Draft"],"summary":"Get the configuration of a draft and its activities.","operationId":"Draft_GetConfiguration","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"draftId","in":"path","description":"The identifier of the draft.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DraftGetConfigurationResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/draft/find":{"post":{"tags":["Draft"],"summary":"Get basic information about drafts which match your filter criteria.","operationId":"Draft_Find","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"findRequest","in":"body","description":"The filter criteria.","required":true,"schema":{"$ref":"#/definitions/DraftFindRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DraftFindResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/draft/send":{"post":{"tags":["Draft"],"summary":"Send a draft.","operationId":"Draft_SendDraft","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"sendDraftRequest","in":"body","description":"The model containing the send options.","required":true,"schema":{"$ref":"#/definitions/DraftSendRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DraftSendResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/draft/create":{"post":{"tags":["Draft"],"summary":"Create a new draft.","operationId":"Draft_Create","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"createRequest","in":"body","description":"The definition of the draft.","required":true,"schema":{"$ref":"#/definitions/DraftCreateRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DraftCreateResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/draft/delete":{"post":{"tags":["Draft"],"summary":"Delete a draft.","operationId":"Draft_Delete","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"deleteRequest","in":"body","description":"The identifier of the draft.","required":true,"schema":{"$ref":"#/definitions/DraftDeleteRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Void"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/draft/update":{"post":{"tags":["Draft"],"summary":"Update the configuration of the draft.","operationId":"Draft_Update","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"updateRequest","in":"body","description":"The model containing the requested changes.","required":true,"schema":{"$ref":"#/definitions/DraftUpdateRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Void"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/draft/reorderactivities":{"post":{"tags":["Draft"],"summary":"Reorder the activities of a draft.","operationId":"Draft_ReorderActivities","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"reorderActivitiesRequest","in":"body","description":"The new order of all the activities.","required":true,"schema":{"$ref":"#/definitions/DraftReorderActivitiesRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Void"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/draft/activity/replace":{"post":{"tags":["DraftActivity"],"summary":"Replace an existing activity of a draft with a new one.","operationId":"DraftActivity_Replace","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"replaceRequest","in":"body","description":"The definition of the new activity.","required":true,"schema":{"$ref":"#/definitions/DraftActivityReplaceRequest"}}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelope/{envelopeId}":{"get":{"tags":["Envelope"],"summary":"Get an overview of an envelope.","operationId":"Envelope_Get","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"envelopeId","in":"path","description":"The identifier of the envelope.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EnvelopeGetResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelope/{envelopeId}/files":{"get":{"tags":["Envelope"],"summary":"Get the documents and related files of an envelope.","operationId":"Envelope_GetFiles","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"envelopeId","in":"path","description":"The identifier of the envelope.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EnvelopeGetFilesResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelope/{envelopeId}/history":{"get":{"tags":["Envelope"],"summary":"Get the event history of an envelope","operationId":"Envelope_GetHistory","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"envelopeId","in":"path","description":"The identifier of the envelope.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EnvelopeGetHistoryResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelope/{envelopeId}/elements":{"get":{"tags":["Envelope"],"summary":"Get the elements belonging to the documents of an envelope.","operationId":"Envelope_GetElements","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"envelopeId","in":"path","description":"The identifier of the envelope.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EnvelopeGetElementsResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelope/{envelopeId}/viewerlinks":{"get":{"tags":["Envelope"],"summary":"Get the available links to access the SignAnyWhere Viewer for active activities.","operationId":"Envelope_GetViewerLinks","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"envelopeId","in":"path","description":"The identifier of the envelope.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EnvelopeGetViewerLinksResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelope/{envelopeId}/configuration":{"get":{"tags":["Envelope"],"summary":"Get the configuration of an envelope and its activities.","operationId":"Envelope_GetConfiguration","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"envelopeId","in":"path","description":"The identifier of the envelope.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EnvelopeGetConfigurationResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelope/find":{"post":{"tags":["Envelope"],"operationId":"Envelope_Find","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"findRequest","in":"body","required":true,"schema":{"$ref":"#/definitions/EnvelopeFindRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EnvelopeFindResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelope/send":{"post":{"tags":["Envelope"],"summary":"Create and send an envelope.","operationId":"Envelope_Send","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"sendRequest","in":"body","description":"The definition of the envelope.","required":true,"schema":{"$ref":"#/definitions/EnvelopeSendRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EnvelopeSendResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelope/cancel":{"post":{"tags":["Envelope"],"summary":"Cancel an active envelope.","operationId":"Envelope_Cancel","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"cancelRequest","in":"body","description":"The model containing the cancel options.","required":true,"schema":{"$ref":"#/definitions/EnvelopeCancelRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Void"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelope/delete":{"post":{"tags":["Envelope"],"summary":"Delete an envelope.","operationId":"Envelope_Delete","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"deleteRequest","in":"body","description":"The model containing the delete options.","required":true,"schema":{"$ref":"#/definitions/EnvelopeDeleteRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Void"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelope/remind":{"post":{"tags":["Envelope"],"summary":"Send a reminder to active activities.","operationId":"Envelope_Remind","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"remindRequest","in":"body","description":"The model containing the remind options.","required":true,"schema":{"$ref":"#/definitions/EnvelopeRemindRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EnvelopeRemindResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelope/unlock":{"post":{"tags":["Envelope"],"summary":"Unlock an envelope which is locked due to a started parallel activity.","operationId":"Envelope_Unlock","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"unlockRequest","in":"body","description":"The model containing the unlock options.","required":true,"schema":{"$ref":"#/definitions/EnvelopeUnlockRequest"}}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelope/restartexpired":{"post":{"tags":["Envelope"],"summary":"Restart an expired envelope.","operationId":"Envelope_RestartExpired","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"restartRequest","in":"body","description":"The model containing the restart options.","required":true,"schema":{"$ref":"#/definitions/EnvelopeRestartExpiredRequest"}}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelope/activity/delete":{"post":{"tags":["EnvelopeActivity"],"summary":"Delete an unfinished activity of an active envelope.","operationId":"EnvelopeActivity_Delete","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"deleteRequest","in":"body","description":"The model containing the delete options.","required":true,"schema":{"$ref":"#/definitions/EnvelopeActivityDeleteRequest"}}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelope/activity/replace":{"post":{"tags":["EnvelopeActivity"],"summary":"Replace an unfinished activity of an active envelope with a new one.","operationId":"EnvelopeActivity_Replace","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"replaceRequest","in":"body","description":"The definition of the new activity.","required":true,"schema":{"$ref":"#/definitions/EnvelopeActivityReplaceRequest"}}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelopebulk/{bulkId}":{"get":{"tags":["EnvelopeBulk"],"summary":"Get an overview of an envelope bulk and its children.","operationId":"EnvelopeBulk_Get","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"bulkId","in":"path","description":"The identifier of the envelope bulk.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EnvelopeBulkGetResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelopebulk/find":{"post":{"tags":["EnvelopeBulk"],"summary":"Get basic information about envelope bulks which match your filter criteria.","operationId":"EnvelopeBulk_Find","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"findRequest","in":"body","description":"The filter criteria.","required":true,"schema":{"$ref":"#/definitions/EnvelopeBulkFindRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EnvelopeBulkFindResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelopebulk/send":{"post":{"tags":["EnvelopeBulk"],"summary":"Create and send an envelope bulk.","operationId":"EnvelopeBulk_Send","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"sendRequest","in":"body","description":"The definition of the envelope bulk.","required":true,"schema":{"$ref":"#/definitions/EnvelopeBulkSendRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EnvelopeBulkSendResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelopebulk/cancel":{"post":{"tags":["EnvelopeBulk"],"summary":"Cancel all active BulkChild envelopes.","operationId":"EnvelopeBulk_Cancel","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"cancelRequest","in":"body","description":"The model containing the cancel options.","required":true,"schema":{"$ref":"#/definitions/EnvelopeBulkCancelRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Void"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelopebulk/delete":{"post":{"tags":["EnvelopeBulk"],"summary":"Delete an envelope bulk and its children.","operationId":"EnvelopeBulk_Delete","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"deleteRequest","in":"body","description":"The model containing the delete options.","required":true,"schema":{"$ref":"#/definitions/EnvelopeBulkDeleteRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Void"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelopebulk/remind":{"post":{"tags":["EnvelopeBulk"],"summary":"Send a reminder to active activities of all BulkChild envelopes.","operationId":"EnvelopeBulk_Remind","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"remindRequest","in":"body","description":"The model containing the remind options.","required":true,"schema":{"$ref":"#/definitions/EnvelopeBulkRemindRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EnvelopeBulkRemindResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/envelopebulk/restartexpired":{"post":{"tags":["EnvelopeBulk"],"summary":"Restart all expired BulkChild envelopes.","operationId":"EnvelopeBulk_RestartExpired","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"restartRequest","in":"body","description":"The model containing the restart options.","required":true,"schema":{"$ref":"#/definitions/EnvelopeBulkRestartExpiredRequest"}}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/file/{fileId}":{"get":{"tags":["File"],"summary":"Download a file belonging to a completed envelope.","operationId":"File_DownloadCompleted","consumes":[],"produces":["application/octet-stream","text/json","application/json"],"parameters":[{"name":"fileId","in":"path","description":"The identifier of the file.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"file"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/file/delete":{"post":{"tags":["File"],"summary":"Delete an uploaded file.","operationId":"File_Delete","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"deleteRequest","in":"body","description":"The model containing the delete options.","required":true,"schema":{"$ref":"#/definitions/FileDeleteRequest"}}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/file/upload":{"post":{"tags":["File"],"summary":"Upload a file for temporary use.","operationId":"File_Upload","consumes":["multipart/form-data"],"produces":["application/json","text/json"],"parameters":[{"name":"File","in":"formData","description":"Upload a file which is later-on referenced in other API calls by its fileId (e.g. documents of an envelope). Supported file types: PDF (by default), or other formats which can be converted to PDF (docx and others) in case the (optional) document converter is installed and configured. File content might be validated server-side by a FileContentValidationPlugin.","required":true,"type":"file"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FileUploadResponse"}},"400":{"description":"HTTP 400: Bad Request. E.g. a HTTP 400 with error information ERR0067 will be thrown when trying to upload a file format not supported, or rejected by the FileContentValidationPlugin.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"415":{"description":"UnsupportedMediaType","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/file/prepare":{"post":{"tags":["File"],"summary":"Prepare uploaded files by extracting contained elements, advanced document tags and SigStrings.","operationId":"File_Prepare","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"prepareRequest","in":"body","description":"The model containing the prepare options.","required":true,"schema":{"$ref":"#/definitions/FilePrepareRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FilePrepareResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/organization/license":{"get":{"tags":["License"],"summary":"Get information about the current license status.","operationId":"License_Get","consumes":[],"produces":["application/json","text/json"],"parameters":[],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LicenseGetResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/organization/sealingcertificates":{"get":{"tags":["SealingCertificate"],"summary":"Get the available sealing certificates.","operationId":"SealingCertificate_GetAll","consumes":[],"produces":["application/json","text/json"],"parameters":[],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SealingCertificateGetAllResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/system/version":{"get":{"tags":["System"],"summary":"Get the current version of eSignAnyWhere.","operationId":"System_Version","consumes":[],"produces":["application/json","text/json"],"parameters":[],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"}},"security":[{"apiToken":[]}]}},"/v6/organization/team":{"get":{"tags":["Team"],"summary":"Get the available teams.","operationId":"Team_Get","consumes":[],"produces":["application/json","text/json"],"parameters":[],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TeamGetAllResponse"},"examples":{"application/json":{"Teams":[{"Name":"Example Team","ShareEnvelopes":false,"ShareTemplates":false,"Head":{"Email":"teamlead@team.com","Members":[{"Email":"member@team.com"},{"Email":"teamleader@subteam.com","Members":[{"Email":"member@subteam.com"}]}]}}]}}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/organization/team/replace":{"post":{"tags":["Team"],"summary":"Replace all existing teams with the provided teams.","operationId":"Team_Replace","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"replaceRequest","in":"body","description":"The model containing the new teams.","required":true,"schema":{"$ref":"#/definitions/TeamReplaceRequest"}}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/template/{templateId}":{"get":{"tags":["Template"],"summary":"Get an overview of a template.","operationId":"Template_GetTemplateById","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"templateId","in":"path","description":"The identifier of the template.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TemplateGetResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/template/{templateId}/files":{"get":{"tags":["Template"],"summary":"Get the documents of a template.","operationId":"Template_GetFiles","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"templateId","in":"path","description":"The identifier of the template.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TemplateGetFilesResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/template/{templateId}/elements":{"get":{"tags":["Template"],"summary":"Get the elements belonging to the documents of a template.","operationId":"Template_GetElements","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"templateId","in":"path","description":"The identifier of the template.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TemplateGetElementsResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/template/{templateId}/configuration":{"get":{"tags":["Template"],"summary":"Get the configuration of a template and its activities.","operationId":"Template_GetConfiguration","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"templateId","in":"path","description":"The identifier of the template.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TemplateGetConfigurationResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/template/find":{"post":{"tags":["Template"],"summary":"Get basic information about templates which match your filter criteria.","operationId":"Template_Find","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"findRequest","in":"body","description":"The filter criteria.","required":true,"schema":{"$ref":"#/definitions/TemplateFindRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TemplateFindResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}},"/v6/template/createdraft":{"post":{"tags":["Template"],"summary":"Create a new draft from a template.","operationId":"Template_CreateDraft","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"createDraftRequest","in":"body","description":"The model containing the create options.","required":true,"schema":{"$ref":"#/definitions/TemplateCreateDraftRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TemplateCreateDraftResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apiToken":[]}]}}},"definitions":{"AuthorizationWhoAmIResponse":{"description":"The response model describing the current api user.","type":"object","properties":{"UserId":{"description":"The identifier of the user.","type":"string"},"Email":{"description":"The email address of the user.","type":"string"},"GivenName":{"description":"The given name of the user.","type":"string"},"Surname":{"description":"The surname of the user.","type":"string"},"UserName":{"description":"The user name for synchronizing with an external user provider.","type":"string"},"Sid":{"description":"The security identifier for synchronizing an external user provider.","type":"string"},"SamlAssignments":{"description":"The SAML providers available for login.","type":"array","items":{"$ref":"#/definitions/AuthorizationWhoAmISamlAssignment"}},"OAuthAssignments":{"description":"The names of the OAuth providers available for login.","type":"array","items":{"type":"string"}},"Roles":{"description":"The roles assigned to the user.","type":"array","items":{"type":"string"}}}},"AuthorizationWhoAmISamlAssignment":{"description":"The information about the SAML assignment.","type":"object","properties":{"ProviderName":{"description":"The name of the SAML provider.","type":"string"},"IdentificationValue":{"description":"The value to map from a SAML response to this user.","type":"string"}}},"ErrorResponse":{"description":"Error object that is returned when the api call was not processed successfully.","type":"object","properties":{"ErrorId":{"description":"Id of the error.","type":"string"},"Message":{"description":"Message from the error.","type":"string"},"TraceId":{"description":"Trace identifier.","type":"string"}}},"AutomaticProfileGetAllResponse":{"description":"The response model for retrieving the available profiles for automatic signing.","type":"object","properties":{"RemoteCertificateProfiles":{"description":"The remote certificate profiles available for automatic signing.","type":"array","items":{"$ref":"#/definitions/AutomaticProfileGetAllProfile"}},"SignaturePlugins":{"description":"The signature plugins available for automatic signing.","type":"array","items":{"$ref":"#/definitions/AutomaticProfileGetAllSignaturePluginDefinition"}}}},"AutomaticProfileGetAllProfile":{"description":"The information about the automatic signing profile.","type":"object","properties":{"Id":{"description":"The identifier of the profile.","type":"string"},"Description":{"description":"The unique description of the profile.","type":"string"}}},"AutomaticProfileGetAllSignaturePluginDefinition":{"description":"The information about the signature plugins available for automatic signing.","type":"object","properties":{"PluginId":{"description":"The identifier of the signature plugin.","type":"string"},"Profiles":{"description":"The profiles available for automatic signing.","type":"array","items":{"$ref":"#/definitions/AutomaticProfileGetAllProfile"}}}},"DraftGetResponse":{"description":"The response model for requesting the draft overview.","type":"object","properties":{"Id":{"description":"The identifier of the draft.","type":"string"},"Name":{"description":"The name of the draft.","type":"string"},"CreationDate":{"format":"date","description":"Date of creation.","type":"string"},"Activities":{"description":"The activities of the draft.","type":"array","items":{"$ref":"#/definitions/DraftGetActivity"}}}},"DraftGetActivity":{"description":"An activity of a draft.","type":"object","properties":{"Id":{"description":"The identifier of the activity.","type":"string"},"PlaceholderLabel":{"description":"The label of a sign placeholder.","type":"string"},"Action":{"$ref":"#/definitions/DraftGetAction","description":"The action assigned to the activity."}}},"DraftGetAction":{"description":"The action of the activity with the possibility of a defined bulk.","type":"object","properties":{"SendCopy":{"$ref":"#/definitions/DraftGetSendCopy","description":"The definition of the copy action."},"SignBulk":{"$ref":"#/definitions/DraftGetSignBulk","description":"The definition of the bulk."},"SignAutomatic":{"$ref":"#/definitions/DraftGetSignAutomatic","description":"The definition of the automatic sign action."},"Sign":{"$ref":"#/definitions/DraftGetSign","description":"The definition of the sign action."},"View":{"$ref":"#/definitions/DraftGetView","description":"The definition of the view action."},"SignAsP7M":{"$ref":"#/definitions/DraftGetSignAsP7M","description":"The definition of the P7M sign action."}}},"DraftGetSendCopy":{"description":"An action to send a copy of the documents to the recipient.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/DraftGetContactInformation","description":"The contact information of the recipient."},"CopyingGroup":{"format":"int32","description":"The parallel group for copy actions.","type":"integer"}}},"DraftGetSignBulk":{"description":"An action for signing for multiple recipients.","type":"object","properties":{"RecipientConfigurations":{"description":"The contact information of the recipients.","type":"array","items":{"$ref":"#/definitions/DraftGetAdvancedRecipientConfiguration"}}}},"DraftGetSignAutomatic":{"description":"An automatic signing action.","type":"object","properties":{"ProfileId":{"description":"The identifier of the profile for the automatic signatures.","type":"string"},"RenderingLanguageCode":{"description":"The rendering language for the automatic signatures.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string"}}},"DraftGetSign":{"description":"An action to sign documents.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/DraftGetContactInformation","description":"The contact information of the recipient."},"SigningGroup":{"format":"int32","description":"The parallel group for sign actions.","type":"integer"}}},"DraftGetView":{"description":"An action to view and acknowledge the documents.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/DraftGetContactInformation","description":"The contact information of the recipient."},"ViewingGroup":{"format":"int32","description":"The parallel group for view actions.","type":"integer"}}},"DraftGetSignAsP7M":{"description":"An action to sign documents with P7M.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/DraftGetContactInformation","description":"The contact information of the recipient."},"SignAsP7MGroup":{"format":"int32","description":"The parallel group for P7M actions.","type":"integer"}}},"DraftGetContactInformation":{"description":"Defines the contact information for the recipient.","type":"object","properties":{"Email":{"description":"The email address of the recipient.","type":"string"},"GivenName":{"description":"The given name of the recipient.","type":"string"},"Surname":{"description":"The surname of the recipient.","type":"string"},"PhoneNumber":{"description":"The phone number of the recipient.","type":"string"},"LanguageCode":{"description":"The language of the recipient.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string","x-ms-enum":{"name":"LanguageCode","modelAsString":false}}}},"DraftGetAdvancedRecipientConfiguration":{"description":"An action with contact information for the recipient.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/DraftGetContactInformation","description":"The contact information of the recipient."}}},"DraftGetFilesResponse":{"description":"The response model for requesting files of a draft.","type":"object","properties":{"Documents":{"description":"The documents.","type":"array","items":{"$ref":"#/definitions/DraftGetFilesDocument"}}}},"DraftGetFilesDocument":{"description":"The basic information about a document.","type":"object","properties":{"FileName":{"description":"The name of the file.","type":"string"},"PageCount":{"format":"int32","description":"The number of pages.","type":"integer"},"Pages":{"description":"The pages of the document.","type":"array","items":{"$ref":"#/definitions/DraftGetFilesPage"}},"DocumentNumber":{"format":"int32","description":"The reference number of the document. It starts with 1.","type":"integer"}}},"DraftGetFilesPage":{"description":"The information about a page of a document.","type":"object","properties":{"PageNumber":{"format":"int32","description":"The number of the page. It starts with 1.","type":"integer"},"Width":{"format":"double","description":"The width of the page in points.","type":"number"},"Height":{"format":"double","description":"The height of the page in points.","type":"number"}}},"DraftGetElementsResponse":{"description":"The response model for requesting document elements of a draft or template.","type":"object","properties":{"UnassignedElements":{"$ref":"#/definitions/DraftGetElementsElements","description":"The elements which are not assigned to any action."},"Activities":{"description":"The steps for the envelope.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsActivity"}}}},"DraftGetElementsElements":{"description":"The configurable elements of the documents.","type":"object","properties":{"TextBoxes":{"description":"The text boxes.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsTextBox"}},"CheckBoxes":{"description":"The check boxes.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsCheckBox"}},"ComboBoxes":{"description":"The combo boxes.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsComboBox"}},"RadioButtons":{"description":"The radio buttons.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsRadioButtonGroup"}},"ListBoxes":{"description":"The list boxes.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsListBox"}},"Signatures":{"description":"The signatures.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsSignatureField"}},"Attachments":{"description":"The attachments.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsAttachment"}},"PredefinedFieldElements":{"$ref":"#/definitions/DraftGetElementsPredefinedFieldElements","description":"The predefined field elements."},"LinkConfiguration":{"$ref":"#/definitions/DraftGetElementsLinkConfiguration","description":"The links in the documents."},"AreaReadConfirmations":{"description":"The areas which have to be read.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsReadAreaConfirmation"}},"PageReadConfirmations":{"description":"The pages which have to be read.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsReadPagesConfirmation"}},"DocumentReadConfirmations":{"description":"The documents which have to be read.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsReadDocumentConfirmation"}}}},"DraftGetElementsActivity":{"description":"Defines an activity in the process.","type":"object","properties":{"Id":{"description":"The identifier of the activity.","type":"string"},"Action":{"$ref":"#/definitions/DraftGetElementsAction","description":"The action assigned to the activity."}}},"DraftGetElementsTextBox":{"description":"The configuration of the text box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"Value":{"description":"The value of the text box.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"Validation":{"$ref":"#/definitions/DraftGetElementsFieldValidation","description":"The configuration of the validation rules for the text box value."},"FieldDefinition":{"$ref":"#/definitions/DraftGetElementsTextBoxDefinition","description":"The definition of the text box."}}},"DraftGetElementsCheckBox":{"description":"The configuration of the check box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"IsChecked":{"description":"If true, the check box is checked.","type":"boolean"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftGetElementsCheckBoxDefinition","description":"The definition of the check box."}}},"DraftGetElementsComboBox":{"description":"The configuration of the combo box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"Value":{"description":"The selected value of the combo box.","type":"string"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftGetElementsComboBoxDefinition","description":"The definition of the combo box."}}},"DraftGetElementsRadioButtonGroup":{"description":"The configuration of the radio button group.","type":"object","properties":{"GroupName":{"description":"The name of the radio button group.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"SelectedItem":{"description":"The export value of the selected item of the radio button group.","type":"string"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftGetElementsRadioButtonDefinition","description":"The definition of the radio button group."}}},"DraftGetElementsListBox":{"description":"The configuration of the list box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"PreSelectedItems":{"description":"The export values of the items which should be initially selected.","type":"array","items":{"type":"string"}},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftGetElementsListBoxDefinition","description":"The definition of the list box field."}}},"DraftGetElementsSignatureField":{"description":"The configuration of the signature field.","type":"object","properties":{"ElementId":{"description":"The identifier of the signature.","type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","type":"string"},"FieldDescription":{"description":"The description of the signature.","type":"string"},"UseExternalTimestampServer":{"description":"If true, an timestamp from an external server is embedded into the signature.","type":"boolean"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"AllowedSignatureTypes":{"$ref":"#/definitions/DraftGetElementsAllowedSignatureTypes","description":"The allowed types for the signature."},"FieldDefinition":{"$ref":"#/definitions/DraftGetElementsSignatureFieldDefinition","description":"The definition of the signature field."},"TaskConfiguration":{"$ref":"#/definitions/DraftGetElementsSignatureTaskConfiguration","description":"The configuration of the task."}}},"DraftGetElementsAttachment":{"description":"The configuration of the attachment element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DisplayName":{"description":"The displayed name.","type":"string"},"DisplayIconType":{"description":"The type of the displayed icon.","enum":["Paperclip","Graph","PushPin","Tag"],"type":"string"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftGetElementsAttachmentDefinition","description":"The definition of the attachment element."}}},"DraftGetElementsPredefinedFieldElements":{"description":"Defines the predefined fields which will be added and filled by the system.","type":"object","properties":{"TextFields":{"description":"The predefined text fields.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsPredefinedText"}},"EmailFields":{"description":"The recipient's email fields.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsEmail"}},"InitialsFields":{"description":"The recipient's initials fields.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsInitials"}},"GivenNameFields":{"description":"The recipient's given name fields.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsGivenName"}},"SurnameFields":{"description":"The recipient's surname fields.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsSurname"}},"FullNameFields":{"description":"The recipient's full name fields.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsFullName"}},"DateFields":{"description":"The current date fields.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsDate"}}}},"DraftGetElementsLinkConfiguration":{"description":"The configuration of the link elements.","type":"object","properties":{"HyperLinks":{"description":"The list of hyperlink elements.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsHyperLink"}}}},"DraftGetElementsReadAreaConfirmation":{"description":"The area that has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The document reference number of the element (starting with 1).","type":"integer"},"DisplayName":{"description":"The displayed name.","type":"string"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"Definition":{"$ref":"#/definitions/DraftGetElementsReadingAreaDefinition","description":"The definition of the area."}}},"DraftGetElementsReadPagesConfirmation":{"description":"Define which page has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","type":"string"},"PageNumber":{"format":"int32","description":"The number of the page that needs to be read.","type":"integer"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"}}},"DraftGetElementsReadDocumentConfirmation":{"description":"Define which document has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","type":"string"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"}}},"DraftGetElementsAction":{"description":"The action of the activity.","type":"object","properties":{"SignAutomatic":{"$ref":"#/definitions/DraftGetElementsSignAutomatic","description":"The definition of the automatic sign action."},"Sign":{"$ref":"#/definitions/DraftGetElementsSign","description":"The definition of the sign action."},"SignBulk":{"$ref":"#/definitions/DraftGetElementsSignBulk","description":"The definition of the bulk."}}},"DraftGetElementsFieldValidation":{"description":"The configuration of the field validation rules.","type":"object","properties":{"Type":{"description":"The type of the value.","enum":["None","Date","Email","Number","Phone","Time"],"type":"string","x-ms-enum":{"name":"FieldValidationType","modelAsString":false}},"DateValidationConfiguration":{"$ref":"#/definitions/DraftGetElementsDateValidationConfiguration","description":"The validation rules for dates."},"NumberValidationConfiguration":{"$ref":"#/definitions/DraftGetElementsNumberValidationConfiguration","description":"The validation rules for numbers."},"PhoneValidationConfiguration":{"$ref":"#/definitions/DraftGetElementsPhoneValidationConfiguration","description":"The validation rules for phone numbers."},"TimeValidationConfiguration":{"$ref":"#/definitions/DraftGetElementsTimeValidationConfiguration","description":"The validation rules for time values."}}},"DraftGetElementsTextBoxDefinition":{"description":"The configuration of the text box.","type":"object","properties":{"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"MaxLength":{"format":"int32","description":"The maximum length of the text.","type":"integer"},"IsMultiline":{"description":"If true, the text box can have multiple lines.","type":"boolean"},"IsPassword":{"description":"If true, the text box behaves like a password input field and does not show the actually entered characters.","type":"boolean"},"TextFormat":{"$ref":"#/definitions/DraftGetElementsTextFormat","description":"The configuration of the text format."},"Position":{"$ref":"#/definitions/DraftGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/DraftGetElementsSize","description":"The size of the form field."}}},"DraftGetElementsCheckBoxDefinition":{"description":"The configuration of a check box.","type":"object","properties":{"ExportValue":{"description":"The value of the check box when it is checked.","type":"string"},"Position":{"$ref":"#/definitions/DraftGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/DraftGetElementsSize","description":"The size of the form field."},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"}}},"DraftGetElementsComboBoxDefinition":{"description":"The configuration of the combo box.","type":"object","properties":{"TextFormat":{"$ref":"#/definitions/DraftGetElementsTextFormat","description":"The configuration of the text format."},"Items":{"description":"A list of items that can be selected for the element.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsChoiceItem"}},"IsEditable":{"description":"If true, the combo box is editable.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/DraftGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/DraftGetElementsSize","description":"The size of the form field."}}},"DraftGetElementsRadioButtonDefinition":{"description":"The configuration of the radio button group definition.","type":"object","properties":{"IsSelectUnison":{"description":"If true, radio buttons with the same <code>ExportValue<\/code> are checked and unchecked together.","type":"boolean"},"Items":{"description":"The list of radiobuttons that belong to the same group.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsRadioButtonItemDefinition"}}}},"DraftGetElementsListBoxDefinition":{"description":"The configuration of the list box.","type":"object","properties":{"TextFormat":{"$ref":"#/definitions/DraftGetElementsTextFormat","description":"The configuration of the text format."},"Items":{"description":"A list of items that can be selected for the element.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsChoiceItem"}},"IsMultiSelect":{"description":"If true, multiple values of the list box can be selected.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/DraftGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/DraftGetElementsSize","description":"The size of the form field."}}},"DraftGetElementsAllowedSignatureTypes":{"description":"The definition of the allowed signature types for the signature.","type":"object","properties":{"ClickToSign":{"$ref":"#/definitions/DraftGetElementsClickToSignSignatureType","description":"Allow signing with \"click to sign\"."},"DrawToSign":{"$ref":"#/definitions/DraftGetElementsDrawToSignSignatureType","description":"Allow signing with \"draw to sign\"."},"TypeToSign":{"$ref":"#/definitions/DraftGetElementsTypeToSignSignatureType","description":"Allow signing with \"type to sign\"."},"LocalCertificate":{"$ref":"#/definitions/DraftGetElementsLocalCertificateSignatureType","description":"Allow signing with a local certificate."},"DisposableCertificate":{"$ref":"#/definitions/DraftGetElementsDisposableCertificateSignatureType","description":"Allow signing with a disposable certificate."},"SwissComOnDemand":{"$ref":"#/definitions/DraftGetElementsSwissComOnDemandSignatureType","description":"Allow signing with a Swisscom On-Demand certificate."},"ATrustCertificate":{"$ref":"#/definitions/DraftGetElementsATrustCertificateSignatureType","description":"Allow signing with an A-Trust certificate."},"Biometric":{"$ref":"#/definitions/DraftGetElementsBiometricSignatureType","description":"Allow signing with a biometric signature."},"RemoteCertificate":{"$ref":"#/definitions/DraftGetElementsRemoteCertificateSignatureType","description":"Allow signing with a remote certificate."},"OneTimePassword":{"$ref":"#/definitions/DraftGetElementsOneTimePasswordSignatureType","description":"Allow signing with a one time password (SMS-OTP)."},"SwedishBankId":{"$ref":"#/definitions/DraftGetElementsSwedishBankIdSignatureType","description":"Allow signing with Swedish BankID."},"SignaturePlugins":{"description":"Allow signing with signature plugins.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsSignaturePluginSignatureType"}}}},"DraftGetElementsSignatureFieldDefinition":{"description":"The settings of a positionable element.","type":"object","properties":{"Position":{"$ref":"#/definitions/DraftGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/DraftGetElementsSize","description":"The size of the form field."}}},"DraftGetElementsSignatureTaskConfiguration":{"description":"The configuration of the signature task.","type":"object","properties":{"StampImprintDateConfiguration":{"$ref":"#/definitions/DraftGetElementsStampImprintDateConfiguration","description":"The configuration of the stamp imprint date."},"BatchGroup":{"description":"The batch group.","type":"string"}}},"DraftGetElementsAttachmentDefinition":{"description":"The settings of a positionable element.","type":"object","properties":{"Position":{"$ref":"#/definitions/DraftGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/DraftGetElementsSize","description":"The size of the form field."}}},"DraftGetElementsPredefinedText":{"description":"The configuration of the element showing the predefined text.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Value":{"description":"The value of the predefined text.","type":"string"},"FieldDefinition":{"$ref":"#/definitions/DraftGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"DraftGetElementsEmail":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"DraftGetElementsInitials":{"description":"The configuration of the predefined element showing the initials.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"IncludeMiddleNameInitials":{"description":"If true, the initials from the middle names are included as well. \r\nThe initials are read from the given name. Additional names are expected to be separated by a space.","type":"boolean"},"FieldDefinition":{"$ref":"#/definitions/DraftGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"DraftGetElementsGivenName":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"DraftGetElementsSurname":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"DraftGetElementsFullName":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"DraftGetElementsDate":{"description":"The configuration of the predefined element showing the date.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DateFormat":{"description":"The format of the date.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"DraftGetElementsHyperLink":{"description":"The definition of the hyperlink element.","type":"object","properties":{"Id":{"description":"The identifier of the hyperlink.","type":"string"},"Uri":{"description":"The URI of the hyperlink.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftGetElementsLinkDefinition","description":"The definition of the hyperlink element."}}},"DraftGetElementsReadingAreaDefinition":{"description":"The settings of a positionable element.","type":"object","properties":{"Position":{"$ref":"#/definitions/DraftGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/DraftGetElementsSize","description":"The size of the form field."}}},"DraftGetElementsSignAutomatic":{"description":"An automatic signing action.","type":"object","properties":{"VisibleSignatures":{"description":"The visible signatures define the optional visual representations for automatic signatures.\r\nIf none are defined, the automatic signatures are applied to the documents without a visual element.","type":"array","items":{"$ref":"#/definitions/DraftGetElementsVisibleSignature"}}}},"DraftGetElementsSign":{"description":"The elements, which are assigned to actions.","type":"object","properties":{"SequenceMode":{"description":"The sequence mode.","enum":["NoSequenceEnforced","SequenceEnforced"],"type":"string","x-ms-enum":{"name":"ElementSequenceMode","modelAsString":false}},"Elements":{"$ref":"#/definitions/DraftGetElementsElements","description":"The definition of the assigned elements."}}},"DraftGetElementsSignBulk":{"description":"The elements, which are assigned to actions.","type":"object","properties":{"SequenceMode":{"description":"The sequence mode.","enum":["NoSequenceEnforced","SequenceEnforced"],"type":"string","x-ms-enum":{"name":"ElementSequenceMode","modelAsString":false}},"Elements":{"$ref":"#/definitions/DraftGetElementsElements","description":"The definition of the assigned elements."}}},"DraftGetElementsDateValidationConfiguration":{"description":"The validation rules for dates.","type":"object","properties":{"DateFormat":{"description":"The format of the dates.","type":"string"},"Range":{"$ref":"#/definitions/DraftGetElementsFieldValidationRange","description":"The range of the values."}}},"DraftGetElementsNumberValidationConfiguration":{"description":"The validation rules for numbers.","type":"object","properties":{"DecimalDigits":{"format":"int32","description":"The expected amount of decimal digits.","type":"integer"},"Symbol":{"description":"The expected symbol.","type":"string"},"SymbolLocation":{"description":"The defined symbol location.","enum":["Start","StartWithBlank","End","EndWithBlank"],"type":"string","x-ms-enum":{"name":"SymbolLocationType","modelAsString":false}},"GroupSeparator":{"description":"The expected thousands separator.","enum":["Comma","Point","Apostrophe","Blank","None"],"type":"string"},"DecimalSeparator":{"description":"The expected decimal separator.","enum":["Comma","Point","Apostrophe","None"],"type":"string","x-ms-enum":{"name":"DecimalSeparatorType","modelAsString":false}},"Range":{"$ref":"#/definitions/DraftGetElementsFieldValidationRange","description":"The range of the values."}}},"DraftGetElementsPhoneValidationConfiguration":{"description":"The validation rules for phone numbers.","type":"object","properties":{"Type":{"description":"The format of the phone numbers.","enum":["International","InternationalLeadingZeros","InternationalLeadingPlus"],"type":"string","x-ms-enum":{"name":"PhoneType","modelAsString":false}}}},"DraftGetElementsTimeValidationConfiguration":{"description":"The validation rules for time values.","type":"object","properties":{"TimeFormat":{"description":"The format of the time values.","type":"string"},"Range":{"$ref":"#/definitions/DraftGetElementsFieldValidationRange","description":"The range of the values."}}},"DraftGetElementsTextFormat":{"description":"The configuration of the text format.","type":"object","properties":{"TextColor":{"description":"The color of the text.\r\nSix digit hexadecimal color starting with # in #RRGGBB format according to CSS Color Module Level 4, paragraph 5.2.","type":"string"},"FontSizeInPt":{"format":"double","description":"The size of the font in points.","type":"number"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"Bold":{"description":"If true, the bold font is used.","type":"boolean"},"Italic":{"description":"If true, the italic font is used.","type":"boolean"},"TextAlign":{"description":"The alignment of the text. The default alignment is left.","enum":["Left","Center","Right"],"type":"string","x-ms-enum":{"name":"TextAlignment","modelAsString":false}}}},"DraftGetElementsPosition":{"description":"The position of an element on the document.","type":"object","properties":{"PageNumber":{"format":"int32","description":"The number of the page where the element is located. It starts with 1.","type":"integer"},"X":{"format":"double","description":"The X coordinate in points. It starts from the left.","type":"number"},"Y":{"format":"double","description":"The Y coordinate in points. It starts from the bottom.","type":"number"}}},"DraftGetElementsSize":{"description":"The definition of the size of an element.","type":"object","properties":{"Width":{"format":"double","description":"The width of the element in points.","type":"number"},"Height":{"format":"double","description":"The height of the element in points.","type":"number"}}},"DraftGetElementsChoiceItem":{"description":"The configuration of the choice item.","type":"object","properties":{"ExportValue":{"description":"The value of the element when the choice item is selected.","type":"string"},"DisplayValue":{"description":"The displayed value of the choice item.","type":"string"}}},"DraftGetElementsRadioButtonItemDefinition":{"description":"The configuration of the radio button.","type":"object","properties":{"ExportValue":{"description":"The value of the element when the radio button is checked.","type":"string"},"IsChecked":{"description":"If true, the radio button is checked by default.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/DraftGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/DraftGetElementsSize","description":"The size of the form field."}}},"DraftGetElementsClickToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftGetElementsClickToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftGetElementsDrawToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftGetElementsDrawToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftGetElementsTypeToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftGetElementsTypeToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftGetElementsLocalCertificateSignatureType":{"description":"The configuration of the LocalCertificate signature.","type":"object","properties":{"EnforcePreferredHashAlgorithm":{"description":"If true, the usage of the preferred hash algorithm is enforced.","type":"boolean"},"PreferredHashAlgorithm":{"description":"The preferred hash algorithm.","enum":["Sha256","Sha512"],"type":"string"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftGetElementsLocalCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftGetElementsDisposableCertificateSignatureType":{"description":"The configuration of the DisposableCertificate signature.","type":"object","properties":{"IsLongLived":{"description":"If true, the disposable certificate is long lived.","type":"boolean"},"ValidityInSeconds":{"format":"int32","description":"The validity of the certificate in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftGetElementsDisposableCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftGetElementsSwissComOnDemandSignatureType":{"description":"The configuration of the Swisscom On-Demand signature.","type":"object","properties":{"ValidityInSeconds":{"format":"int32","description":"The certificate validity in seconds.","type":"integer"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftGetElementsSwissComOnDemandStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftGetElementsATrustCertificateSignatureType":{"description":"The configuration of the A-Trust certificate signature.","type":"object","properties":{"TemplateId":{"description":"The identifier of the A-Trust template.","type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"}}},"DraftGetElementsBiometricSignatureType":{"description":"The configuration of the Biometric signature.","type":"object","properties":{"BiometricVerification":{"description":"If true, a biometric verification is performed.","type":"boolean"},"AllowBiometricStoringOnly":{"description":"If true, the biometric signature might be stored without verification.","type":"boolean"},"StoreSignedResponseWithoutBioData":{"description":"If true, the signed response is stored without biometric data.","type":"boolean"},"BiometricServerUserId":{"description":"The identifier of the user on the biometric server.","type":"string"},"SignaturePositioning":{"description":"The allowed positioning of the biometric signature.","enum":["WithinField","OnPage","IntersectsWithField"],"type":"string","x-ms-enum":{"name":"BiometricSignaturePositioning","modelAsString":false}},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"}}},"DraftGetElementsRemoteCertificateSignatureType":{"description":"The configuration of the RemoteCertificate signature.","type":"object","properties":{"ValidityInSeconds":{"format":"int32","description":"The validity of the certificate in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftGetElementsRemoteCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftGetElementsOneTimePasswordSignatureType":{"description":"The configuration of the OneTimePassword signature.","type":"object","properties":{"ValidityInSeconds":{"format":"int32","description":"The validity of the password in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftGetElementsOneTimePasswordStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftGetElementsSwedishBankIdSignatureType":{"description":"The configuration of the signature.","type":"object","properties":{"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftGetElementsSwedishBankIdStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftGetElementsSignaturePluginSignatureType":{"description":"The configuration of the signature plugin.","type":"object","properties":{"PluginId":{"description":"The identifier of the plugin.","type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftGetElementsPluginStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftGetElementsStampImprintDateConfiguration":{"description":"The configuration of the stamp imprint date","type":"object","properties":{"UseLocalTimezone":{"description":"If true, the local timezone is used.","type":"boolean"},"DateTimeFormat":{"description":"The format of the timestamp.","type":"string"}}},"DraftGetElementsPredefinedElementDefinition":{"description":"The configuration of the predefined element.","type":"object","properties":{"TextFormat":{"$ref":"#/definitions/DraftGetElementsTextFormat","description":"The configuration of the text format."},"Position":{"$ref":"#/definitions/DraftGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/DraftGetElementsSize","description":"The size of the form field."}}},"DraftGetElementsLinkDefinition":{"description":"The settings of a positionable element.","type":"object","properties":{"Position":{"$ref":"#/definitions/DraftGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/DraftGetElementsSize","description":"The size of the form field."}}},"DraftGetElementsVisibleSignature":{"description":"An automatic signature with a visual appearance on the document.","type":"object","properties":{"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Id":{"description":"The identifier of the signature field.","type":"string"},"UseExternalTimestampServer":{"description":"If true, a timestamp from an external server is embedded into the signature.","type":"boolean"},"FieldDefinition":{"$ref":"#/definitions/DraftGetElementsSignatureFieldDefinition","description":"The definition of the signature field."}}},"DraftGetElementsFieldValidationRange":{"description":"The validation rules for a value range.","type":"object","properties":{"From":{"description":"The lower boundary of the range.","type":"string"},"To":{"description":"The upper boundary of the range.","type":"string"}}},"DraftGetElementsClickToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftGetElementsDrawToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftGetElementsTypeToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftGetElementsLocalCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftGetElementsDisposableCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftGetElementsSwissComOnDemandStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftGetElementsRemoteCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftGetElementsOneTimePasswordStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayTransactionId":{"description":"If true, the transaction identifier is displayed.","type":"boolean"},"DisplayTransactionToken":{"description":"If true, the transaction token is displayed.","type":"boolean"},"DisplayPhoneNumber":{"description":"If true, the phone number of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftGetElementsSwedishBankIdStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayTransactionId":{"description":"If true, the transaction identifier is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftGetElementsPluginStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftGetConfigurationResponse":{"description":"Configuration shared by all models.","type":"object","properties":{"MetaData":{"description":"The metadata of the envelope.","type":"string"},"AddDocumentTimestamp":{"description":"If true, a timestamp is added to all documents of the envelope at the end of each signing activity.","type":"boolean"},"ShareWithTeam":{"description":"If true, this envelope is shared with your teams.","type":"boolean"},"LockFormFieldsOnFinish":{"description":"If true, form fields are locked after envelope is finished.","type":"boolean"},"SendFinishedDocumentsToAllSignersAndMustView":{"description":"If true, every signer and viewer will receive a copy of the finished documents.","type":"boolean"},"Activities":{"description":"The steps for the envelope.","type":"array","items":{"$ref":"#/definitions/DraftGetConfigurationActivity"}},"EmailConfiguration":{"$ref":"#/definitions/DraftGetConfigurationEmailConfiguration","description":"The configuration for notifications."},"ReminderConfiguration":{"$ref":"#/definitions/DraftGetConfigurationReminderConfiguration","description":"The configuration for reminders."},"ExpirationConfiguration":{"$ref":"#/definitions/DraftGetConfigurationExpirationConfiguration","description":"The configuration of the expiration for the envelope."},"CallbackConfiguration":{"$ref":"#/definitions/DraftGetConfigurationCallbackConfiguration","description":"The configuration of the callbacks for a custom integration."},"AgreementConfiguration":{"$ref":"#/definitions/DraftGetConfigurationAgreementConfiguration","description":"The configuration of the agreement."},"AgentRedirectConfiguration":{"$ref":"#/definitions/DraftGetConfigurationAgentRedirectConfiguration","description":"The configuration of the redirects for the agent mode."},"RedirectConfiguration":{"$ref":"#/definitions/DraftGetConfigurationRedirectConfiguration","description":"The configuration of the redirects for the agent mode."},"DefaultSignatureTypeConfiguration":{"$ref":"#/definitions/DraftGetConfigurationDefaultSignatureTypeConfiguration","description":"Draft default signature type configuration."},"SealingConfiguration":{"$ref":"#/definitions/DraftGetConfigurationSealingConfiguration","description":"The configuration for sealing."}}},"DraftGetConfigurationActivity":{"description":"Defines an activity with the possibility of bulk.","type":"object","properties":{"Id":{"description":"The identifier of the activity.","type":"string"},"Action":{"$ref":"#/definitions/DraftGetConfigurationAction","description":"The action assigned to the activity."},"VisibilityOptions":{"description":"The document visibility options for the activity.","type":"array","items":{"$ref":"#/definitions/DraftGetConfigurationVisibilityOption"}}}},"DraftGetConfigurationEmailConfiguration":{"description":"The configuration for notifications.","type":"object","properties":{"Subject":{"description":"The subject of the sign notifications.","type":"string"},"Message":{"description":"The message of the sign notifications.","type":"string"},"SenderDisplayName":{"description":"The displayed name of the sender in the notifications.","type":"string"}}},"DraftGetConfigurationReminderConfiguration":{"description":"The configuration for reminders.","type":"object","properties":{"Enabled":{"description":"If true, reminders are sent.","type":"boolean"},"FirstReminderInDays":{"format":"int32","description":"The amount of days until a reminder is sent to a signer or a viewer after the initial notification.","type":"integer"},"ReminderResendIntervalInDays":{"format":"int32","description":"The amount of days until a reminder is sent again to a signer or a viewer.","type":"integer"},"BeforeExpirationInDays":{"format":"int32","description":"The amount of days before the envelope expires and a reminder should be sent.","type":"integer"}}},"DraftGetConfigurationExpirationConfiguration":{"description":"The configuration of the expiration for the envelope.","type":"object","properties":{"ExpirationInSeconds":{"format":"int64","description":"The relative expiration in seconds after sending the envelope.","type":"integer"},"ExpirationDate":{"format":"date-time","description":"The absolute expiration date of the envelope.\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","type":"string"}}},"DraftGetConfigurationCallbackConfiguration":{"description":"The configuration of the callbacks for a custom integration.","type":"object","properties":{"CallbackUrl":{"description":"The callback URL triggered when the envelope has been finished.","type":"string"},"StatusUpdateCallbackUrl":{"description":"The callback URL triggered for status updates of an envelope.","type":"string"},"AfterSendCallbackUrl":{"description":"The callback URL triggered after sending the draft.","type":"string"},"ActivityActionCallbackConfiguration":{"$ref":"#/definitions/DraftGetConfigurationActivityActionCallbackConfiguration","description":"The configuration of the callback for workstep events."}}},"DraftGetConfigurationAgreementConfiguration":{"description":"The configuration of the agreement.","type":"object","properties":{"Translations":{"description":"The agreement and its translations to be used.\r\nIf no custom agreement is specified, the default organization agreement will be used.","type":"array","items":{"$ref":"#/definitions/DraftGetConfigurationAgreementTranslation"}}}},"DraftGetConfigurationAgentRedirectConfiguration":{"description":"The configuration of the redirects for the agent mode.","type":"object","properties":{"Policy":{"description":"Defines the redirect target page which should be opened when the agent mode is active.","enum":["Workflow","FormEditor","Summary"],"type":"string","x-ms-enum":{"name":"RedirectPolicyEnum","modelAsString":false}},"Allow":{"description":"If true, the agent mode can be used.","type":"boolean"},"IFrameAllowList":{"description":"The URLs where the designer interface of eSignAnyWhere may be embedded.","type":"array","items":{"type":"string"}}}},"DraftGetConfigurationRedirectConfiguration":{"description":"The configuration of the draft redirect URLs.","type":"object","properties":{"AfterSendRedirectUrl":{"description":"The URL to redirect to after the envelope was sent successfully.\r\nThis is only applicable when using the eSAW UI.","type":"string"},"BeforeSendRedirectUrl":{"description":"The URL to redirect to before the envelope is sent.\r\nThis is only applicable when using the eSAW UI.","type":"string"}}},"DraftGetConfigurationDefaultSignatureTypeConfiguration":{"description":"The configuration of the default signature type for a draft.","type":"object","properties":{"None":{"$ref":"#/definitions/DraftGetConfigurationDefaultSignature","description":"\"None\" SignatureType."},"ClickToSign":{"$ref":"#/definitions/DraftGetConfigurationDefaultSignature","description":"\"click to sign\" SignatureType."},"DrawToSign":{"$ref":"#/definitions/DraftGetConfigurationDefaultSignature","description":"\"draw to sign\" SignatureType."},"TypeToSign":{"$ref":"#/definitions/DraftGetConfigurationDefaultSignature","description":"\"type to sign\" SignatureType."},"LocalCertificate":{"$ref":"#/definitions/DraftGetConfigurationDefaultSignature","description":"\"local certificate\" SignatureType."},"DisposableCertificate":{"$ref":"#/definitions/DraftGetConfigurationDefaultSignature","description":"\"disposable certificate\" SignatureType."},"Biometric":{"$ref":"#/definitions/DraftGetConfigurationDefaultSignature","description":"\"biometric signature\" SignatureType."},"RemoteCertificate":{"$ref":"#/definitions/DraftGetConfigurationDefaultSignature","description":"\"remote certificate\" SignatureType."},"OneTimePassword":{"$ref":"#/definitions/DraftGetConfigurationDefaultSignature","description":"\"one time password (SMS-OTP)\" SignatureType."}}},"DraftGetConfigurationSealingConfiguration":{"description":"The configuration for sealing.","type":"object","properties":{"CertificateId":{"description":"Sealing certificate used.","type":"string"}}},"DraftGetConfigurationAction":{"description":"The action of the activity.","type":"object","properties":{"SendCopy":{"$ref":"#/definitions/DraftGetConfigurationSendCopy","description":"The configuration of the copy action."},"Sign":{"$ref":"#/definitions/DraftGetConfigurationSign","description":"The configuration of the sign action."},"View":{"$ref":"#/definitions/DraftGetConfigurationView","description":"The configuration of the view action."},"SignAsP7M":{"$ref":"#/definitions/DraftGetConfigurationSignAsP7M","description":"The configuration of the P7M sign action."},"SignBulk":{"$ref":"#/definitions/DraftGetConfigurationSignBulk","description":"The definition of the bulk."}}},"DraftGetConfigurationVisibilityOption":{"description":"The options defining the document visibility.","type":"object","properties":{"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"IsHidden":{"description":"If true, the referenced document is hidden for the activity.","type":"boolean"}}},"DraftGetConfigurationActivityActionCallbackConfiguration":{"description":"The configuration of the callback for workstep events.","type":"object","properties":{"Url":{"description":"The callback URL triggered for the selected events.","type":"string"},"ActionCallbackSelection":{"$ref":"#/definitions/DraftGetConfigurationActionCallbackSelection","description":"The selection of events which trigger the callback."}}},"DraftGetConfigurationAgreementTranslation":{"description":"A translation for the agreement.","type":"object","properties":{"LanguageCode":{"description":"The language of the translated agreement.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string","x-ms-enum":{"name":"LanguageCode","modelAsString":false}},"Text":{"description":"The translated agreement.","type":"string"},"Header":{"description":"The header for the translated agreement.","type":"string"},"IsDefault":{"description":"If true, this translation is used as default.","type":"boolean"}}},"DraftGetConfigurationDefaultSignature":{"description":"The configuration of the default signature type for a draft.","type":"object","properties":{"IsDefault":{"description":"Indicates if the signature type is the default signature type for draft.","type":"boolean"}}},"DraftGetConfigurationSendCopy":{"description":"The configuration of an action to send a copy of the documents to the recipient.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/DraftGetConfigurationBasicRecipientConfiguration","description":"The configuration of the recipient."},"CopyingGroup":{"format":"int32","description":"The parallel group for copy actions.","type":"integer"}}},"DraftGetConfigurationSign":{"description":"The configuration of the sign action for the recipient.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/DraftGetConfigurationAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"FinishActionConfiguration":{"$ref":"#/definitions/DraftGetConfigurationFinishAction","description":"Defines what happens in the signing clients, after an action has been finished."},"SignatureDataConfiguration":{"$ref":"#/definitions/DraftGetConfigurationSignatureDataConfiguration","description":"The configuration of recipient data for special signatures."},"BatchConfiguration":{"$ref":"#/definitions/DraftGetConfigurationBatchConfiguration","description":"The configuration of a signing batch."},"SigningGroup":{"format":"int32","description":"The parallel group for sign actions.","type":"integer"},"GeneralPoliciesOverrides":{"$ref":"#/definitions/DraftGetConfigurationGeneralPoliciesForSignAction","description":"Viewer policy settings for override."}}},"DraftGetConfigurationView":{"description":"The configuration of the action to view and acknowledge the documents.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/DraftGetConfigurationRecipientConfiguration","description":"The configuration of the recipient."},"ViewingGroup":{"format":"int32","description":"The parallel group for view actions.","type":"integer"},"GeneralPoliciesOverrides":{"$ref":"#/definitions/DraftGetConfigurationGeneralPoliciesForViewAction","description":"Viewer policy settings for override."}}},"DraftGetConfigurationSignAsP7M":{"description":"The configuration of an action to sign documents with P7M.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/DraftGetConfigurationAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"SignatureMethods":{"$ref":"#/definitions/DraftGetConfigurationP7MSignatureMethods","description":"The configuration of recipient data for P7M signatures."},"SignAsP7MGroup":{"format":"int32","description":"The parallel group for P7M actions.","type":"integer"},"GeneralPoliciesOverrides":{"$ref":"#/definitions/DraftGetConfigurationGeneralPoliciesForP7MAction","description":"Viewer policy settings for override."}}},"DraftGetConfigurationSignBulk":{"description":"The configuration of a sign action for multiple recipients.","type":"object","properties":{"RecipientConfigurations":{"description":"The configurations of the recipients that are part of the bulk.","type":"array","items":{"$ref":"#/definitions/DraftGetConfigurationBulkRecipient"}},"FinishActionConfiguration":{"$ref":"#/definitions/DraftGetConfigurationFinishAction","description":"Defined actions for different clients that will trigger after an action has been finished."},"BatchConfiguration":{"$ref":"#/definitions/DraftGetConfigurationBatchConfiguration","description":"The configuration of a signing batch."},"GeneralPoliciesOverrides":{"$ref":"#/definitions/DraftGetConfigurationGeneralPoliciesForSignAction","description":"Viewer policy settings for override."}}},"DraftGetConfigurationActionCallbackSelection":{"description":"The selection of events which trigger the callback.","type":"object","properties":{"ConfirmTransactionCode":{"description":"If true, the callback is triggered when a transaction code was sent. This is only used for legacy disposable certificates, after user accepted issuance of disposable certificate.","type":"boolean"},"AgreementAccepted":{"description":"If true, the callback is triggered when the user accepted the agreement.","type":"boolean"},"AgreementRejected":{"description":"If true, the callback is triggered when the user rejected the agreement.","type":"boolean"},"PrepareAuthenticationSuccess":{"description":"If true, the callback is triggered when the preparation of the authentication process succeeded.","type":"boolean"},"AuthenticationFailed":{"description":"If true, the callback is triggered when the user failed to authenticate.","type":"boolean"},"AuthenticationSuccess":{"description":"If true, the callback is triggered when the user succeeded to authenticate.","type":"boolean"},"AuditTrailRequested":{"description":"If true, the callback is triggered when the audit trail was requested.","type":"boolean"},"AuditTrailXmlRequested":{"description":"If true, the callback is triggered when the audit trail XML was requested.","type":"boolean"},"CalledPage":{"description":"If true, the callback is triggered when the SignAnyWhere Viewer was requested.","type":"boolean"},"DocumentDownloaded":{"description":"If true, the callback is triggered when the document download was requested.","type":"boolean"},"FlattenedDocumentDownloaded":{"description":"If true, the callback is triggered when the flattened document download was requested.","type":"boolean"},"AddedAnnotation":{"description":"If true, the callback is triggered when an annotation was added.","type":"boolean"},"AddedAttachment":{"description":"If true, the callback is triggered when an attachment was added.","type":"boolean"},"AppendedDocument":{"description":"If true, the callback is triggered when a document was appended.","type":"boolean"},"FormsFilled":{"description":"If true, the callback is triggered when a form field was filled.","type":"boolean"},"ConfirmReading":{"description":"If true, the callback is triggered when a reading task was completed.","type":"boolean"},"SendTransactionCode":{"description":"If true, the callback is triggered when a transaction code for a signature with type TransactionCode was sent using the TransactionCodeSenderPlugin.","type":"boolean"},"PrepareSignWorkstepDocument":{"description":"If true, the callback is triggered when a signature was prepared for signing.","type":"boolean"},"SignWorkstepDocument":{"description":"If true, the callback is triggered when a signature was applied.","type":"boolean"},"UndoAction":{"description":"If true, the callback is triggered when an action was undone.","type":"boolean"},"WorkstepCreated":{"description":"If true, the callback is triggered when a workstep was created.","type":"boolean"},"WorkstepFinished":{"description":"If true, the callback is triggered when a workstep was finished.","type":"boolean"},"WorkstepRejected":{"description":"If true, the callback is triggered when a workstep was rejected.","type":"boolean"},"DisablePolicyAndValidityChecks":{"description":"If true, the callback is triggered when policy and validity checks were disabled.","type":"boolean"},"EnablePolicyAndValidityChecks":{"description":"If true, the callback is triggered when policy and validity checks were enabled.","type":"boolean"},"AppendFileToWorkstep":{"description":"If true, the callback is triggered when a file was appended to the workstep.","type":"boolean"},"AppendTasksToWorkstep":{"description":"If true, the callback is triggered when a task was added to the workstep.","type":"boolean"},"SetOptionalDocumentState":{"description":"If true, the callback is triggered when an optional document became either active or inactive.","type":"boolean"},"PreparePayloadForBatch":{"description":"If true, the callback is triggered when the payload was prepared for batch signing.","type":"boolean"}}},"DraftGetConfigurationBasicRecipientConfiguration":{"description":"The configuration of the recipient.","type":"object","properties":{"PersonalMessage":{"description":"The personal message for the recipient.","type":"string"}}},"DraftGetConfigurationAdvancedRecipientConfiguration":{"description":"The advanced configuration for the recipient.","type":"object","properties":{"PersonalMessage":{"description":"The personal message for the recipient.","type":"string"},"AuthenticationConfiguration":{"$ref":"#/definitions/DraftGetConfigurationAuthenticationConfiguration","description":"The configuration for the authentication of the recipient."},"SendEmails":{"description":"If true, emails will be sent out for this recipient.","type":"boolean"},"AllowAccessAfterFinish":{"description":"If true, the recipient is allowed to access the action after it has been finished.","type":"boolean"},"RequireViewContentBeforeFormFilling":{"description":"If true, the signer has to confirm the reading of all documents as first task.","type":"boolean"},"IncludedEmailAppLinks":{"$ref":"#/definitions/DraftGetConfigurationEmailAppLinks","description":"The configuration for mobile app links in email messages."},"AllowDelegation":{"description":"If true, the recipient may delegate this activity.","type":"boolean"}}},"DraftGetConfigurationFinishAction":{"description":"Defines what happens in the signing clients, after an action has been finished.","type":"object","properties":{"SignAnyWhereViewer":{"$ref":"#/definitions/DraftGetConfigurationWebFinishAction","description":"The actions for the SAW Viewer."},"SignificantClientSignatureCaptureForIos":{"$ref":"#/definitions/DraftGetConfigurationAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for iOS."},"SignificantClientSignatureCaptureForAndroid":{"$ref":"#/definitions/DraftGetConfigurationAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for Android."},"SignificantClientSignatureCaptureForWindows":{"$ref":"#/definitions/DraftGetConfigurationAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for Windows."},"KioskSdk":{"$ref":"#/definitions/DraftGetConfigurationKioskFinishAction","description":"The actions for the SIGNificant Kiosk SDK."}}},"DraftGetConfigurationSignatureDataConfiguration":{"description":"The recipient configuration for signing.","type":"object","properties":{"DisposableCertificate":{"$ref":"#/definitions/DraftGetConfigurationDisposableCertificateSignatureData","description":"The disposable certificate configuration for the action."},"RemoteCertificate":{"$ref":"#/definitions/DraftGetConfigurationRemoteCertificateSignatureData","description":"The remote certificate configuration for the action."},"SwissComOnDemand":{"$ref":"#/definitions/DraftGetConfigurationSwissComOnDemandSignatureData","description":"The Swisscom On-Demand certificate configuration for the action."},"SmsOneTimePassword":{"$ref":"#/definitions/DraftGetConfigurationSmsOneTimePasswordSignatureData","description":"The one time password configuration for the action (SMS-OTP)."},"ATrustCertificate":{"$ref":"#/definitions/DraftGetConfigurationATrustCertificateSignatureData","description":"The A-Trust certificate configuration for the action."},"SwedishBankId":{"$ref":"#/definitions/DraftGetConfigurationSwedishBankIdSignatureData","description":"The Swedish BankID configuration for the action."},"SignaturePluginData":{"description":"The signature plugin configurations for the action.","type":"array","items":{"$ref":"#/definitions/DraftGetConfigurationSignaturePluginSignatureData"}}}},"DraftGetConfigurationBatchConfiguration":{"description":"The configuration of a signing batch.","type":"object","properties":{"Mode":{"description":"The mode, that will be used for batch signing.","enum":["Basic","OptIn","OptOut","OptOutWithRequiredAlwaysSelected","OptInWithRequiredAlwaysSelected"],"type":"string","x-ms-enum":{"name":"BatchMode","modelAsString":false}},"RequireScrollingOverAllSignaturesBeforeSigning":{"description":"If true, the user has to review all signatures in the batch signing dialog before signing.\r\nThis is only applicable when the <code>Mode<\/code> is set to <code>OptIn<\/code> or <code>OptOut<\/code>.","type":"boolean"}}},"DraftGetConfigurationGeneralPoliciesForSignAction":{"description":"Define the general policies allowed for sign action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"},"AllowAdhocPdfAttachments":{"description":"If true, the client is allowed to append adhoc documents.","type":"boolean"},"AllowRejectWorkstep":{"description":"If true, the client is allowed to reject the workstep.","type":"boolean"},"AllowUndoLastAction":{"description":"If true, the client is allowed to undo actions.","type":"boolean"}}},"DraftGetConfigurationRecipientConfiguration":{"description":"The configuration of the recipient.","type":"object","properties":{"PersonalMessage":{"description":"The personal message for the recipient.","type":"string"},"AuthenticationConfiguration":{"$ref":"#/definitions/DraftGetConfigurationAuthenticationConfiguration","description":"The configuration for the authentication of the recipient."},"SendEmails":{"description":"If true, emails will be sent out for this recipient.","type":"boolean"},"AllowAccessAfterFinish":{"description":"If true, the recipient is allowed to access the action after it has been finished.","type":"boolean"}}},"DraftGetConfigurationGeneralPoliciesForViewAction":{"description":"Define the general policies allowed for view action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"}}},"DraftGetConfigurationP7MSignatureMethods":{"description":"The recipient configuration for signing with P7M.","type":"object","properties":{"LocalCertificate":{"description":"If true, a local certificate can be used.","type":"boolean"},"DisposableCertificate":{"$ref":"#/definitions/DraftGetConfigurationDisposableCertificateSignatureData","description":"The disposable certificate configuration for the action."},"RemoteCertificate":{"$ref":"#/definitions/DraftGetConfigurationRemoteCertificateSignatureData","description":"The remote certificate configuration for the action."},"SignaturePluginData":{"description":"The signature plugin configurations for the action.","type":"array","items":{"$ref":"#/definitions/DraftGetConfigurationSignaturePluginSignatureData"}}}},"DraftGetConfigurationGeneralPoliciesForP7MAction":{"description":"Define the general policies allowed for P7M action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"},"AllowAdhocPdfAttachments":{"description":"If true, the client is allowed to append adhoc documents.","type":"boolean"},"AllowRejectWorkstep":{"description":"If true, the client is allowed to reject the workstep.","type":"boolean"},"AllowUndoLastAction":{"description":"If true, the client is allowed to undo actions.","type":"boolean"},"AllowDownloadOfSignedP7MFiles":{"description":"If true, the client is allowed to download signed p7m files.","type":"boolean"}}},"DraftGetConfigurationBulkRecipient":{"description":"The definition of the recipient including the signature data.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/DraftGetConfigurationAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"SignatureDataConfiguration":{"$ref":"#/definitions/DraftGetConfigurationSignatureDataConfiguration","description":"The configuration of the signature data for the recipient."}}},"DraftGetConfigurationAuthenticationConfiguration":{"description":"The definition of the authentications of the recipient.","type":"object","properties":{"AccessCode":{"$ref":"#/definitions/DraftGetConfigurationAccessCodeAuthentication","description":"The configuration of the authentication with an access code."},"SmsOneTimePassword":{"$ref":"#/definitions/DraftGetConfigurationSmsOneTimePasswordAuthentication","description":"The configuration of the authentication with one time password over SMS."},"SwedishBankId":{"$ref":"#/definitions/DraftGetConfigurationSwedishBankIdAuthentication","description":"The configuration of the authentication with Swedish BankID."},"OAuthAuthentications":{"description":"The configurations of the authentication with OAuth.","type":"array","items":{"$ref":"#/definitions/DraftGetConfigurationOAuthAuthentication"}},"SamlAuthentications":{"description":"The configurations of the authentication with SAML.","type":"array","items":{"$ref":"#/definitions/DraftGetConfigurationSamlAuthentication"}}}},"DraftGetConfigurationEmailAppLinks":{"description":"Configure if links for our Apps should be included in the document signing request email message.","type":"object","properties":{"Android":{"description":"If true, an Android app link is added to the email message.","type":"boolean"},"iOS":{"description":"If true, an iOS app link is added to the email message.","type":"boolean"},"Windows":{"description":"If true, a Windows app link is added to the email message.","type":"boolean"}}},"DraftGetConfigurationWebFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RedirectUri":{"description":"The redirect uri.","type":"string"}}},"DraftGetConfigurationAppFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RemoveDocumentFromRecentDocumentList":{"description":"If true, the document will be removed from the recent document list.","type":"boolean"},"CallClientActionOnlyAfterSuccessfulSync":{"description":"If true, the client action will be called only after a successful sync.","type":"boolean"},"CloseApp":{"description":"If true, the app will be closed.","type":"boolean"},"RedirectUri":{"description":"The redirect uri.","type":"string"}}},"DraftGetConfigurationKioskFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RedirectUri":{"description":"The redirect uri.","type":"string"}}},"DraftGetConfigurationDisposableCertificateSignatureData":{"description":"The recipient configuration for signing with a disposable certificate.","type":"object","properties":{"DocumentIssuingCountry":{"description":"The issuing country of the document.\r\nWill be used as country of residence, if lean is disabled.","type":"string"},"IdentificationIssuingCountry":{"description":"The issuing country of the identification.","type":"string"},"IdentificationType":{"description":"The type of identification in use.","enum":["None","ForeignTaxCode","PersonalNumber","Passport","NationalIdentityCard","ItalianTaxCode","NoSerialNumber","DrivingLicense","ResidencePermit","TemporaryResidencePermit","EmbassyDocument","AML"],"type":"string","x-ms-enum":{"name":"DisposableCertificateIdentificationType","modelAsString":false}},"PhoneNumber":{"description":"The phone number registered for identification.","type":"string"},"DocumentType":{"description":"The type of document used for the identification.","enum":["IdentityCard","DriverLicense","Passport","ResidencePermit","NationalElectronicIdentityCard","TemporaryResidencePermit","EmbassyDocument"],"type":"string","x-ms-enum":{"name":"DisposableCertificateDocumentType","modelAsString":false}},"DocumentIssuedBy":{"description":"The authority that issued the document.","type":"string"},"DocumentIssuedOn":{"format":"date","description":"The date when the document has been issued.\r\nA date in the format RFC 3339, section 5.6, 'full-date' (e.g. 2017-07-21).","type":"string"},"DocumentExpiryDate":{"format":"date","description":"The expiration date of the document.\r\nA date in the format RFC 3339, section 5.6, 'full-date' (e.g. 2017-07-21).","type":"string"},"SerialNumber":{"description":"The serial number of the certificate.","type":"string"},"DocumentNumber":{"description":"The identifier of the document.","type":"string"}}},"DraftGetConfigurationRemoteCertificateSignatureData":{"description":"The recipient configuration for signing with a remote certificate.","type":"object","properties":{"UserId":{"description":"The identifier of the user.","type":"string"},"DeviceId":{"description":"The identifier of the device.","type":"string"}}},"DraftGetConfigurationSwissComOnDemandSignatureData":{"description":"The recipient configuration for signing with a Swisscom On-Demand certificate.","type":"object","properties":{"PhoneNumber":{"description":"The phone number.","type":"string"},"CommonName":{"description":"The name of the certificate that is created or checked.","type":"string"},"Country":{"description":"The country.","type":"string"},"Locality":{"description":"The locality.","type":"string"},"OrganizationUnit":{"description":"The organizational unit.","type":"string"},"Organization":{"description":"The organization.","type":"string"},"SerialNumber":{"description":"The serial number.","type":"string"},"StateOrProvince":{"description":"The state or province.","type":"string"},"Pseudonym":{"description":"A name or key that uniquely identifies the user.","type":"string"}}},"DraftGetConfigurationSmsOneTimePasswordSignatureData":{"description":"The recipient configuration for signing with a one time password sent via SMS.","type":"object","properties":{"PhoneNumber":{"description":"The phone number to which the one time password will be sent.","type":"string"}}},"DraftGetConfigurationATrustCertificateSignatureData":{"description":"The recipient configuration for signing with an A-Trust certificate.","type":"object","properties":{"PhoneNumber":{"description":"The phone number of the recipient.","type":"string"}}},"DraftGetConfigurationSwedishBankIdSignatureData":{"description":"The recipient configuration for signing with Swedish BankID.","type":"object","properties":{"PersonalNumber":{"description":"The personal number for signing.","type":"string"},"AllowAnyPersonalNumber":{"description":"If true, the personal number can be edited by the recipient.\r\nIf the personal number is empty and can be edited, a QR code for scanning is provided.","type":"boolean"}}},"DraftGetConfigurationSignaturePluginSignatureData":{"description":"The recipient configuration for signing with a signature plugin.","type":"object","properties":{"PluginId":{"description":"The identifier of the signature plugin.","type":"string"},"Fields":{"description":"The plugin parameters referred to as the GSP sender data fields.","type":"array","items":{"$ref":"#/definitions/DraftGetConfigurationSignaturePluginParameter"}}}},"DraftGetConfigurationAccessCodeAuthentication":{"description":"The configuration for authentication with a predefined access code.","type":"object","properties":{"Code":{"description":"The code for authenticating the recipient.","type":"string"}}},"DraftGetConfigurationSmsOneTimePasswordAuthentication":{"description":"The configuration for authentication with a one time password sent over SMS.","type":"object","properties":{"PhoneNumber":{"description":"The phone number to which the one time password will be sent.","type":"string"}}},"DraftGetConfigurationSwedishBankIdAuthentication":{"description":"The configuration for Swedish BankID authentication.","type":"object","properties":{"PersonalNumber":{"description":"The personal number for the authentication.","type":"string"},"AllowAnyPersonalNumber":{"description":"If true, the personal number can be edited by the recipient.\r\nIf the personal number is empty and can be edited, a QR code for scanning is provided.","type":"boolean"}}},"DraftGetConfigurationOAuthAuthentication":{"description":"The configuration for authentication with an OAuth provider.","type":"object","properties":{"ProviderName":{"description":"The name of the OAuth provider.","type":"string"},"Validations":{"description":"The validation rules for the OAuth response.","type":"array","items":{"$ref":"#/definitions/DraftGetConfigurationAuthenticationValidation"}}}},"DraftGetConfigurationSamlAuthentication":{"description":"The configuration for authentication with a SAML provider.","type":"object","properties":{"ProviderName":{"description":"The name of the SAML provider.","type":"string"},"Validations":{"description":"The validation rules for the SAML response.","type":"array","items":{"$ref":"#/definitions/DraftGetConfigurationAuthenticationValidation"}}}},"DraftGetConfigurationSignaturePluginParameter":{"description":"The definition of a signature plugin parameter.","type":"object","properties":{"Key":{"description":"The identifier of the parameter.","type":"string"},"Value":{"description":"The value of the parameter.","type":"string"}}},"DraftGetConfigurationAuthenticationValidation":{"description":"A validation rule for an authentication response.","type":"object","properties":{"FieldReferenceId":{"description":"The identifier of the field.","type":"string"},"ExpectedValue":{"description":"The expected value of the field.","type":"string"}}},"DraftFindRequest":{"description":"The request model for searching drafts.","type":"object","properties":{"StartDate":{"format":"date-time","description":"If set, filter for drafts which were created after the start date.\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","maxLength":30,"minLength":20,"type":"string"},"EndDate":{"format":"date-time","description":"If set, filter for drafts which were created before the end date.\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","maxLength":30,"minLength":20,"type":"string"},"SearchText":{"description":"If set, the given text is searched in following fields:\r\nenvelope name and description\r\nnotification subject and message \r\nsender email address, given name and surname  \r\nrecipient email address, given name and surname\r\nNote: Using this search option is very resource intensive! It might take very long.","maxLength":500,"minLength":0,"type":"string"},"RecipientEmail":{"description":"If set, envelopes containing a recipient with the given email address are matched.","maxLength":250,"minLength":0,"type":"string"}}},"DraftFindResponse":{"description":"The response model for found drafts.","type":"object","properties":{"Drafts":{"description":"The drafts which match the search criteria.","type":"array","items":{"$ref":"#/definitions/DraftFindDraft"}}}},"DraftFindDraft":{"description":"The response model for found envelopes.","type":"object","properties":{"Id":{"description":"The identifier of the envelope.","type":"string"},"Name":{"description":"The name of the envelope.","type":"string"},"MetaData":{"description":"The metadata of the envelope.","type":"string"}}},"DraftSendRequest":{"description":"The request model for sending a draft.","required":["DraftId"],"type":"object","properties":{"DraftId":{"description":"The identifier of the draft.","maxLength":36,"minLength":36,"type":"string"}}},"DraftSendResponse":{"description":"The response model after sending a draft successfully. Either information about the envelope or bulk envelope is provided.","type":"object","properties":{"Envelope":{"$ref":"#/definitions/EnvelopeSendResponse","description":"The information about the sent envelope. Populated, when the draft did not contain a bulk action."},"EnvelopeBulk":{"$ref":"#/definitions/EnvelopeBulkSendResponse","description":"The information about the sent bulk envelope. Populated, when the draft contained a bulk action."}}},"EnvelopeSendResponse":{"description":"The response model after sending an envelope successfully.","type":"object","properties":{"EnvelopeId":{"description":"The identifier of the envelope.","type":"string"}}},"EnvelopeBulkSendResponse":{"description":"The response model after sending a bulk envelope successfully.","type":"object","properties":{"EnvelopeBulkChildren":{"description":"The information about the created BulkChild envelopes.","type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendChild"}},"EnvelopeBulkParentId":{"description":"The identifier of the BulkParent envelope.","type":"string"}}},"EnvelopeBulkSendChild":{"description":"The information about the BulkChild envelope.","type":"object","properties":{"EnvelopeId":{"description":"The identifier of the BulkChild envelope.","type":"string"},"BulkRecipientEmail":{"description":"The email of the bulk recipient in the BulkChild envelope.","type":"string"}}},"DraftCreateDocument":{"description":"Define a document.","type":"object","properties":{"FileId":{"description":"The identifier of the file.","maxLength":36,"minLength":36,"type":"string"},"DocumentNumber":{"format":"int32","description":"The document number.\r\nIf the document number is 0 for all documents, the order of the documents is used as number.\r\nThe document number must not be duplicated.\r\nThe document number must be set for all documents or none.","type":"integer"}}},"DraftCreateEmailAppLinks":{"description":"Configure if links for our apps should be included in the recipient document signing request email message.","type":"object","properties":{"Android":{"description":"If true, an Android app link is added to the email message.","type":"boolean"},"iOS":{"description":"If true, an iOS app link is added to the email message.","type":"boolean"},"Windows":{"description":"If true, a Windows app link is added to the email message.","type":"boolean"}}},"DraftCreateElements":{"description":"The configurable elements of the documents.","type":"object","properties":{"TextBoxes":{"description":"The text boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftCreateTextBox"}},"CheckBoxes":{"description":"The check boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftCreateCheckBox"}},"ComboBoxes":{"description":"The combo boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftCreateComboBox"}},"RadioButtons":{"description":"The radio buttons.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftCreateRadioButtonGroup"}},"ListBoxes":{"description":"The list boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftCreateListBox"}},"Signatures":{"description":"The signatures.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftCreateSignatureField"}},"Attachments":{"description":"The attachments.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftCreateAttachment"}},"PredefinedFieldElements":{"$ref":"#/definitions/DraftCreatePredefinedFieldElements","description":"The predefined field elements."},"LinkConfiguration":{"$ref":"#/definitions/DraftCreateLinkConfiguration","description":"The links in the documents."},"AreaReadConfirmations":{"description":"The areas which have to be read.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftCreateReadAreaConfirmation"}},"PageReadConfirmations":{"description":"The pages which have to be read.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftCreateReadPagesConfirmation"}},"DocumentReadConfirmations":{"description":"The documents which have to be read.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftCreateReadDocumentConfirmation"}}}},"DraftCreateActivity":{"description":"Define an activity with the possibility of bulk.","type":"object","properties":{"Action":{"$ref":"#/definitions/DraftCreateAction","description":"The action assigned to the activity."},"VisibilityOptions":{"description":"The document visibility options for the activity.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/DraftCreateVisibilityOption"}}}},"DraftCreateEmailConfiguration":{"description":"The configuration for notifications.","type":"object","properties":{"Subject":{"description":"The subject of the sign notifications.","maxLength":300,"minLength":0,"type":"string"},"Message":{"description":"The message of the sign notifications.","maxLength":204800,"minLength":0,"type":"string"},"SenderDisplayName":{"description":"The displayed name of the sender in the notifications.","maxLength":200,"minLength":0,"type":"string"}}},"DraftCreateAgreementConfiguration":{"description":"The configuration of the agreement.","type":"object","properties":{"Translations":{"description":"The agreement and its translations to be used.\r\nIf no custom agreement is specified, the default organization agreement will be used.","maxItems":228,"type":"array","items":{"$ref":"#/definitions/DraftCreateAgreementTranslation"}}}},"DraftCreateDefaultSignatureTypeConfiguration":{"description":"The configuration of the default signature type for the draft.","type":"object","properties":{"None":{"$ref":"#/definitions/DraftCreateDefaultSignature","description":"\"None\" SignatureType."},"ClickToSign":{"$ref":"#/definitions/DraftCreateDefaultSignature","description":"\"click to sign\" SignatureType."},"DrawToSign":{"$ref":"#/definitions/DraftCreateDefaultSignature","description":"\"draw to sign\" SignatureType."},"TypeToSign":{"$ref":"#/definitions/DraftCreateDefaultSignature","description":"\"type to sign\" SignatureType."},"LocalCertificate":{"$ref":"#/definitions/DraftCreateDefaultSignature","description":"\"local certificate\" SignatureType."},"DisposableCertificate":{"$ref":"#/definitions/DraftCreateDefaultSignature","description":"\"disposable certificate\" SignatureType."},"Biometric":{"$ref":"#/definitions/DraftCreateDefaultSignature","description":"\"biometric signature\" SignatureType."},"RemoteCertificate":{"$ref":"#/definitions/DraftCreateDefaultSignature","description":"\"remote certificate\" SignatureType."},"OneTimePassword":{"$ref":"#/definitions/DraftCreateDefaultSignature","description":"\"one time password (SMS-OTP)\" SignatureType."}}},"DraftCreateSealingConfiguration":{"description":"The sealing configuration for the envelope","type":"object","properties":{"CertificateId":{"description":"Custom Sealing certificate identifier.","maxLength":36,"minLength":0,"type":"string"}}},"DraftCreatePredefinedFieldElements":{"description":"Define the predefined fields which will be added and filled by the system.","type":"object","properties":{"TextFields":{"description":"The predefined text fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftCreatePredefinedText"}},"EmailFields":{"description":"The recipient's email fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftCreateEmail"}},"InitialsFields":{"description":"The recipient's initials fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftCreateInitials"}},"GivenNameFields":{"description":"The recipient's given name fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftCreateGivenName"}},"SurnameFields":{"description":"The recipient's surname fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftCreateSurname"}},"FullNameFields":{"description":"The recipient's full name fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftCreateFullName"}},"DateFields":{"description":"The current date fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftCreateDate"}}}},"DraftCreateLinkConfiguration":{"description":"The configuration of the link elements.","type":"object","properties":{"HyperLinks":{"description":"The list of hyperlink elements.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/DraftCreateHyperLink"}}}},"DraftCreateAction":{"description":"The action of the activity with the possibility to define a bulk. Exactly one definition must be used!","type":"object","properties":{"SendCopy":{"$ref":"#/definitions/DraftCreateSendCopy","description":"The definition of the copy action."},"SignAutomatic":{"$ref":"#/definitions/DraftCreateSignAutomatic","description":"The definition of the automatic sign action."},"Sign":{"$ref":"#/definitions/DraftCreateSign","description":"The definition of the sign action."},"View":{"$ref":"#/definitions/DraftCreateView","description":"The definition of the view action."},"SignAsP7M":{"$ref":"#/definitions/DraftCreateSignAsP7M","description":"The definition of the P7M sign action."},"SignBulk":{"$ref":"#/definitions/DraftCreateSignBulk","description":"The definition of the bulk."}}},"DraftCreateVisibilityOption":{"description":"The options defining the document visibility.","type":"object","properties":{"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"IsHidden":{"description":"If true, the referenced document is hidden for the activity.","type":"boolean"}}},"DraftCreatePluginStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftCreateExpirationConfiguration":{"description":"The configuration of the expiration for the envelope.","type":"object","properties":{"ExpirationInSecondsAfterSending":{"description":"The relative expiration in seconds after sending the envelope.\r\nMust be a positive number between 600 and the maximum envelope validity located in the system configuration [Configuration key: maxEnvelopeValidityInDays, Default: 2419200 seconds (28 days)].\r\nMust not be defined when property <code>ExpirationDate<\/code> is specified.","type":"integer"},"ExpirationDate":{"format":"date-time","description":"The absolute expiration date of the envelope.\r\nMust not be in the past.\r\nMust not be defined when property <code>ExpirationInSecondsAfterSending<\/code> is specified.\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","maxLength":30,"minLength":20,"type":"string"}}},"DraftCreateRedirectConfiguration":{"description":"The configuration of the draft redirect URLs.","type":"object","properties":{"AfterSendRedirectUrl":{"description":"The URL to redirect to after the envelope was sent successfully.\r\nThis is only applicable when using the eSAW UI.","maxLength":8000,"minLength":0,"type":"string"},"BeforeSendRedirectUrl":{"description":"The URL to redirect to before the envelope is sent.\r\nThis is only applicable when using the eSAW UI.","maxLength":8000,"minLength":0,"type":"string"}}},"DraftCreateActivityActionCallbackConfiguration":{"description":"The configuration of the callback for workstep events.","required":["Url"],"type":"object","properties":{"Url":{"description":"The callback URL triggered for the selected events.","maxLength":8000,"minLength":0,"type":"string"},"ActionCallbackSelection":{"$ref":"#/definitions/DraftCreateActionCallbackSelection","description":"The selection of events which trigger the callback."}}},"DraftCreateAgentRedirectConfiguration":{"description":"The configuration of the redirects for the agent mode.","type":"object","properties":{"Policy":{"description":"Defines the redirect target page which should be opened when the agent mode is active. \r\nMust not be set, when 'Allow' is not set to true.","enum":["Workflow","FormEditor","Summary"],"type":"string"},"Allow":{"description":"If true, the agent mode can be used. \r\nIf false, both 'Policy'and 'IFrameAllowList' must not be set.","type":"boolean"},"IFrameAllowList":{"description":"The URLs where the designer interface of eSignAnyWhere may be embedded.\r\nMust not be set, when 'Allow' is not set to true.","maxItems":50,"type":"array","items":{"maxLength":8000,"type":"string"}}}},"DraftCreateAgreementTranslation":{"description":"A translation for the agreement.","required":["LanguageCode","Text"],"type":"object","properties":{"LanguageCode":{"description":"The language of the translated agreement.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string","x-ms-enum":{"name":"LanguageCode","modelAsString":false}},"Text":{"description":"The translated agreement.","maxLength":204800,"minLength":0,"type":"string"},"Header":{"description":"The header for the translated agreement.","maxLength":1000,"minLength":0,"type":"string"},"IsDefault":{"description":"If true, this translation is used as default.","type":"boolean"}}},"DraftCreateFieldValidation":{"description":"The configuration of the field validation rules.","type":"object","properties":{"Type":{"description":"The type of the value.","enum":["None","Date","Email","Number","Phone","Time"],"type":"string","x-ms-enum":{"name":"FieldValidationType","modelAsString":false}},"DateValidationConfiguration":{"$ref":"#/definitions/DraftCreateDateValidationConfiguration","description":"The validation rules for dates."},"NumberValidationConfiguration":{"$ref":"#/definitions/DraftCreateNumberValidationConfiguration","description":"The validation rules for numbers."},"PhoneValidationConfiguration":{"$ref":"#/definitions/DraftCreatePhoneValidationConfiguration","description":"The validation rules for phone numbers."},"TimeValidationConfiguration":{"$ref":"#/definitions/DraftCreateTimeValidationConfiguration","description":"The validation rules for time values."}}},"DraftCreateAllowedSignatureTypes":{"description":"The definition of the allowed signature types for the signature.","type":"object","properties":{"ClickToSign":{"$ref":"#/definitions/DraftCreateClickToSignSignatureType","description":"Allow signing with \"click to sign\"."},"DrawToSign":{"$ref":"#/definitions/DraftCreateDrawToSignSignatureType","description":"Allow signing with \"draw to sign\"."},"TypeToSign":{"$ref":"#/definitions/DraftCreateTypeToSignSignatureType","description":"Allow signing with \"type to sign\"."},"LocalCertificate":{"$ref":"#/definitions/DraftCreateLocalCertificateSignatureType","description":"Allow signing with a local certificate."},"DisposableCertificate":{"$ref":"#/definitions/DraftCreateDisposableCertificateSignatureType","description":"Allow signing with a disposable certificate."},"SwissComOnDemand":{"$ref":"#/definitions/DraftCreateSwissComOnDemandSignatureType","description":"Allow signing with a Swisscom On-Demand certificate."},"ATrustCertificate":{"$ref":"#/definitions/DraftCreateATrustCertificateSignatureType","description":"Allow signing with an A-Trust certificate."},"Biometric":{"$ref":"#/definitions/DraftCreateBiometricSignatureType","description":"Allow signing with a biometric signature."},"RemoteCertificate":{"$ref":"#/definitions/DraftCreateRemoteCertificateSignatureType","description":"Allow signing with a remote certificate."},"OneTimePassword":{"$ref":"#/definitions/DraftCreateOneTimePasswordSignatureType","description":"Allow signing with a one time password (SMS-OTP)."},"SwedishBankId":{"$ref":"#/definitions/DraftCreateSwedishBankIdSignatureType","description":"Allow signing with Swedish BankID."},"SignaturePlugins":{"description":"Allow signing with signature plugins.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/DraftCreateSignaturePluginSignatureType"}}}},"DraftCreateSignatureFieldDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/DraftCreatePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftCreateSize","description":"The size of the element."}}},"DraftCreateSignatureTaskConfiguration":{"description":"The configuration of the signature task.","type":"object","properties":{"StampImprintDateConfiguration":{"$ref":"#/definitions/DraftCreateStampImprintDateConfiguration","description":"The configuration of the stamp imprint date."},"BatchGroup":{"description":"The batch group.","maxLength":500,"minLength":0,"type":"string"}}},"DraftCreateAttachment":{"description":"The configuration of the attachment element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"DisplayIconType":{"description":"The type of the displayed icon. If no icon is provided Paperclip will be used.","enum":["Paperclip","Graph","PushPin","Tag"],"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftCreateAttachmentDefinition","description":"The definition of the attachment element.\r\nIt must be specified when the attachment element is added.\r\nIt must not be specified when the attachment element already exists."}}},"DraftCreateAttachmentDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/DraftCreatePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftCreateSize","description":"The size of the element."}}},"DraftCreatePredefinedText":{"description":"The configuration of the element showing the predefined text.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Value":{"description":"The value of the predefined text.","maxLength":1000,"minLength":0,"type":"string"},"FieldDefinition":{"$ref":"#/definitions/DraftCreatePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"DraftCreateEmail":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftCreatePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"DraftCreateGivenName":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftCreatePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"DraftCreateSurname":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftCreatePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"DraftCreateFullName":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftCreatePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"DraftCreateDate":{"description":"The configuration of the predefined element showing the date.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DateFormat":{"description":"The format of the date.","maxLength":50,"minLength":0,"type":"string"},"FieldDefinition":{"$ref":"#/definitions/DraftCreatePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"DraftCreateHyperLink":{"description":"The definition of the hyperlink element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Uri":{"description":"The URI of the hyperlink.","maxLength":8000,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftCreateLinkDefinition","description":"The definition of the hyperlink element.\r\nIt must be specified when the hyperlink element is added.\r\nIt must not be specified when the hyperlink element already exists."}}},"DraftCreateReadingAreaDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/DraftCreatePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftCreateSize","description":"The size of the element."}}},"DraftCreateSendCopy":{"description":"An action to send a copy of the documents to the recipient.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/DraftCreateBasicRecipientConfiguration","description":"The configuration of the recipient."},"CopyingGroup":{"description":"The group for defining parallel copy actions.","maxLength":500,"minLength":0,"type":"string"}}},"DraftCreateView":{"description":"An action to view and acknowledge the documents.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/DraftCreateRecipientConfiguration","description":"The configuration of the recipient."},"ViewingGroup":{"description":"The group for defining parallel view actions.","maxLength":500,"minLength":0,"type":"string"},"GeneralPoliciesOverrides":{"$ref":"#/definitions/DraftCreateGeneralPoliciesForViewAction","description":"Viewer policy settings for override."}}},"DraftCreateSignAsP7M":{"description":"An action to sign the documents with P7M.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/DraftCreateAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"SignatureMethods":{"$ref":"#/definitions/DraftCreateP7MSignatureMethods","description":"The configuration of recipient data for P7M signatures."},"SignAsP7MGroup":{"description":"The group for defining parallel P7M actions.","maxLength":500,"minLength":0,"type":"string"},"GeneralPoliciesOverrides":{"$ref":"#/definitions/DraftCreateGeneralPoliciesForP7MAction","description":"Viewer policy settings for override."}}},"DraftCreateDateValidationConfiguration":{"description":"The validation rules for dates.","type":"object","properties":{"DateFormat":{"description":"The format of the dates.","maxLength":50,"minLength":0,"type":"string"},"Range":{"$ref":"#/definitions/DraftCreateFieldValidationRange","description":"The range of the values."}}},"DraftCreateTimeValidationConfiguration":{"description":"The validation rules for time values.","type":"object","properties":{"TimeFormat":{"description":"The format of the time values.","maxLength":50,"minLength":0,"type":"string"},"Range":{"$ref":"#/definitions/DraftCreateFieldValidationRange","description":"The range of the values."}}},"DraftCreatePosition":{"description":"The position of an element on the document.","required":["X","Y"],"type":"object","properties":{"PageNumber":{"format":"int32","description":"The number of the page where the element is located. It starts with 1.","type":"integer"},"X":{"format":"double","description":"The X coordinate in points. It starts from the left.","type":"number"},"Y":{"format":"double","description":"The Y coordinate in points. It starts from the bottom.","type":"number"}}},"DraftCreateSize":{"description":"The definition of the size of an element.","required":["Width","Height"],"type":"object","properties":{"Width":{"format":"double","description":"The width of the element in points.","type":"number"},"Height":{"format":"double","description":"The height of the element in points.","type":"number"}}},"DraftCreateChoiceItem":{"description":"The configuration of the choice item.","required":["DisplayValue"],"type":"object","properties":{"ExportValue":{"description":"The value of the element when the choice item is selected.","maxLength":500,"minLength":0,"type":"string"},"DisplayValue":{"description":"The displayed value of the choice item.","maxLength":500,"minLength":0,"type":"string"}}},"DraftCreatePredefinedElementDefinition":{"description":"The configuration of the predefined element.","required":["Position","Size"],"type":"object","properties":{"TextFormat":{"$ref":"#/definitions/DraftCreateTextFormat","description":"The configuration of the text format."},"Position":{"$ref":"#/definitions/DraftCreatePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftCreateSize","description":"The size of the element."}}},"DraftCreateLinkDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/DraftCreatePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftCreateSize","description":"The size of the element."}}},"DraftCreateBasicRecipientConfiguration":{"description":"The configuration of the recipient.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/DraftCreateContactInformation","description":"The contact information of the recipient."},"PersonalMessage":{"description":"The personal message for the recipient.","maxLength":204800,"minLength":0,"type":"string"}}},"DraftCreateContactInformation":{"description":"Define the contact information for the recipient.","type":"object","properties":{"Email":{"description":"The email address of the recipient.","maxLength":250,"minLength":0,"pattern":"^[a-zA-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF0-9.!#$%&'*+\\-\\/=?^_`{|}~]+@(?=[a-z0-9A-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF])(?:[a-z0-9A-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF]|(?<![.-])\\.|(?<!\\.)-)*[a-z0-9A-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF]$","type":"string"},"GivenName":{"description":"The given name of the recipient.","maxLength":200,"minLength":0,"type":"string"},"Surname":{"description":"The surname of the recipient.","maxLength":200,"minLength":0,"type":"string"},"PhoneNumber":{"description":"The phone number of the recipient.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"},"LanguageCode":{"description":"The language of the recipient.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string"}}},"DraftCreateSignBulk":{"description":"A sign action for multiple recipients.","type":"object","properties":{"BulkRecipients":{"description":"The recipients that are part of the bulk.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftCreateBulkRecipient"}},"SequenceMode":{"description":"The sequence mode.","enum":["NoSequenceEnforced","SequenceEnforced"],"type":"string"},"Elements":{"$ref":"#/definitions/DraftCreateElements","description":"The elements in the document (e.g. form fields) assigned to the recipient."},"FinishActionConfiguration":{"$ref":"#/definitions/DraftCreateFinishAction","description":"Defines what happens in the signing clients, after an action has been finished."},"BatchConfiguration":{"$ref":"#/definitions/DraftCreateBatchConfiguration","description":"The configuration of a signing batch."},"GeneralPoliciesOverrides":{"$ref":"#/definitions/DraftCreateGeneralPoliciesForSignAction","description":"Viewer policy settings for override."}}},"DraftCreateFinishAction":{"description":"Define what happens in the signing clients, after an action has been finished.","type":"object","properties":{"SignAnyWhereViewer":{"$ref":"#/definitions/DraftCreateClientFinishAction","description":"The actions for the SAW Viewer."},"SignificantClientSignatureCaptureForIos":{"$ref":"#/definitions/DraftCreateAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for iOS."},"SignificantClientSignatureCaptureForAndroid":{"$ref":"#/definitions/DraftCreateAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for Android."},"SignificantClientSignatureCaptureForWindows":{"$ref":"#/definitions/DraftCreateAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for Windows."},"KioskSdk":{"$ref":"#/definitions/DraftCreateKioskFinishAction","description":"The actions for the SIGNificant Kiosk SDK."}}},"DraftCreateSignatureDataConfiguration":{"description":"The recipient configuration for signing.","type":"object","properties":{"DisposableCertificate":{"$ref":"#/definitions/DraftCreateDisposableCertificateSignatureData","description":"The disposable certificate configuration for the action."},"RemoteCertificate":{"$ref":"#/definitions/DraftCreateRemoteCertificateSignatureData","description":"The remote certificate configuration for the action."},"SwissComOnDemand":{"$ref":"#/definitions/DraftCreateSwissComOnDemandSignatureData","description":"The Swisscom On-Demand certificate configuration for the action."},"SmsOneTimePassword":{"$ref":"#/definitions/DraftCreateSmsOneTimePasswordSignatureData","description":"The one time password configuration for the action (SMS-OTP)."},"ATrustCertificate":{"$ref":"#/definitions/DraftCreateATrustCertificateSignatureData","description":"The A-Trust certificate configuration for the action."},"SwedishBankId":{"$ref":"#/definitions/DraftCreateSwedishBankIdSignatureData","description":"The Swedish BankID configuration for the action."},"SignaturePluginData":{"description":"The signature plugin configurations for the action.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/DraftCreateSignaturePluginSignatureData"}}}},"DraftCreateBatchConfiguration":{"description":"The configuration of a signing batch.","type":"object","properties":{"Mode":{"description":"The mode, that will be used for batch signing.","enum":["Basic","OptIn","OptOut","OptOutWithRequiredAlwaysSelected","OptInWithRequiredAlwaysSelected"],"type":"string","x-ms-enum":{"name":"BatchMode","modelAsString":false}},"RequireScrollingOverAllSignaturesBeforeSigning":{"description":"If true, the user has to review all signatures in the batch signing dialog before signing.\r\nThis is only applicable when the <code>Mode<\/code> is set to <code>OptIn<\/code> or <code>OptOut<\/code>.","type":"boolean"}}},"DraftCreateBulkRecipient":{"description":"The definition of the recipient including the signature data.","required":["RecipientConfiguration"],"type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/DraftCreateAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"SignatureDataConfiguration":{"$ref":"#/definitions/DraftCreateSignatureDataConfiguration","description":"The configuration of the signature data for the recipient."}}},"DraftCreateFieldValidationRange":{"description":"The validation rules for a value range.","type":"object","properties":{"From":{"description":"The lower boundary of the range.","maxLength":100,"minLength":0,"type":"string"},"To":{"description":"The upper boundary of the range.","maxLength":100,"minLength":0,"type":"string"}}},"DraftCreateNumberValidationConfiguration":{"description":"The validation rules for numbers.","type":"object","properties":{"DecimalDigits":{"description":"The expected amount of decimal digits.","type":"integer"},"Symbol":{"description":"The expected symbol.","maxLength":5,"minLength":0,"type":"string"},"SymbolLocation":{"description":"The defined symbol location.","enum":["Start","StartWithBlank","End","EndWithBlank"],"type":"string"},"GroupSeparator":{"description":"The expected thousands separator.","enum":["Comma","Point","Apostrophe","Blank","None"],"type":"string"},"DecimalSeparator":{"description":"The expected decimal separator.","enum":["Comma","Point","Apostrophe","None"],"type":"string","x-ms-enum":{"name":"DecimalSeparatorType","modelAsString":false}},"Range":{"$ref":"#/definitions/DraftCreateFieldValidationRange","description":"The range of the values."}}},"DraftCreatePhoneValidationConfiguration":{"description":"The validation rules for phone numbers.","type":"object","properties":{"Type":{"description":"The format of the phone numbers.","enum":["International","InternationalLeadingZeros","InternationalLeadingPlus"],"type":"string"}}},"DraftCreateActionCallbackSelection":{"description":"The selection of events which trigger the callback.","type":"object","properties":{"ConfirmTransactionCode":{"description":"If true, the callback is triggered when a transaction code was sent. This is only used for legacy disposable certificates, after user accepted issuance of disposable certificate.","type":"boolean"},"AgreementAccepted":{"description":"If true, the callback is triggered when the user accepted the agreement.","type":"boolean"},"AgreementRejected":{"description":"If true, the callback is triggered when the user rejected the agreement.","type":"boolean"},"PrepareAuthenticationSuccess":{"description":"If true, the callback is triggered when the preparation of the authentication process succeeded.","type":"boolean"},"AuthenticationFailed":{"description":"If true, the callback is triggered when the user failed to authenticate.","type":"boolean"},"AuthenticationSuccess":{"description":"If true, the callback is triggered when the user succeeded to authenticate.","type":"boolean"},"AuditTrailRequested":{"description":"If true, the callback is triggered when the audit trail was requested.","type":"boolean"},"AuditTrailXmlRequested":{"description":"If true, the callback is triggered when the audit trail XML was requested.","type":"boolean"},"CalledPage":{"description":"If true, the callback is triggered when the SignAnyWhere Viewer was requested.","type":"boolean"},"DocumentDownloaded":{"description":"If true, the callback is triggered when the document download was requested.","type":"boolean"},"FlattenedDocumentDownloaded":{"description":"If true, the callback is triggered when the flattened document download was requested.","type":"boolean"},"AddedAnnotation":{"description":"If true, the callback is triggered when an annotation was added.","type":"boolean"},"AddedAttachment":{"description":"If true, the callback is triggered when an attachment was added.","type":"boolean"},"AppendedDocument":{"description":"If true, the callback is triggered when a document was appended.","type":"boolean"},"FormsFilled":{"description":"If true, the callback is triggered when a form field was filled.","type":"boolean"},"ConfirmReading":{"description":"If true, the callback is triggered when a reading task was completed.","type":"boolean"},"SendTransactionCode":{"description":"If true, the callback is triggered when a transaction code for a signature with type TransactionCode was sent using the TransactionCodeSenderPlugin.","type":"boolean"},"PrepareSignWorkstepDocument":{"description":"If true, the callback is triggered when a signature was prepared for signing.","type":"boolean"},"SignWorkstepDocument":{"description":"If true, the callback is triggered when a signature was applied.","type":"boolean"},"UndoAction":{"description":"If true, the callback is triggered when an action was undone.","type":"boolean"},"WorkstepCreated":{"description":"If true, the callback is triggered when a workstep was created.","type":"boolean"},"WorkstepFinished":{"description":"If true, the callback is triggered when a workstep was finished.","type":"boolean"},"WorkstepRejected":{"description":"If true, the callback is triggered when a workstep was rejected.","type":"boolean"},"DisablePolicyAndValidityChecks":{"description":"If true, the callback is triggered when policy and validity checks were disabled.","type":"boolean"},"EnablePolicyAndValidityChecks":{"description":"If true, the callback is triggered when policy and validity checks were enabled.","type":"boolean"},"AppendFileToWorkstep":{"description":"If true, the callback is triggered when a file was appended to the workstep.","type":"boolean"},"AppendTasksToWorkstep":{"description":"If true, the callback is triggered when a task was added to the workstep.","type":"boolean"},"SetOptionalDocumentState":{"description":"If true, the callback is triggered when an optional document became either active or inactive.","type":"boolean"},"PreparePayloadForBatch":{"description":"If true, the callback is triggered when the payload was prepared for batch signing.","type":"boolean"}}},"DraftCreateTextFormat":{"description":"The configuration of the text format.","type":"object","properties":{"TextColor":{"description":"The color of the text. The default color is black.\r\nSix digit hexadecimal color that starts with # in #RRGGBB format according to CSS Color Module Level 4, paragraph 5.2.","maxLength":7,"minLength":7,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"number"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"Bold":{"description":"If true, the bold font is used.","type":"boolean"},"Italic":{"description":"If true, the italic font is used.","type":"boolean"},"TextAlign":{"description":"The alignment of the text. The default alignment is left.","enum":["Left","Center","Right"],"type":"string"}}},"DraftCreateLocalCertificateSignatureType":{"description":"The configuration of the LocalCertificate signature.","type":"object","properties":{"EnforcePreferredHashAlgorithm":{"description":"If true, the usage of the preferred hash algorithm is enforced.","type":"boolean"},"PreferredHashAlgorithm":{"description":"The preferred hash algorithm.","enum":["Sha256","Sha512"],"type":"string"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftCreateLocalCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftCreateBiometricSignatureType":{"description":"The configuration of the Biometric signature.","type":"object","properties":{"BiometricVerification":{"description":"If true, a biometric verification is performed.","type":"boolean"},"AllowBiometricStoringOnly":{"description":"If true, the biometric signature might be stored without verification.","type":"boolean"},"StoreSignedResponseWithoutBioData":{"description":"If true, the signed response is stored without biometric data.","type":"boolean"},"BiometricServerUserId":{"description":"The identifier of the user on the biometric server.","maxLength":50,"minLength":0,"type":"string"},"SignaturePositioning":{"description":"The allowed positioning of the biometric signature.","enum":["WithinField","OnPage","IntersectsWithField"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"}}},"DraftCreateAuthenticationConfiguration":{"description":"The definition of the authentications of the recipient.","type":"object","properties":{"AccessCode":{"$ref":"#/definitions/DraftCreateAccessCodeAuthentication","description":"The configuration of the authentication with an access code."},"SmsOneTimePassword":{"$ref":"#/definitions/DraftCreateSmsOneTimePasswordAuthentication","description":"The configuration of the authentication with one time password over SMS."},"SwedishBankId":{"$ref":"#/definitions/DraftCreateSwedishBankIdAuthentication","description":"The configuration of the authentication with Swedish BankID."},"OAuthAuthentications":{"description":"The configurations of the authentication with OAuth.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/DraftCreateOAuthAuthentication"}},"SamlAuthentications":{"description":"The configurations of the authentication with SAML.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/DraftCreateSamlAuthentication"}}}},"DraftCreateClientFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RedirectUri":{"description":"The redirect uri.","maxLength":8000,"minLength":0,"type":"string"}}},"DraftCreateAppFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RemoveDocumentFromRecentDocumentList":{"description":"If true, the document will be removed from the recent document list.","type":"boolean"},"CallClientActionOnlyAfterSuccessfulSync":{"description":"If true, the client action will be called only after a successful sync.","type":"boolean"},"CloseApp":{"description":"If true, the app will be closed.","type":"boolean"},"RedirectUri":{"description":"The redirect uri.","maxLength":8000,"minLength":0,"type":"string"}}},"DraftCreateKioskFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RedirectUri":{"description":"The redirect uri.","maxLength":8000,"minLength":0,"type":"string"}}},"DraftCreateRemoteCertificateSignatureData":{"description":"The recipient configuration for signing with a remote certificate.","type":"object","properties":{"UserId":{"description":"The identifier of the user.","maxLength":500,"minLength":0,"type":"string"},"DeviceId":{"description":"The identifier of the device.","maxLength":500,"minLength":0,"type":"string"}}},"DraftCreateSwissComOnDemandSignatureData":{"description":"The recipient configuration for signing with a Swisscom On-Demand certificate.","type":"object","properties":{"PhoneNumber":{"description":"The phone number.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"},"CommonName":{"description":"The name of the certificate that is created or checked.","maxLength":500,"minLength":0,"type":"string"},"Country":{"description":"The country.","maxLength":500,"minLength":0,"type":"string"},"Locality":{"description":"The locality.","maxLength":500,"minLength":0,"type":"string"},"OrganizationUnits":{"description":"The organizational units.","maxItems":228,"type":"array","items":{"maxLength":500,"type":"string"}},"Organization":{"description":"The organization.","maxLength":500,"minLength":0,"type":"string"},"SerialNumber":{"description":"The serial number.","maxLength":500,"minLength":0,"type":"string"},"StateOrProvince":{"description":"The state or province.","maxLength":500,"minLength":0,"type":"string"},"Pseudonym":{"description":"A name or key that uniquely identifies the user.","maxLength":500,"minLength":0,"type":"string"}}},"DraftCreateSmsOneTimePasswordSignatureData":{"description":"The recipient configuration for signing with a one time password sent via SMS.","type":"object","properties":{"PhoneNumber":{"description":"The phone number to which the one time password will be sent.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"}}},"DraftCreateATrustCertificateSignatureData":{"description":"The recipient configuration for signing with an A-Trust certificate.","type":"object","properties":{"PhoneNumber":{"description":"The phone number of the recipient.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"}}},"DraftCreateSwedishBankIdSignatureData":{"description":"The recipient configuration for signing with Swedish BankID.","type":"object","properties":{"PersonalNumber":{"description":"The personal number for signing.","maxLength":500,"minLength":0,"type":"string"},"AllowAnyPersonalNumber":{"description":"If true, the personal number can be edited by the recipient.\r\nIf the personal number is empty and can be edited, a QR code for scanning is provided.","type":"boolean"}}},"DraftCreateSignaturePluginSignatureData":{"description":"The recipient configuration for signing with a signature plugin.","type":"object","properties":{"PluginId":{"description":"The identifier of the signature plugin.","maxLength":500,"minLength":0,"type":"string"},"Fields":{"description":"The plugin parameters referred to as the GSP sender data fields.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/DraftCreateSignaturePluginParameter"}}}},"DraftCreateAccessCodeAuthentication":{"description":"The configuration for authentication with a predefined access code.","type":"object","properties":{"Code":{"description":"The code for authenticating the recipient.","maxLength":500,"minLength":0,"type":"string"}}},"DraftCreateSmsOneTimePasswordAuthentication":{"description":"The configuration for authentication with a one time password sent over SMS.","type":"object","properties":{"PhoneNumber":{"description":"The phone number to which the one time password will be sent.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"}}},"DraftCreateSwedishBankIdAuthentication":{"description":"The configuration for Swedish BankID authentication.","type":"object","properties":{"PersonalNumber":{"description":"The personal number for the authentication.","maxLength":500,"minLength":0,"type":"string"},"AllowAnyPersonalNumber":{"description":"If true, the personal number can be edited by the recipient.\r\nIf the personal number is empty and can be edited, a QR code for scanning is provided.","type":"boolean"}}},"DraftCreateOAuthAuthentication":{"description":"The configuration for authentication with an OAuth provider.","type":"object","properties":{"ProviderName":{"description":"The name of the OAuth provider.","maxLength":500,"minLength":0,"type":"string"},"Validations":{"description":"The validation rules for the OAuth response.","maxItems":100,"type":"array","items":{"$ref":"#/definitions/DraftCreateAuthenticationValidation"}}}},"DraftCreateSamlAuthentication":{"description":"The configuration for authentication with a SAML provider.","type":"object","properties":{"ProviderName":{"description":"The name of the SAML provider.","maxLength":500,"minLength":0,"type":"string"},"Validations":{"description":"The validation rules for the SAML response.","maxItems":100,"type":"array","items":{"$ref":"#/definitions/DraftCreateAuthenticationValidation"}}}},"DraftCreateDisposableCertificateSignatureData":{"description":"The recipient configuration for signing with a disposable certificate.","type":"object","properties":{"DocumentIssuingCountry":{"description":"The issuing country of the document.\r\nWill be used as country of residence, if lean is disabled.","maxLength":500,"minLength":0,"type":"string"},"IdentificationIssuingCountry":{"description":"The issuing country of the identification.","maxLength":500,"minLength":0,"type":"string"},"IdentificationType":{"description":"The type of identification in use.","enum":["None","ForeignTaxCode","PersonalNumber","Passport","NationalIdentityCard","ItalianTaxCode","NoSerialNumber","DrivingLicense","ResidencePermit","TemporaryResidencePermit","EmbassyDocument","AML"],"type":"string","x-ms-enum":{"name":"DisposableCertificateIdentificationType","modelAsString":false}},"PhoneNumber":{"description":"The phone number registered for identification.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"},"DocumentType":{"description":"The type of document used for the identification.","enum":["IdentityCard","DriverLicense","Passport","ResidencePermit","NationalElectronicIdentityCard","TemporaryResidencePermit","EmbassyDocument"],"type":"string"},"DocumentIssuedBy":{"description":"The authority that issued the document.","maxLength":500,"minLength":0,"type":"string"},"DocumentIssuedOn":{"format":"date","description":"The date when the document has been issued.\r\nA date in the format RFC 3339, section 5.6, 'full-date' (e.g. 2017-07-21).","maxLength":10,"minLength":10,"type":"string"},"DocumentExpiryDate":{"format":"date","description":"The expiration date of the document.\r\nA date in the format RFC 3339, section 5.6, 'full-date' (e.g. 2017-07-21).","maxLength":10,"minLength":10,"type":"string"},"SerialNumber":{"description":"The serial number of the certificate.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"description":"The identifier of the document.","maxLength":500,"minLength":0,"type":"string"}}},"DraftCreateSignaturePluginParameter":{"description":"The definition of a signature plugin parameter.","type":"object","properties":{"Key":{"description":"The identifier of the parameter.","maxLength":500,"minLength":0,"type":"string"},"Value":{"description":"The value of the parameter.","maxLength":500,"minLength":0,"type":"string"}}},"DraftCreateAuthenticationValidation":{"description":"A validation rule for an authentication response.","type":"object","properties":{"FieldReferenceId":{"description":"The identifier of the field.","maxLength":500,"minLength":0,"type":"string"},"ExpectedValue":{"description":"The expected value of the field.","maxLength":500,"minLength":0,"type":"string"}}},"DraftCreateSwedishBankIdStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayTransactionId":{"description":"If true, the transaction identifier is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftCreateOneTimePasswordStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayTransactionId":{"description":"If true, the transaction identifier is displayed.","type":"boolean"},"DisplayTransactionToken":{"description":"If true, the transaction token is displayed.","type":"boolean"},"DisplayPhoneNumber":{"description":"If true, the phone number of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftCreateRemoteCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftCreateSwissComOnDemandStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftCreateDisposableCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftCreateLocalCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftCreateTypeToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftCreateDrawToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftCreateClickToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftCreateGeneralPoliciesForP7MAction":{"description":"Define the general policies allowed for P7M action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"},"AllowAdhocPdfAttachments":{"description":"If true, the client is allowed to append adhoc documents.","type":"boolean"},"AllowRejectWorkstep":{"description":"If true, the client is allowed to reject the workstep.","type":"boolean"},"AllowUndoLastAction":{"description":"If true, the client is allowed to undo actions.","type":"boolean"},"AllowDownloadOfSignedP7MFiles":{"description":"If true, the client is allowed to download signed p7m files.","type":"boolean"}}},"DraftCreateP7MSignatureMethods":{"description":"The recipient configuration for signing with P7M.","type":"object","properties":{"LocalCertificate":{"description":"If true, a local certificate can be used.","type":"boolean"},"DisposableCertificate":{"$ref":"#/definitions/DraftCreateDisposableCertificateSignatureData","description":"The disposable certificate configuration for the action."},"RemoteCertificate":{"$ref":"#/definitions/DraftCreateRemoteCertificateSignatureData","description":"The remote certificate configuration for the action."},"SignaturePluginData":{"description":"The signature plugin configurations for the action.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/DraftCreateSignaturePluginSignatureData"}}}},"DraftCreateGeneralPoliciesForViewAction":{"description":"Define the general policies allowed for view action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"}}},"DraftCreateRecipientConfiguration":{"description":"The configuration of the recipient.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/DraftCreateContactInformation","description":"The contact information of the recipient."},"PersonalMessage":{"description":"The personal message for the recipient.","maxLength":204800,"minLength":0,"type":"string"},"AuthenticationConfiguration":{"$ref":"#/definitions/DraftCreateAuthenticationConfiguration","description":"The configuration for the authentication of the recipient."},"SendEmails":{"description":"If true, emails will be sent out for this recipient.","type":"boolean"},"AllowAccessAfterFinish":{"description":"If true, the recipient is allowed to access the action after it has been finished.\r\nIt is required that the organization has the AllowAccessFinishedWorkstep feature enabled.\r\nThe default value is taken from the OrganizationSettings.","type":"boolean"}}},"DraftCreateGeneralPoliciesForSignAction":{"description":"Define the general policies allowed for sign action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"},"AllowAdhocPdfAttachments":{"description":"If true, the client is allowed to append adhoc documents.","type":"boolean"},"AllowRejectWorkstep":{"description":"If true, the client is allowed to reject the workstep.","type":"boolean"},"AllowUndoLastAction":{"description":"If true, the client is allowed to undo actions.","type":"boolean"}}},"DraftCreateAdvancedRecipientConfiguration":{"description":"The advanced configuration for the recipient.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/DraftCreateContactInformation","description":"The contact information of the recipient."},"PersonalMessage":{"description":"The personal message for the recipient.","maxLength":204800,"minLength":0,"type":"string"},"AuthenticationConfiguration":{"$ref":"#/definitions/DraftCreateAuthenticationConfiguration","description":"The configuration for the authentication of the recipient."},"SendEmails":{"description":"If true, emails will be sent out for this recipient.","type":"boolean"},"AllowAccessAfterFinish":{"description":"If true, the recipient is allowed to access the action after it has been finished.\r\nIt is required that the organization has the AllowAccessFinishedWorkstep feature enabled.\r\nThe default value is taken from the OrganizationSettings.","type":"boolean"},"RequireViewContentBeforeFormFilling":{"description":"If true, the signer has to confirm the reading of all documents as first task.","type":"boolean"},"IncludedEmailAppLinks":{"$ref":"#/definitions/DraftCreateEmailAppLinks","description":"The configuration for mobile app links in email messages."},"AllowDelegation":{"description":"If true, the recipient may delegate this activity to another person.","type":"boolean"}}},"DraftCreateVisibleSignature":{"description":"A signature with a visual appearance on the document.","required":["FieldDefinition"],"type":"object","properties":{"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"UseExternalTimestampServer":{"description":"If true, a timestamp from an external server is embedded into the signature.","type":"boolean"},"FieldDefinition":{"$ref":"#/definitions/DraftCreateSignatureFieldDefinition","description":"The definition of the signature field.\r\nIt must be specified when the signature field is added.\r\nIt must not be specified when the signature field already exists."}}},"DraftCreateStampImprintDateConfiguration":{"description":"The configuration of the stamp imprint date.","type":"object","properties":{"UseLocalTimezone":{"description":"If true, the local timezone is used.","type":"boolean"},"DateTimeFormat":{"description":"The format of the timestamp.","maxLength":50,"minLength":0,"type":"string"}}},"DraftCreateSignaturePluginSignatureType":{"description":"The configuration of the signature plugin.","type":"object","properties":{"PluginId":{"description":"The identifier of the plugin.","maxLength":500,"minLength":0,"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftCreatePluginStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftCreateSwedishBankIdSignatureType":{"description":"The configuration of the signature.","type":"object","properties":{"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftCreateSwedishBankIdStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftCreateOneTimePasswordSignatureType":{"description":"The configuration of the OneTimePassword signature.","type":"object","properties":{"ValidityInSeconds":{"description":"The validity of the password in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftCreateOneTimePasswordStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftCreateRemoteCertificateSignatureType":{"description":"The configuration of the RemoteCertificate signature.","type":"object","properties":{"ValidityInSeconds":{"description":"The validity of the certificate in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftCreateRemoteCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftCreateATrustCertificateSignatureType":{"description":"The configuration of the A-Trust certificate signature.","type":"object","properties":{"TemplateId":{"description":"The identifier of the A-Trust template.","maxLength":500,"minLength":0,"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"}}},"DraftCreateSwissComOnDemandSignatureType":{"description":"The configuration of the Swisscom On-Demand signature.","type":"object","properties":{"ValidityInSeconds":{"description":"The validity of the certificate in seconds.","type":"integer"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftCreateSwissComOnDemandStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftCreateDisposableCertificateSignatureType":{"description":"The configuration of the DisposableCertificate signature.","type":"object","properties":{"IsLongLived":{"description":"If true, the disposable certificate is long lived.","type":"boolean"},"ValidityInSeconds":{"description":"The validity of the certificate in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftCreateDisposableCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftCreateTypeToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftCreateTypeToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftCreateDrawToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftCreateDrawToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftCreateClickToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftCreateClickToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftCreateRadioButtonItemDefinition":{"description":"The configuration of the radio button.","required":["Position","Size"],"type":"object","properties":{"ExportValue":{"description":"The value of the element when the radio button is checked.","maxLength":500,"minLength":0,"type":"string"},"IsChecked":{"description":"If true, the radio button is checked by default.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/DraftCreatePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftCreateSize","description":"The size of the element."}}},"DraftCreateSign":{"description":"A sign action for the recipient.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/DraftCreateAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"SequenceMode":{"description":"The sequence mode.","enum":["NoSequenceEnforced","SequenceEnforced"],"type":"string"},"Elements":{"$ref":"#/definitions/DraftCreateElements","description":"The elements in the document (e.g. form fields) assigned to the recipient."},"FinishActionConfiguration":{"$ref":"#/definitions/DraftCreateFinishAction","description":"Defines what happens in the signing clients, after an action has been finished."},"SignatureDataConfiguration":{"$ref":"#/definitions/DraftCreateSignatureDataConfiguration","description":"The configuration of recipient data for special signatures."},"BatchConfiguration":{"$ref":"#/definitions/DraftCreateBatchConfiguration","description":"The configuration of a signing batch."},"SigningGroup":{"description":"The group for defining parallel sign actions.","maxLength":500,"minLength":0,"type":"string"},"GeneralPoliciesOverrides":{"$ref":"#/definitions/DraftCreateGeneralPoliciesForSignAction","description":"Viewer policy settings for override."}}},"DraftCreateSignAutomatic":{"description":"An automatic signing action.","type":"object","properties":{"ProfileId":{"description":"The identifier of the profile for the automatic signatures.","maxLength":500,"minLength":0,"type":"string"},"RenderingLanguageCode":{"description":"The rendering language for the automatic signatures.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string"},"VisibleSignatures":{"description":"The visible signatures define the optional visual representations for automatic signatures.\r\nIf none are defined, the automatic signatures are applied to the documents without a visual element.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/DraftCreateVisibleSignature"}}}},"DraftCreateInitials":{"description":"The configuration of the predefined element showing the initials.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"IncludeMiddleNameInitials":{"description":"If true, the initials from the middle names are included as well. \r\nThe initials are read from the given name. Additional names are expected to be separated by a space.","type":"boolean"},"FieldDefinition":{"$ref":"#/definitions/DraftCreatePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"DraftCreateListBoxDefinition":{"description":"The configuration of the list box.","required":["Items","Position","Size"],"type":"object","properties":{"TextFormat":{"$ref":"#/definitions/DraftCreateTextFormat","description":"The configuration of the text format."},"Items":{"description":"A list of items that can be selected for the element.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/DraftCreateChoiceItem"}},"IsMultiSelect":{"description":"If true, multiple values of the list box can be selected.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/DraftCreatePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftCreateSize","description":"The size of the element."}}},"DraftCreateRadioButtonGroupDefinition":{"description":"The configuration of the radio button group definition.","type":"object","properties":{"IsSelectUnison":{"description":"If true, radiobuttons with the same <code>ExportValue<\/code> are checked and unchecked together.","type":"boolean"},"Items":{"description":"The list of radio buttons that belong to the same group.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/DraftCreateRadioButtonItemDefinition"}}}},"DraftCreateComboBoxDefinition":{"description":"The configuration of the combo box.","required":["Items","Position","Size"],"type":"object","properties":{"TextFormat":{"$ref":"#/definitions/DraftCreateTextFormat","description":"The configuration of the text format."},"Items":{"description":"A list of items that can be selected for the element.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/DraftCreateChoiceItem"}},"IsEditable":{"description":"If true, the combo box is editable.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/DraftCreatePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftCreateSize","description":"The size of the element."}}},"DraftCreateCheckBoxDefinition":{"description":"The configuration of a check box.","required":["Position","Size"],"type":"object","properties":{"ExportValue":{"description":"The value of the check box when it is checked.","maxLength":500,"minLength":0,"type":"string"},"Position":{"$ref":"#/definitions/DraftCreatePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftCreateSize","description":"The size of the element."},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"}}},"DraftCreateTextBoxDefinition":{"description":"The configuration of the text box.","required":["Position","Size"],"type":"object","properties":{"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"MaxLength":{"description":"The maximum length of the text.","type":"integer"},"IsMultiline":{"description":"If true, the text box can have multiple lines.","type":"boolean"},"IsPassword":{"description":"If true, the text box behaves like a password input field and does not show the actually entered characters.","type":"boolean"},"TextFormat":{"$ref":"#/definitions/DraftCreateTextFormat","description":"The configuration of the text format."},"Position":{"$ref":"#/definitions/DraftCreatePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftCreateSize","description":"The size of the element."}}},"DraftCreateDefaultSignature":{"description":"The configuration of the default signature type for a draft.","type":"object","properties":{"IsDefault":{"description":"If true, this signature type is used for newly added signature fields as default.\r\nOnly one signature type can be set as default.","type":"boolean"}}},"DraftCreateReadDocumentConfirmation":{"description":"The document which has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"}}},"DraftCreateReadPagesConfirmation":{"description":"The page which has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"PageNumber":{"format":"int32","description":"The number of the page that needs to be read. Starting with 1.","type":"integer"},"GuidingOrder":{"description":"The order of the element.","type":"integer"}}},"DraftCreateReadAreaConfirmation":{"description":"The area that has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"Definition":{"$ref":"#/definitions/DraftCreateReadingAreaDefinition","description":"The definition of the area.\r\nWhen adding a new element, it has to be specified .\r\nWhen the field already exists, it must not be specified."}}},"DraftCreateSignatureField":{"description":"The configuration of the signature field.","required":["ElementId"],"type":"object","properties":{"ElementId":{"description":"The identifier of the signature.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"FieldDescription":{"description":"The description of the signature.","maxLength":500,"minLength":0,"type":"string"},"UseExternalTimestampServer":{"description":"If true, a timestamp from an external server is embedded into the signature.","type":"boolean"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"AllowedSignatureTypes":{"$ref":"#/definitions/DraftCreateAllowedSignatureTypes","description":"The allowed types for the signature."},"FieldDefinition":{"$ref":"#/definitions/DraftCreateSignatureFieldDefinition","description":"The definition of the signature field.\r\nIt must be specified when the signature field is added.\r\nIt must not be specified when the signature field already exists."},"TaskConfiguration":{"$ref":"#/definitions/DraftCreateSignatureTaskConfiguration","description":"The configuration of the task."}}},"DraftCreateListBox":{"description":"The configuration of the list box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"PreSelectedItems":{"description":"The export values of the items which should be initially selected.","maxItems":50,"type":"array","items":{"maxLength":500,"type":"string"}},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftCreateListBoxDefinition","description":"The definition of the list box field.\r\nIt must be specified when the list box is added.\r\nIt must not be specified when the list box already exists."}}},"DraftCreateRadioButtonGroup":{"description":"The configuration of the radio button group.","type":"object","properties":{"GroupName":{"description":"The name of the radio button group.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"SelectedItem":{"description":"The export value of the selected item of the radio button group.","maxLength":500,"minLength":0,"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftCreateRadioButtonGroupDefinition","description":"The definition of the radio button group.\r\nIt must be specified when the radio button group is added.\r\nIt must not be specified when the radio button group already exists."}}},"DraftCreateComboBox":{"description":"The configuration of the combo box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"Value":{"description":"The selected value of the combo box.","maxLength":500,"minLength":0,"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftCreateComboBoxDefinition","description":"The definition of the combo box.\r\nIt must be specified when the combo box is added.\r\nIt must not be specified when the combo box already exists."}}},"DraftCreateCheckBox":{"description":"The configuration of the check box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"IsChecked":{"description":"If true, the check box is checked.","type":"boolean"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftCreateCheckBoxDefinition","description":"The definition of the check box.\r\nIt must be specified when the check box is added.\r\nIt must not be specified when the check box already exists."}}},"DraftCreateTextBox":{"description":"The configuration of the text box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"Value":{"description":"The value of the text box.","maxLength":204800,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"Validation":{"$ref":"#/definitions/DraftCreateFieldValidation","description":"The configuration of the validation rules for the text box value."},"FieldDefinition":{"$ref":"#/definitions/DraftCreateTextBoxDefinition","description":"The definition of the text box.\r\nIt must be specified when the check box is added.\r\nIt must not be specified when the check box already exists."}}},"DraftCreateCallbackConfiguration":{"description":"The configuration of the callbacks for a custom integration.","type":"object","properties":{"CallbackUrl":{"description":"The callback URL triggered when the envelope has been finished.","maxLength":8000,"minLength":0,"type":"string"},"StatusUpdateCallbackUrl":{"description":"The callback URL triggered for status updates of an envelope.","maxLength":8000,"minLength":0,"type":"string"},"AfterSendCallbackUrl":{"description":"The callback URL triggered after sending the draft.","maxLength":8000,"minLength":0,"type":"string"},"ActivityActionCallbackConfiguration":{"$ref":"#/definitions/DraftCreateActivityActionCallbackConfiguration","description":"The configuration of the callback for workstep events."}}},"DraftCreateReminderConfiguration":{"description":"The configuration for reminders.","type":"object","properties":{"Enabled":{"description":"If true, reminders are sent.","type":"boolean"},"FirstReminderInDays":{"description":"The amount of days until a reminder is sent to a signer or a viewer after the initial notification.","type":"integer"},"ReminderResendIntervalInDays":{"description":"The amount of days until a reminder is sent again to a signer or a viewer.","type":"integer"},"BeforeExpirationInDays":{"description":"The amount of days before the envelope expires and a reminder should be sent.","type":"integer"}}},"DraftCreateRequest":{"description":"The model for creating a draft.","required":["Documents","Name","Activities"],"type":"object","properties":{"Documents":{"description":"The documents for the envelope.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/DraftCreateDocument"}},"Name":{"description":"The name of the envelope.","maxLength":100,"minLength":0,"type":"string"},"MetaData":{"description":"The metadata of the envelope.","maxLength":204800,"minLength":0,"type":"string"},"AddDocumentTimestamp":{"description":"If true, a timestamp is added to all documents of the envelope at the end of each signing activity.","type":"boolean"},"ShareWithTeam":{"description":"If true, this envelope is shared with your teams.","type":"boolean"},"LockFormFieldsOnFinish":{"description":"If true, form fields are locked after the envelope is finished.","type":"boolean"},"SendFinishedDocumentsToAllSignersAndMustView":{"description":"If true, every signer and viewer will receive a copy of the finished documents.","type":"boolean"},"UnassignedElements":{"$ref":"#/definitions/DraftCreateElements","description":"The elements which are not assigned to any action."},"Activities":{"description":"The steps for the envelope.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/DraftCreateActivity"}},"EmailConfiguration":{"$ref":"#/definitions/DraftCreateEmailConfiguration","description":"The configuration for notifications."},"ReminderConfiguration":{"$ref":"#/definitions/DraftCreateReminderConfiguration","description":"The configuration for reminders."},"ExpirationConfiguration":{"$ref":"#/definitions/DraftCreateExpirationConfiguration","description":"The configuration of the expiration for the envelope."},"CallbackConfiguration":{"$ref":"#/definitions/DraftCreateCallbackConfiguration","description":"The configuration of the callbacks for a custom integration."},"AgentRedirectConfiguration":{"$ref":"#/definitions/DraftCreateAgentRedirectConfiguration","description":"The configuration of the redirects for the agent mode."},"RedirectConfiguration":{"$ref":"#/definitions/DraftCreateRedirectConfiguration","description":"The configuration of the draft redirect URLs."},"AgreementConfiguration":{"$ref":"#/definitions/DraftCreateAgreementConfiguration","description":"The configuration of the agreement.\r\nRequires that the organization allows custom agreement settings."},"DefaultSignatureTypeConfiguration":{"$ref":"#/definitions/DraftCreateDefaultSignatureTypeConfiguration","description":"A default signature type to be used only for the draft that overwrites the default signature type of the organization."},"SealingConfiguration":{"$ref":"#/definitions/DraftCreateSealingConfiguration","description":"The custom sealing configuration for the envelope."}}},"DraftCreateResponse":{"description":"The response model after creating a draft successfully.","type":"object","properties":{"DraftId":{"description":"The identifier of the draft.","type":"string"}}},"DraftDeleteRequest":{"description":"Draft delete model.","required":["DraftId"],"type":"object","properties":{"DraftId":{"description":"The identifier of the draft.","maxLength":36,"minLength":36,"type":"string"}}},"Void":{"type":"object","properties":{}},"DraftUpdateAgreementConfiguration":{"description":"The configuration of the agreement.","type":"object","properties":{"Translations":{"description":"The agreement and its translations to be used.\r\nIf no custom agreement is specified, the default organization agreement will be used.","maxItems":228,"type":"array","items":{"$ref":"#/definitions/DraftUpdateAgreementTranslation"}}}},"DraftUpdateDefaultSignatureTypeConfiguration":{"description":"The configuration of the default signature type for the draft.","type":"object","properties":{"None":{"$ref":"#/definitions/DraftUpdateDefaultSignature","description":"\"None\" SignatureType."},"ClickToSign":{"$ref":"#/definitions/DraftUpdateDefaultSignature","description":"\"click to sign\" SignatureType."},"DrawToSign":{"$ref":"#/definitions/DraftUpdateDefaultSignature","description":"\"draw to sign\" SignatureType."},"TypeToSign":{"$ref":"#/definitions/DraftUpdateDefaultSignature","description":"\"type to sign\" SignatureType."},"LocalCertificate":{"$ref":"#/definitions/DraftUpdateDefaultSignature","description":"\"local certificate\" SignatureType."},"DisposableCertificate":{"$ref":"#/definitions/DraftUpdateDefaultSignature","description":"\"disposable certificate\" SignatureType."},"Biometric":{"$ref":"#/definitions/DraftUpdateDefaultSignature","description":"\"biometric signature\" SignatureType."},"RemoteCertificate":{"$ref":"#/definitions/DraftUpdateDefaultSignature","description":"\"remote certificate\" SignatureType."},"OneTimePassword":{"$ref":"#/definitions/DraftUpdateDefaultSignature","description":"\"one time password (SMS-OTP)\" SignatureType."}}},"DraftUpdateActivityActionCallbackConfiguration":{"description":"The configuration of the callback for workstep events.","required":["Url"],"type":"object","properties":{"Url":{"description":"The callback URL triggered for the selected events.","maxLength":8000,"minLength":0,"type":"string"},"ActionCallbackSelection":{"$ref":"#/definitions/DraftUpdateActionCallbackSelection","description":"The selection of events which trigger the callback."}}},"DraftUpdateAgreementTranslation":{"description":"A translation for the agreement.","required":["LanguageCode","Text"],"type":"object","properties":{"LanguageCode":{"description":"The language of the translated agreement.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string","x-ms-enum":{"name":"LanguageCode","modelAsString":false}},"Text":{"description":"The translated agreement.","maxLength":204800,"minLength":0,"type":"string"},"Header":{"description":"The header for the translated agreement.","maxLength":1000,"minLength":0,"type":"string"},"IsDefault":{"description":"If true, this translation is used as default.","type":"boolean"}}},"DraftUpdateActionCallbackSelection":{"description":"The selection of events which trigger the callback.","type":"object","properties":{"ConfirmTransactionCode":{"description":"If true, the callback is triggered when a transaction code was sent. This is only used for legacy disposable certificates, after user accepted issuance of disposable certificate.","type":"boolean"},"AgreementAccepted":{"description":"If true, the callback is triggered when the user accepted the agreement.","type":"boolean"},"AgreementRejected":{"description":"If true, the callback is triggered when the user rejected the agreement.","type":"boolean"},"PrepareAuthenticationSuccess":{"description":"If true, the callback is triggered when the preparation of the authentication process succeeded.","type":"boolean"},"AuthenticationFailed":{"description":"If true, the callback is triggered when the user failed to authenticate.","type":"boolean"},"AuthenticationSuccess":{"description":"If true, the callback is triggered when the user succeeded to authenticate.","type":"boolean"},"AuditTrailRequested":{"description":"If true, the callback is triggered when the audit trail was requested.","type":"boolean"},"AuditTrailXmlRequested":{"description":"If true, the callback is triggered when the audit trail XML was requested.","type":"boolean"},"CalledPage":{"description":"If true, the callback is triggered when the SignAnyWhere Viewer was requested.","type":"boolean"},"DocumentDownloaded":{"description":"If true, the callback is triggered when the document download was requested.","type":"boolean"},"FlattenedDocumentDownloaded":{"description":"If true, the callback is triggered when the flattened document download was requested.","type":"boolean"},"AddedAnnotation":{"description":"If true, the callback is triggered when an annotation was added.","type":"boolean"},"AddedAttachment":{"description":"If true, the callback is triggered when an attachment was added.","type":"boolean"},"AppendedDocument":{"description":"If true, the callback is triggered when a document was appended.","type":"boolean"},"FormsFilled":{"description":"If true, the callback is triggered when a form field was filled.","type":"boolean"},"ConfirmReading":{"description":"If true, the callback is triggered when a reading task was completed.","type":"boolean"},"SendTransactionCode":{"description":"If true, the callback is triggered when a transaction code for a signature with type TransactionCode was sent using the TransactionCodeSenderPlugin.","type":"boolean"},"PrepareSignWorkstepDocument":{"description":"If true, the callback is triggered when a signature was prepared for signing.","type":"boolean"},"SignWorkstepDocument":{"description":"If true, the callback is triggered when a signature was applied.","type":"boolean"},"UndoAction":{"description":"If true, the callback is triggered when an action was undone.","type":"boolean"},"WorkstepCreated":{"description":"If true, the callback is triggered when a workstep was created.","type":"boolean"},"WorkstepFinished":{"description":"If true, the callback is triggered when a workstep was finished.","type":"boolean"},"WorkstepRejected":{"description":"If true, the callback is triggered when a workstep was rejected.","type":"boolean"},"DisablePolicyAndValidityChecks":{"description":"If true, the callback is triggered when policy and validity checks were disabled.","type":"boolean"},"EnablePolicyAndValidityChecks":{"description":"If true, the callback is triggered when policy and validity checks were enabled.","type":"boolean"},"AppendFileToWorkstep":{"description":"If true, the callback is triggered when a file was appended to the workstep.","type":"boolean"},"AppendTasksToWorkstep":{"description":"If true, the callback is triggered when a task was added to the workstep.","type":"boolean"},"SetOptionalDocumentState":{"description":"If true, the callback is triggered when an optional document became either active or inactive.","type":"boolean"},"PreparePayloadForBatch":{"description":"If true, the callback is triggered when the payload was prepared for batch signing.","type":"boolean"}}},"DraftUpdateDefaultSignature":{"description":"The configuration of the default signature type for a draft.","type":"object","properties":{"IsDefault":{"description":"If true, this signature type is used for newly added signature fields as default.\r\nOnly one signature type can be set as default.","type":"boolean"}}},"DraftUpdateRedirectConfiguration":{"description":"The configuration of the draft redirect URLs.","type":"object","properties":{"AfterSendRedirectUrl":{"description":"The URL to redirect to after the envelope was sent successfully.\r\nThis is only applicable when using the eSAW UI.","maxLength":8000,"minLength":0,"type":"string"},"BeforeSendRedirectUrl":{"description":"The URL to redirect to before the envelope is sent.\r\nThis is only applicable when using the eSAW UI.","maxLength":8000,"minLength":0,"type":"string"}}},"DraftUpdateAgentRedirectConfiguration":{"description":"The configuration of the redirects for the agent mode.","type":"object","properties":{"Policy":{"description":"Defines the redirect target page which should be opened when the agent mode is active. \r\nMust not be set, when 'Allow' is not set to true.","enum":["Workflow","FormEditor","Summary"],"type":"string"},"Allow":{"description":"If true, the agent mode can be used. \r\nIf false, both 'Policy'and 'IFrameAllowList' must not be set.","type":"boolean"},"IFrameAllowList":{"description":"The URLs where the designer interface of eSignAnyWhere may be embedded.\r\nMust not be set, when 'Allow' is not set to true.","maxItems":50,"type":"array","items":{"maxLength":8000,"type":"string"}}}},"DraftUpdateCallbackConfiguration":{"description":"The configuration of the callbacks for a custom integration.","type":"object","properties":{"CallbackUrl":{"description":"The callback URL triggered when the envelope has been finished.","maxLength":8000,"minLength":0,"type":"string"},"StatusUpdateCallbackUrl":{"description":"The callback URL triggered for status updates of an envelope.","maxLength":8000,"minLength":0,"type":"string"},"AfterSendCallbackUrl":{"description":"The callback URL triggered after sending the draft.","maxLength":8000,"minLength":0,"type":"string"},"ActivityActionCallbackConfiguration":{"$ref":"#/definitions/DraftUpdateActivityActionCallbackConfiguration","description":"The configuration of the callback for workstep events."}}},"DraftUpdateExpirationConfiguration":{"description":"The configuration of the expiration for the envelope.","type":"object","properties":{"ExpirationInSecondsAfterSending":{"description":"The relative expiration in seconds after sending the envelope.\r\nMust be a positive number between 600 and the maximum envelope validity located in the system configuration [Configuration key: maxEnvelopeValidityInDays, Default: 2419200 seconds (28 days)].\r\nMust not be defined when property <code>ExpirationDate<\/code> is specified.","type":"integer"},"ExpirationDate":{"format":"date-time","description":"The absolute expiration date of the envelope.\r\nMust not be in the past.\r\nMust not be defined when property <code>ExpirationInSecondsAfterSending<\/code> is specified.\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","maxLength":30,"minLength":20,"type":"string"}}},"DraftUpdateReminderConfiguration":{"description":"The configuration for reminders.","type":"object","properties":{"Enabled":{"description":"If true, reminders are sent.","type":"boolean"},"FirstReminderInDays":{"description":"The amount of days until a reminder is sent to a signer or a viewer after the initial notification.","type":"integer"},"ReminderResendIntervalInDays":{"description":"The amount of days until a reminder is sent again to a signer or a viewer.","type":"integer"},"BeforeExpirationInDays":{"description":"The amount of days before the envelope expires and a reminder should be sent.","type":"integer"}}},"DraftUpdateEmailConfiguration":{"description":"The configuration for notifications.","type":"object","properties":{"Subject":{"description":"The subject of the sign notifications.","maxLength":300,"minLength":0,"type":"string"},"Message":{"description":"The message of the sign notifications.","maxLength":204800,"minLength":0,"type":"string"},"SenderDisplayName":{"description":"The displayed name of the sender in the notifications.","maxLength":200,"minLength":0,"type":"string"}}},"DraftUpdateSealingConfiguration":{"description":"Update Sealing configuration.","type":"object","properties":{"CertificateId":{"description":"Update the referenced Sealing Certificate identifier.","maxLength":36,"minLength":0,"type":"string"}}},"DraftUpdateRequest":{"description":"The request model for updating a draft.","required":["DraftId"],"type":"object","properties":{"DraftId":{"description":"The identifier of the draft.","maxLength":36,"minLength":36,"type":"string"},"Name":{"description":"The name of the envelope.","maxLength":100,"minLength":0,"type":"string"},"MetaData":{"description":"The metadata of the envelope.","maxLength":204800,"minLength":0,"type":"string"},"AddDocumentTimestamp":{"description":"If true, a timestamp is added to all documents of the envelope at the end of each signing activity.","type":"boolean"},"ShareWithTeam":{"description":"If true, this envelope is shared with your teams.","type":"boolean"},"LockFormFieldsOnFinish":{"description":"If true, form fields are locked after the envelope is finished.","type":"boolean"},"SendFinishedDocumentsToAllSignersAndMustView":{"description":"If true, every signer and viewer will receive a copy of the finished documents.","type":"boolean"},"SealingConfiguration":{"$ref":"#/definitions/DraftUpdateSealingConfiguration","description":"The configuration for envelope sealing."},"EmailConfiguration":{"$ref":"#/definitions/DraftUpdateEmailConfiguration","description":"The configuration for notifications."},"ReminderConfiguration":{"$ref":"#/definitions/DraftUpdateReminderConfiguration","description":"The configuration for reminders."},"ExpirationConfiguration":{"$ref":"#/definitions/DraftUpdateExpirationConfiguration","description":"The configuration of the expiration for the envelope."},"CallbackConfiguration":{"$ref":"#/definitions/DraftUpdateCallbackConfiguration","description":"The configuration of the callbacks for a custom integration."},"AgentRedirectConfiguration":{"$ref":"#/definitions/DraftUpdateAgentRedirectConfiguration","description":"The configuration of the redirects for the agent mode."},"AgreementConfiguration":{"$ref":"#/definitions/DraftUpdateAgreementConfiguration","description":"The configuration of the agreement.\r\nRequires that the organization allows custom agreement settings."},"RedirectConfiguration":{"$ref":"#/definitions/DraftUpdateRedirectConfiguration","description":"The configuration of the draft redirect URLs."},"DefaultSignatureTypeConfiguration":{"$ref":"#/definitions/DraftUpdateDefaultSignatureTypeConfiguration","description":"A default signature type to be used only for the draft that overwrites the default signature type of the organization."}}},"DraftReorderActivitiesRequest":{"description":"The configuration of the order of the activities within a draft.","required":["DraftId","Activities"],"type":"object","properties":{"DraftId":{"description":"The identifier of the draft.","maxLength":36,"minLength":36,"type":"string"},"Activities":{"description":"Define ALL activities in the expected order.","maxItems":50,"minItems":1,"type":"array","items":{"$ref":"#/definitions/DraftReorderActivitiesActivity"}}}},"DraftReorderActivitiesActivity":{"description":"The definition of a draft activity for reordering.","required":["ActivityId"],"type":"object","properties":{"ActivityId":{"description":"The identifier of the activity.","maxLength":36,"minLength":36,"type":"string"},"Action":{"$ref":"#/definitions/DraftReorderActivitiesAction","description":"Define parallel groups if needed."}}},"DraftReorderActivitiesAction":{"description":"The definition of the parallel group for an action of an activity. Only one may be specified.","type":"object","properties":{"View":{"$ref":"#/definitions/DraftReorderActivitiesView","description":"Define groups for parallel view actions."},"Copy":{"$ref":"#/definitions/DraftReorderActivitiesCopy","description":"Define groups for parallel copy actions."},"Sign":{"$ref":"#/definitions/DraftReorderActivitiesSign","description":"Define groups for parallel sign actions."},"SignAsP7M":{"$ref":"#/definitions/DraftReorderActivitiesSignAsP7M","description":"Define groups for parallel P7M sign actions."}}},"DraftReorderActivitiesView":{"description":"Define groups for parallel view actions.","required":["ViewingGroup"],"type":"object","properties":{"ViewingGroup":{"description":"The group for defining parallel view actions.","maxLength":500,"minLength":0,"type":"string"}}},"DraftReorderActivitiesCopy":{"description":"Define groups for parallel copy actions.","required":["CopyingGroup"],"type":"object","properties":{"CopyingGroup":{"description":"The group for defining parallel copy actions.","maxLength":500,"minLength":0,"type":"string"}}},"DraftReorderActivitiesSign":{"description":"Define groups for parallel signers.","required":["SigningGroup"],"type":"object","properties":{"SigningGroup":{"description":"The group for defining parallel sign actions.","maxLength":500,"minLength":0,"type":"string"}}},"DraftReorderActivitiesSignAsP7M":{"description":"Define groups for parallel P7M actions.","required":["SignAsP7MGroup"],"type":"object","properties":{"SignAsP7MGroup":{"description":"The group for defining parallel P7M actions.","maxLength":500,"minLength":0,"type":"string"}}},"DraftActivityReplaceRequest":{"description":"Define an activity with the possibility of bulk.","required":["ActivityId"],"type":"object","properties":{"ActivityId":{"description":"The identifier of the activity.","maxLength":36,"minLength":36,"type":"string"},"Action":{"$ref":"#/definitions/DraftActivityReplaceAction","description":"The action assigned to the activity."},"VisibilityOptions":{"description":"The document visibility options for the activity.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceVisibilityOption"}}}},"DraftActivityReplaceAction":{"description":"The action of the activity with the possibility to define a bulk. Exactly one definition must be used!","type":"object","properties":{"SendCopy":{"$ref":"#/definitions/DraftActivityReplaceSendCopy","description":"The definition of the copy action."},"SignAutomatic":{"$ref":"#/definitions/DraftActivityReplaceSignAutomatic","description":"The definition of the automatic sign action."},"Sign":{"$ref":"#/definitions/DraftActivityReplaceSign","description":"The definition of the sign action."},"View":{"$ref":"#/definitions/DraftActivityReplaceView","description":"The definition of the view action."},"SignAsP7M":{"$ref":"#/definitions/DraftActivityReplaceSignAsP7M","description":"The definition of the P7M sign action."},"SignBulk":{"$ref":"#/definitions/DraftActivityReplaceSignBulk","description":"The definition of the bulk."}}},"DraftActivityReplaceVisibilityOption":{"description":"The options defining the document visibility.","type":"object","properties":{"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"IsHidden":{"description":"If true, the referenced document is hidden for the activity.","type":"boolean"}}},"DraftActivityReplaceSendCopy":{"description":"An action to send a copy of the documents to the recipient.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/DraftActivityReplaceBasicRecipientConfiguration","description":"The configuration of the recipient."}}},"DraftActivityReplaceView":{"description":"An action to view and acknowledge the documents.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/DraftActivityReplaceRecipientConfiguration","description":"The configuration of the recipient."},"GeneralPoliciesOverrides":{"$ref":"#/definitions/DraftActivityReplaceGeneralPoliciesForViewAction","description":"Viewer policy settings for override."}}},"DraftActivityReplaceSignAsP7M":{"description":"An action to sign the documents with P7M.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/DraftActivityReplaceAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"SignatureMethods":{"$ref":"#/definitions/DraftActivityReplaceP7MSignatureMethods","description":"The configuration of recipient data for P7M signatures."},"GeneralPoliciesOverrides":{"$ref":"#/definitions/DraftActivityReplacePoliciesForP7MAction","description":"Viewer policy settings for override."}}},"DraftActivityReplaceBasicRecipientConfiguration":{"description":"The configuration of the recipient.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/DraftActivityReplaceContactInformation","description":"The contact information of the recipient."},"PersonalMessage":{"description":"The personal message for the recipient.","maxLength":204800,"minLength":0,"type":"string"}}},"DraftActivityReplaceElements":{"description":"The configurable elements of the documents.","type":"object","properties":{"TextBoxes":{"description":"The text boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceTextBox"}},"CheckBoxes":{"description":"The check boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceCheckBox"}},"ComboBoxes":{"description":"The combo boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceComboBox"}},"RadioButtons":{"description":"The radio buttons.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceRadioButtonGroup"}},"ListBoxes":{"description":"The list boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceListBox"}},"Signatures":{"description":"The signatures.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceSignatureField"}},"Attachments":{"description":"The attachments.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceAttachment"}},"PredefinedFieldElements":{"$ref":"#/definitions/DraftActivityReplacePredefinedFieldElements","description":"The predefined field elements."},"LinkConfiguration":{"$ref":"#/definitions/DraftActivityReplaceLinkConfiguration","description":"The links in the documents."},"AreaReadConfirmations":{"description":"The areas which have to be read.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceReadAreaConfirmation"}},"PageReadConfirmations":{"description":"The pages which have to be read.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceReadPagesConfirmation"}},"DocumentReadConfirmations":{"description":"The documents which have to be read.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceReadDocumentConfirmation"}}}},"DraftActivityReplaceFinishAction":{"description":"Define what happens in the signing clients, after an action has been finished.","type":"object","properties":{"SignAnyWhereViewer":{"$ref":"#/definitions/DraftActivityReplaceClientFinishAction","description":"The actions for the SAW Viewer."},"SignificantClientSignatureCaptureForIos":{"$ref":"#/definitions/DraftActivityReplaceAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for iOS."},"SignificantClientSignatureCaptureForAndroid":{"$ref":"#/definitions/DraftActivityReplaceAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for Android."},"SignificantClientSignatureCaptureForWindows":{"$ref":"#/definitions/DraftActivityReplaceAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for Windows."},"KioskSdk":{"$ref":"#/definitions/DraftActivityReplaceKioskFinishAction","description":"The actions for the SIGNificant Kiosk SDK."}}},"DraftActivityReplaceSignatureDataConfiguration":{"description":"The recipient configuration for signing.","type":"object","properties":{"DisposableCertificate":{"$ref":"#/definitions/DraftActivityReplaceDisposableCertificateSignatureData","description":"The disposable certificate configuration for the action."},"RemoteCertificate":{"$ref":"#/definitions/DraftActivityReplaceRemoteCertificateSignatureData","description":"The remote certificate configuration for the action."},"SwissComOnDemand":{"$ref":"#/definitions/DraftActivityReplaceSwissComOnDemandSignatureData","description":"The Swisscom On-Demand certificate configuration for the action."},"SmsOneTimePassword":{"$ref":"#/definitions/DraftActivityReplaceSmsOneTimePasswordSignatureData","description":"The one time password configuration for the action (SMS-OTP)."},"ATrustCertificate":{"$ref":"#/definitions/DraftActivityReplaceATrustCertificateSignatureData","description":"The A-Trust certificate configuration for the action."},"SwedishBankId":{"$ref":"#/definitions/DraftActivityReplaceSwedishBankIdSignatureData","description":"The Swedish BankID configuration for the action."},"SignaturePluginData":{"description":"The signature plugin configurations for the action.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceSignaturePluginSignatureData"}}}},"DraftActivityReplaceBatchConfiguration":{"description":"The configuration of a signing batch.","type":"object","properties":{"Mode":{"description":"The mode, that will be used for batch signing.","enum":["Basic","OptIn","OptOut","OptOutWithRequiredAlwaysSelected","OptInWithRequiredAlwaysSelected"],"type":"string","x-ms-enum":{"name":"BatchMode","modelAsString":false}},"RequireScrollingOverAllSignaturesBeforeSigning":{"description":"If true, the user has to review all signatures in the batch signing dialog before signing.\r\nThis is only applicable when the <code>Mode<\/code> is set to <code>OptIn<\/code> or <code>OptOut<\/code>.","type":"boolean"}}},"DraftActivityReplaceBulkRecipient":{"description":"The definition of the recipient including the signature data.","required":["RecipientConfiguration"],"type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/DraftActivityReplaceAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"SignatureDataConfiguration":{"$ref":"#/definitions/DraftActivityReplaceSignatureDataConfiguration","description":"The configuration of the signature data for the recipient."}}},"DraftActivityReplaceSignatureFieldDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/DraftActivityReplacePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftActivityReplaceSize","description":"The size of the element."}}},"DraftActivityReplaceAuthenticationConfiguration":{"description":"The definition of the authentications of the recipient.","type":"object","properties":{"AccessCode":{"$ref":"#/definitions/DraftActivityReplaceAccessCodeAuthentication","description":"The configuration of the authentication with an access code."},"SmsOneTimePassword":{"$ref":"#/definitions/DraftActivityReplaceSmsOneTimePasswordAuthentication","description":"The configuration of the authentication with one time password over SMS."},"SwedishBankId":{"$ref":"#/definitions/DraftActivityReplaceSwedishBankIdAuthentication","description":"The configuration of the authentication with Swedish BankID."},"OAuthAuthentications":{"description":"The configurations of the authentication with OAuth.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceOAuthAuthentication"}},"SamlAuthentications":{"description":"The configurations of the authentication with SAML.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceSamlAuthentication"}}}},"DraftActivityReplacePredefinedFieldElements":{"description":"Define the predefined fields which will be added and filled by the system.","type":"object","properties":{"TextFields":{"description":"The predefined text fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplacePredefinedText"}},"EmailFields":{"description":"The recipient's email fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceEmail"}},"InitialsFields":{"description":"The recipient's initials fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceInitials"}},"GivenNameFields":{"description":"The recipient's given name fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceGivenName"}},"SurnameFields":{"description":"The recipient's surname fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceSurname"}},"FullNameFields":{"description":"The recipient's full name fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceFullName"}},"DateFields":{"description":"The current date fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceDate"}}}},"DraftActivityReplaceLinkConfiguration":{"description":"The configuration of the link elements.","type":"object","properties":{"HyperLinks":{"description":"The list of hyperlink elements.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceHyperLink"}}}},"DraftActivityReplaceClientFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RedirectUri":{"description":"The redirect uri.","maxLength":8000,"minLength":0,"type":"string"}}},"DraftActivityReplaceAppFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RemoveDocumentFromRecentDocumentList":{"description":"If true, the document will be removed from the recent document list.","type":"boolean"},"CallClientActionOnlyAfterSuccessfulSync":{"description":"If true, the client action will be called only after a successful sync.","type":"boolean"},"CloseApp":{"description":"If true, the app will be closed.","type":"boolean"},"RedirectUri":{"description":"The redirect uri.","maxLength":8000,"minLength":0,"type":"string"}}},"DraftActivityReplaceKioskFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RedirectUri":{"description":"The redirect uri.","maxLength":8000,"minLength":0,"type":"string"}}},"DraftActivityReplaceRemoteCertificateSignatureData":{"description":"The recipient configuration for signing with a remote certificate.","type":"object","properties":{"UserId":{"description":"The identifier of the user.","maxLength":500,"minLength":0,"type":"string"},"DeviceId":{"description":"The identifier of the device.","maxLength":500,"minLength":0,"type":"string"}}},"DraftActivityReplaceSwissComOnDemandSignatureData":{"description":"The recipient configuration for signing with a Swisscom On-Demand certificate.","type":"object","properties":{"PhoneNumber":{"description":"The phone number.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"},"CommonName":{"description":"The name of the certificate that is created or checked.","maxLength":500,"minLength":0,"type":"string"},"Country":{"description":"The country.","maxLength":500,"minLength":0,"type":"string"},"Locality":{"description":"The locality.","maxLength":500,"minLength":0,"type":"string"},"OrganizationUnits":{"description":"The organizational units.","maxItems":228,"type":"array","items":{"maxLength":500,"type":"string"}},"Organization":{"description":"The organization.","maxLength":500,"minLength":0,"type":"string"},"SerialNumber":{"description":"The serial number.","maxLength":500,"minLength":0,"type":"string"},"StateOrProvince":{"description":"The state or province.","maxLength":500,"minLength":0,"type":"string"},"Pseudonym":{"description":"A name or key that uniquely identifies the user.","maxLength":500,"minLength":0,"type":"string"}}},"DraftActivityReplaceSmsOneTimePasswordSignatureData":{"description":"The recipient configuration for signing with a one time password sent via SMS.","type":"object","properties":{"PhoneNumber":{"description":"The phone number to which the one time password will be sent.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"}}},"DraftActivityReplaceATrustCertificateSignatureData":{"description":"The recipient configuration for signing with an A-Trust certificate.","type":"object","properties":{"PhoneNumber":{"description":"The phone number of the recipient.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"}}},"DraftActivityReplaceSwedishBankIdSignatureData":{"description":"The recipient configuration for signing with Swedish BankID.","type":"object","properties":{"PersonalNumber":{"description":"The personal number for signing.","maxLength":500,"minLength":0,"type":"string"},"AllowAnyPersonalNumber":{"description":"If true, the personal number can be edited by the recipient.\r\nIf the personal number is empty and can be edited, a QR code for scanning is provided.","type":"boolean"}}},"DraftActivityReplaceSignaturePluginSignatureData":{"description":"The recipient configuration for signing with a signature plugin.","type":"object","properties":{"PluginId":{"description":"The identifier of the signature plugin.","maxLength":500,"minLength":0,"type":"string"},"Fields":{"description":"The plugin parameters referred to as the GSP sender data fields.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceSignaturePluginParameter"}}}},"DraftActivityReplacePosition":{"description":"The position of an element on the document.","required":["X","Y"],"type":"object","properties":{"PageNumber":{"format":"int32","description":"The number of the page where the element is located. It starts with 1.","type":"integer"},"X":{"format":"double","description":"The X coordinate in points. It starts from the left.","type":"number"},"Y":{"format":"double","description":"The Y coordinate in points. It starts from the bottom.","type":"number"}}},"DraftActivityReplaceSize":{"description":"The definition of the size of an element.","required":["Width","Height"],"type":"object","properties":{"Width":{"format":"double","description":"The width of the element in points.","type":"number"},"Height":{"format":"double","description":"The height of the element in points.","type":"number"}}},"DraftActivityReplaceAccessCodeAuthentication":{"description":"The configuration for authentication with a predefined access code.","type":"object","properties":{"Code":{"description":"The code for authenticating the recipient.","maxLength":500,"minLength":0,"type":"string"}}},"DraftActivityReplaceSmsOneTimePasswordAuthentication":{"description":"The configuration for authentication with a one time password sent over SMS.","type":"object","properties":{"PhoneNumber":{"description":"The phone number to which the one time password will be sent.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"}}},"DraftActivityReplaceSwedishBankIdAuthentication":{"description":"The configuration for Swedish BankID authentication.","type":"object","properties":{"PersonalNumber":{"description":"The personal number for the authentication.","maxLength":500,"minLength":0,"type":"string"},"AllowAnyPersonalNumber":{"description":"If true, the personal number can be edited by the recipient.\r\nIf the personal number is empty and can be edited, a QR code for scanning is provided.","type":"boolean"}}},"DraftActivityReplaceOAuthAuthentication":{"description":"The configuration for authentication with an OAuth provider.","type":"object","properties":{"ProviderName":{"description":"The name of the OAuth provider.","maxLength":500,"minLength":0,"type":"string"},"Validations":{"description":"The validation rules for the OAuth response.","maxItems":100,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceAuthenticationValidation"}}}},"DraftActivityReplaceSamlAuthentication":{"description":"The configuration for authentication with a SAML provider.","type":"object","properties":{"ProviderName":{"description":"The name of the SAML provider.","maxLength":500,"minLength":0,"type":"string"},"Validations":{"description":"The validation rules for the SAML response.","maxItems":100,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceAuthenticationValidation"}}}},"DraftActivityReplaceFieldValidation":{"description":"The configuration of the field validation rules.","type":"object","properties":{"Type":{"description":"The type of the value.","enum":["None","Date","Email","Number","Phone","Time"],"type":"string","x-ms-enum":{"name":"FieldValidationType","modelAsString":false}},"DateValidationConfiguration":{"$ref":"#/definitions/DraftActivityReplaceDateValidationConfiguration","description":"The validation rules for dates."},"NumberValidationConfiguration":{"$ref":"#/definitions/DraftActivityReplaceNumberValidationConfiguration","description":"The validation rules for numbers."},"PhoneValidationConfiguration":{"$ref":"#/definitions/DraftActivityReplacePhoneValidationConfiguration","description":"The validation rules for phone numbers."},"TimeValidationConfiguration":{"$ref":"#/definitions/DraftActivityReplaceTimeValidationConfiguration","description":"The validation rules for time values."}}},"DraftActivityReplaceAllowedSignatureTypes":{"description":"The definition of the allowed signature types for the signature.","type":"object","properties":{"ClickToSign":{"$ref":"#/definitions/DraftActivityReplaceClickToSignSignatureType","description":"Allow signing with \"click to sign\"."},"DrawToSign":{"$ref":"#/definitions/DraftActivityReplaceDrawToSignSignatureType","description":"Allow signing with \"draw to sign\"."},"TypeToSign":{"$ref":"#/definitions/DraftActivityReplaceTypeToSignSignatureType","description":"Allow signing with \"type to sign\"."},"LocalCertificate":{"$ref":"#/definitions/DraftActivityReplaceLocalCertificateSignatureType","description":"Allow signing with a local certificate."},"DisposableCertificate":{"$ref":"#/definitions/DraftActivityReplaceDisposableCertificateSignatureType","description":"Allow signing with a disposable certificate."},"SwissComOnDemand":{"$ref":"#/definitions/DraftActivityReplaceSwissComOnDemandSignatureType","description":"Allow signing with a Swisscom On-Demand certificate."},"ATrustCertificate":{"$ref":"#/definitions/DraftActivityReplaceATrustCertificateSignatureType","description":"Allow signing with an A-Trust certificate."},"Biometric":{"$ref":"#/definitions/DraftActivityReplaceBiometricSignatureType","description":"Allow signing with a biometric signature."},"RemoteCertificate":{"$ref":"#/definitions/DraftActivityReplaceRemoteCertificateSignatureType","description":"Allow signing with a remote certificate."},"OneTimePassword":{"$ref":"#/definitions/DraftActivityReplaceOneTimePasswordSignatureType","description":"Allow signing with a one time password (SMS-OTP)."},"SwedishBankId":{"$ref":"#/definitions/DraftActivityReplaceSwedishBankIdSignatureType","description":"Allow signing with Swedish BankID."},"SignaturePlugins":{"description":"Allow signing with signature plugins.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceSignaturePluginSignatureType"}}}},"DraftActivityReplaceSignatureTaskConfiguration":{"description":"The configuration of the signature task.","type":"object","properties":{"StampImprintDateConfiguration":{"$ref":"#/definitions/DraftActivityReplaceStampImprintDateConfiguration","description":"The configuration of the stamp imprint date."},"BatchGroup":{"description":"The batch group.","maxLength":500,"minLength":0,"type":"string"}}},"DraftActivityReplaceAttachmentDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/DraftActivityReplacePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftActivityReplaceSize","description":"The size of the element."}}},"DraftActivityReplacePredefinedText":{"description":"The configuration of the element showing the predefined text.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Value":{"description":"The value of the predefined text.","maxLength":1000,"minLength":0,"type":"string"},"FieldDefinition":{"$ref":"#/definitions/DraftActivityReplacePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"DraftActivityReplaceEmail":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftActivityReplacePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"DraftActivityReplaceGivenName":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftActivityReplacePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"DraftActivityReplaceSurname":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftActivityReplacePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"DraftActivityReplaceFullName":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftActivityReplacePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"DraftActivityReplaceDate":{"description":"The configuration of the predefined element showing the date.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DateFormat":{"description":"The format of the date.","maxLength":50,"minLength":0,"type":"string"},"FieldDefinition":{"$ref":"#/definitions/DraftActivityReplacePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"DraftActivityReplaceHyperLink":{"description":"The definition of the hyperlink element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Uri":{"description":"The URI of the hyperlink.","maxLength":8000,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftActivityReplaceLinkDefinition","description":"The definition of the hyperlink element.\r\nIt must be specified when the hyperlink element is added.\r\nIt must not be specified when the hyperlink element already exists."}}},"DraftActivityReplaceReadingAreaDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/DraftActivityReplacePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftActivityReplaceSize","description":"The size of the element."}}},"DraftActivityReplaceSignaturePluginParameter":{"description":"The definition of a signature plugin parameter.","type":"object","properties":{"Key":{"description":"The identifier of the parameter.","maxLength":500,"minLength":0,"type":"string"},"Value":{"description":"The value of the parameter.","maxLength":500,"minLength":0,"type":"string"}}},"DraftActivityReplaceAuthenticationValidation":{"description":"A validation rule for an authentication response.","type":"object","properties":{"FieldReferenceId":{"description":"The identifier of the field.","maxLength":500,"minLength":0,"type":"string"},"ExpectedValue":{"description":"The expected value of the field.","maxLength":500,"minLength":0,"type":"string"}}},"DraftActivityReplaceDateValidationConfiguration":{"description":"The validation rules for dates.","type":"object","properties":{"DateFormat":{"description":"The format of the dates.","maxLength":50,"minLength":0,"type":"string"},"Range":{"$ref":"#/definitions/DraftActivityReplaceFieldValidationRange","description":"The range of the values."}}},"DraftActivityReplaceTimeValidationConfiguration":{"description":"The validation rules for time values.","type":"object","properties":{"TimeFormat":{"description":"The format of the time values.","maxLength":50,"minLength":0,"type":"string"},"Range":{"$ref":"#/definitions/DraftActivityReplaceFieldValidationRange","description":"The range of the values."}}},"DraftActivityReplaceChoiceItem":{"description":"The configuration of the choice item.","required":["DisplayValue"],"type":"object","properties":{"ExportValue":{"description":"The value of the element when the choice item is selected.","maxLength":500,"minLength":0,"type":"string"},"DisplayValue":{"description":"The displayed value of the choice item.","maxLength":500,"minLength":0,"type":"string"}}},"DraftActivityReplacePredefinedElementDefinition":{"description":"The configuration of the predefined element.","required":["Position","Size"],"type":"object","properties":{"TextFormat":{"$ref":"#/definitions/DraftActivityReplaceTextFormat","description":"The configuration of the text format."},"Position":{"$ref":"#/definitions/DraftActivityReplacePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftActivityReplaceSize","description":"The size of the element."}}},"DraftActivityReplaceLinkDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/DraftActivityReplacePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftActivityReplaceSize","description":"The size of the element."}}},"DraftActivityReplaceFieldValidationRange":{"description":"The validation rules for a value range.","type":"object","properties":{"From":{"description":"The lower boundary of the range.","maxLength":100,"minLength":0,"type":"string"},"To":{"description":"The upper boundary of the range.","maxLength":100,"minLength":0,"type":"string"}}},"DraftActivityReplacePluginStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftActivityReplaceSwedishBankIdStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayTransactionId":{"description":"If true, the transaction identifier is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftActivityReplaceOneTimePasswordStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayTransactionId":{"description":"If true, the transaction identifier is displayed.","type":"boolean"},"DisplayTransactionToken":{"description":"If true, the transaction token is displayed.","type":"boolean"},"DisplayPhoneNumber":{"description":"If true, the phone number of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftActivityReplaceRemoteCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftActivityReplaceSwissComOnDemandStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftActivityReplaceDisposableCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftActivityReplaceLocalCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftActivityReplaceTypeToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftActivityReplaceDrawToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftActivityReplaceClickToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"DraftActivityReplaceStampImprintDateConfiguration":{"description":"The configuration of the stamp imprint date.","type":"object","properties":{"UseLocalTimezone":{"description":"If true, the local timezone is used.","type":"boolean"},"DateTimeFormat":{"description":"The format of the timestamp.","maxLength":50,"minLength":0,"type":"string"}}},"DraftActivityReplaceSignaturePluginSignatureType":{"description":"The configuration of the signature plugin.","type":"object","properties":{"PluginId":{"description":"The identifier of the plugin.","maxLength":500,"minLength":0,"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftActivityReplacePluginStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftActivityReplaceSwedishBankIdSignatureType":{"description":"The configuration of the signature.","type":"object","properties":{"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftActivityReplaceSwedishBankIdStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftActivityReplaceOneTimePasswordSignatureType":{"description":"The configuration of the OneTimePassword signature.","type":"object","properties":{"ValidityInSeconds":{"description":"The validity of the password in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftActivityReplaceOneTimePasswordStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftActivityReplaceRemoteCertificateSignatureType":{"description":"The configuration of the RemoteCertificate signature.","type":"object","properties":{"ValidityInSeconds":{"description":"The validity of the certificate in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftActivityReplaceRemoteCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftActivityReplaceBiometricSignatureType":{"description":"The configuration of the Biometric signature.","type":"object","properties":{"BiometricVerification":{"description":"If true, a biometric verification is performed.","type":"boolean"},"AllowBiometricStoringOnly":{"description":"If true, the biometric signature might be stored without verification.","type":"boolean"},"StoreSignedResponseWithoutBioData":{"description":"If true, the signed response is stored without biometric data.","type":"boolean"},"BiometricServerUserId":{"description":"The identifier of the user on the biometric server.","maxLength":50,"minLength":0,"type":"string"},"SignaturePositioning":{"description":"The allowed positioning of the biometric signature.","enum":["WithinField","OnPage","IntersectsWithField"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"}}},"DraftActivityReplaceATrustCertificateSignatureType":{"description":"The configuration of the A-Trust certificate signature.","type":"object","properties":{"TemplateId":{"description":"The identifier of the A-Trust template.","maxLength":500,"minLength":0,"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"}}},"DraftActivityReplaceSwissComOnDemandSignatureType":{"description":"The configuration of the Swisscom On-Demand signature.","type":"object","properties":{"ValidityInSeconds":{"description":"The validity of the certificate in seconds.","type":"integer"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftActivityReplaceSwissComOnDemandStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftActivityReplaceDisposableCertificateSignatureType":{"description":"The configuration of the DisposableCertificate signature.","type":"object","properties":{"IsLongLived":{"description":"If true, the disposable certificate is long lived.","type":"boolean"},"ValidityInSeconds":{"description":"The validity of the certificate in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftActivityReplaceDisposableCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftActivityReplaceLocalCertificateSignatureType":{"description":"The configuration of the LocalCertificate signature.","type":"object","properties":{"EnforcePreferredHashAlgorithm":{"description":"If true, the usage of the preferred hash algorithm is enforced.","type":"boolean"},"PreferredHashAlgorithm":{"description":"The preferred hash algorithm.","enum":["Sha256","Sha512"],"type":"string"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftActivityReplaceLocalCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftActivityReplaceTypeToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftActivityReplaceTypeToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftActivityReplaceDrawToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftActivityReplaceDrawToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftActivityReplaceClickToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/DraftActivityReplaceClickToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"DraftActivityReplaceRadioButtonItemDefinition":{"description":"The configuration of the radio button.","required":["Position","Size"],"type":"object","properties":{"ExportValue":{"description":"The value of the element when the radio button is checked.","maxLength":500,"minLength":0,"type":"string"},"IsChecked":{"description":"If true, the radio button is checked by default.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/DraftActivityReplacePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftActivityReplaceSize","description":"The size of the element."}}},"DraftActivityReplaceTextFormat":{"description":"The configuration of the text format.","type":"object","properties":{"TextColor":{"description":"The color of the text. The default color is black.\r\nSix digit hexadecimal color that starts with # in #RRGGBB format according to CSS Color Module Level 4, paragraph 5.2.","maxLength":7,"minLength":7,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"number"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"Bold":{"description":"If true, the bold font is used.","type":"boolean"},"Italic":{"description":"If true, the italic font is used.","type":"boolean"},"TextAlign":{"description":"The alignment of the text. The default alignment is left.","enum":["Left","Center","Right"],"type":"string"}}},"DraftActivityReplacePhoneValidationConfiguration":{"description":"The validation rules for phone numbers.","type":"object","properties":{"Type":{"description":"The format of the phone numbers.","enum":["International","InternationalLeadingZeros","InternationalLeadingPlus"],"type":"string"}}},"DraftActivityReplaceNumberValidationConfiguration":{"description":"The validation rules for numbers.","type":"object","properties":{"DecimalDigits":{"description":"The expected amount of decimal digits.","type":"integer"},"Symbol":{"description":"The expected symbol.","maxLength":5,"minLength":0,"type":"string"},"SymbolLocation":{"description":"The defined symbol location.","enum":["Start","StartWithBlank","End","EndWithBlank"],"type":"string"},"GroupSeparator":{"description":"The expected thousands separator.","enum":["Comma","Point","Apostrophe","Blank","None"],"type":"string"},"DecimalSeparator":{"description":"The expected decimal separator.","enum":["Comma","Point","Apostrophe","None"],"type":"string","x-ms-enum":{"name":"DecimalSeparatorType","modelAsString":false}},"Range":{"$ref":"#/definitions/DraftActivityReplaceFieldValidationRange","description":"The range of the values."}}},"DraftActivityReplaceInitials":{"description":"The configuration of the predefined element showing the initials.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"IncludeMiddleNameInitials":{"description":"If true, the initials from the middle names are included as well. \r\nThe initials are read from the given name. Additional names are expected to be separated by a space.","type":"boolean"},"FieldDefinition":{"$ref":"#/definitions/DraftActivityReplacePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"DraftActivityReplaceListBoxDefinition":{"description":"The configuration of the list box.","required":["Items","Position","Size"],"type":"object","properties":{"TextFormat":{"$ref":"#/definitions/DraftActivityReplaceTextFormat","description":"The configuration of the text format."},"Items":{"description":"A list of items that can be selected for the element.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceChoiceItem"}},"IsMultiSelect":{"description":"If true, multiple values of the list box can be selected.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/DraftActivityReplacePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftActivityReplaceSize","description":"The size of the element."}}},"DraftActivityReplaceRadioButtonGroupDefinition":{"description":"The configuration of the radio button group definition.","type":"object","properties":{"IsSelectUnison":{"description":"If true, radiobuttons with the same <code>ExportValue<\/code> are checked and unchecked together.","type":"boolean"},"Items":{"description":"The list of radio buttons that belong to the same group.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceRadioButtonItemDefinition"}}}},"DraftActivityReplaceComboBoxDefinition":{"description":"The configuration of the combo box.","required":["Items","Position","Size"],"type":"object","properties":{"TextFormat":{"$ref":"#/definitions/DraftActivityReplaceTextFormat","description":"The configuration of the text format."},"Items":{"description":"A list of items that can be selected for the element.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceChoiceItem"}},"IsEditable":{"description":"If true, the combo box is editable.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/DraftActivityReplacePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftActivityReplaceSize","description":"The size of the element."}}},"DraftActivityReplaceCheckBoxDefinition":{"description":"The configuration of a check box.","required":["Position","Size"],"type":"object","properties":{"ExportValue":{"description":"The value of the check box when it is checked.","maxLength":500,"minLength":0,"type":"string"},"Position":{"$ref":"#/definitions/DraftActivityReplacePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftActivityReplaceSize","description":"The size of the element."},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"}}},"DraftActivityReplaceTextBoxDefinition":{"description":"The configuration of the text box.","required":["Position","Size"],"type":"object","properties":{"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"MaxLength":{"description":"The maximum length of the text.","type":"integer"},"IsMultiline":{"description":"If true, the text box can have multiple lines.","type":"boolean"},"IsPassword":{"description":"If true, the text box behaves like a password input field and does not show the actually entered characters.","type":"boolean"},"TextFormat":{"$ref":"#/definitions/DraftActivityReplaceTextFormat","description":"The configuration of the text format."},"Position":{"$ref":"#/definitions/DraftActivityReplacePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/DraftActivityReplaceSize","description":"The size of the element."}}},"DraftActivityReplaceDisposableCertificateSignatureData":{"description":"The recipient configuration for signing with a disposable certificate.","type":"object","properties":{"DocumentIssuingCountry":{"description":"The issuing country of the document.\r\nWill be used as country of residence, if lean is disabled.","maxLength":500,"minLength":0,"type":"string"},"IdentificationIssuingCountry":{"description":"The issuing country of the identification.","maxLength":500,"minLength":0,"type":"string"},"IdentificationType":{"description":"The type of identification in use.","enum":["None","ForeignTaxCode","PersonalNumber","Passport","NationalIdentityCard","ItalianTaxCode","NoSerialNumber","DrivingLicense","ResidencePermit","TemporaryResidencePermit","EmbassyDocument","AML"],"type":"string","x-ms-enum":{"name":"DisposableCertificateIdentificationType","modelAsString":false}},"PhoneNumber":{"description":"The phone number registered for identification.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"},"DocumentType":{"description":"The type of document used for the identification.","enum":["IdentityCard","DriverLicense","Passport","ResidencePermit","NationalElectronicIdentityCard","TemporaryResidencePermit","EmbassyDocument"],"type":"string"},"DocumentIssuedBy":{"description":"The authority that issued the document.","maxLength":500,"minLength":0,"type":"string"},"DocumentIssuedOn":{"format":"date","description":"The date when the document has been issued.\r\nA date in the format RFC 3339, section 5.6, 'full-date' (e.g. 2017-07-21).","maxLength":10,"minLength":10,"type":"string"},"DocumentExpiryDate":{"format":"date","description":"The expiration date of the document.\r\nA date in the format RFC 3339, section 5.6, 'full-date' (e.g. 2017-07-21).","maxLength":10,"minLength":10,"type":"string"},"SerialNumber":{"description":"The serial number of the certificate.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"description":"The identifier of the document.","maxLength":500,"minLength":0,"type":"string"}}},"DraftActivityReplaceReadDocumentConfirmation":{"description":"The document which has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"}}},"DraftActivityReplaceReadPagesConfirmation":{"description":"The page which has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"PageNumber":{"format":"int32","description":"The number of the page that needs to be read. Starting with 1.","type":"integer"},"GuidingOrder":{"description":"The order of the element.","type":"integer"}}},"DraftActivityReplaceReadAreaConfirmation":{"description":"The area that has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"Definition":{"$ref":"#/definitions/DraftActivityReplaceReadingAreaDefinition","description":"The definition of the area.\r\nWhen adding a new element, it has to be specified .\r\nWhen the field already exists, it must not be specified."}}},"DraftActivityReplaceAttachment":{"description":"The configuration of the attachment element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"DisplayIconType":{"description":"The type of the displayed icon. If no icon is provided Paperclip will be used.","enum":["Paperclip","Graph","PushPin","Tag"],"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftActivityReplaceAttachmentDefinition","description":"The definition of the attachment element.\r\nIt must be specified when the attachment element is added.\r\nIt must not be specified when the attachment element already exists."}}},"DraftActivityReplaceSignatureField":{"description":"The configuration of the signature field.","required":["ElementId"],"type":"object","properties":{"ElementId":{"description":"The identifier of the signature.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"FieldDescription":{"description":"The description of the signature.","maxLength":500,"minLength":0,"type":"string"},"UseExternalTimestampServer":{"description":"If true, a timestamp from an external server is embedded into the signature.","type":"boolean"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"AllowedSignatureTypes":{"$ref":"#/definitions/DraftActivityReplaceAllowedSignatureTypes","description":"The allowed types for the signature."},"FieldDefinition":{"$ref":"#/definitions/DraftActivityReplaceSignatureFieldDefinition","description":"The definition of the signature field.\r\nIt must be specified when the signature field is added.\r\nIt must not be specified when the signature field already exists."},"TaskConfiguration":{"$ref":"#/definitions/DraftActivityReplaceSignatureTaskConfiguration","description":"The configuration of the task."}}},"DraftActivityReplaceListBox":{"description":"The configuration of the list box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"PreSelectedItems":{"description":"The export values of the items which should be initially selected.","maxItems":50,"type":"array","items":{"maxLength":500,"type":"string"}},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftActivityReplaceListBoxDefinition","description":"The definition of the list box field.\r\nIt must be specified when the list box is added.\r\nIt must not be specified when the list box already exists."}}},"DraftActivityReplaceRadioButtonGroup":{"description":"The configuration of the radio button group.","type":"object","properties":{"GroupName":{"description":"The name of the radio button group.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"SelectedItem":{"description":"The export value of the selected item of the radio button group.","maxLength":500,"minLength":0,"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftActivityReplaceRadioButtonGroupDefinition","description":"The definition of the radio button group.\r\nIt must be specified when the radio button group is added.\r\nIt must not be specified when the radio button group already exists."}}},"DraftActivityReplaceComboBox":{"description":"The configuration of the combo box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"Value":{"description":"The selected value of the combo box.","maxLength":500,"minLength":0,"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftActivityReplaceComboBoxDefinition","description":"The definition of the combo box.\r\nIt must be specified when the combo box is added.\r\nIt must not be specified when the combo box already exists."}}},"DraftActivityReplaceCheckBox":{"description":"The configuration of the check box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"IsChecked":{"description":"If true, the check box is checked.","type":"boolean"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/DraftActivityReplaceCheckBoxDefinition","description":"The definition of the check box.\r\nIt must be specified when the check box is added.\r\nIt must not be specified when the check box already exists."}}},"DraftActivityReplaceTextBox":{"description":"The configuration of the text box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"Value":{"description":"The value of the text box.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"Validation":{"$ref":"#/definitions/DraftActivityReplaceFieldValidation","description":"The configuration of the validation rules for the text box value."},"FieldDefinition":{"$ref":"#/definitions/DraftActivityReplaceTextBoxDefinition","description":"The definition of the text box.\r\nIt must be specified when the check box is added.\r\nIt must not be specified when the check box already exists."}}},"DraftActivityReplaceEmailAppLinks":{"description":"Configure if links for our apps should be included in the recipient document signing request email message.","type":"object","properties":{"Android":{"description":"If true, an Android app link is added to the email message.","type":"boolean"},"iOS":{"description":"If true, an iOS app link is added to the email message.","type":"boolean"},"Windows":{"description":"If true, a Windows app link is added to the email message.","type":"boolean"}}},"DraftActivityReplaceContactInformation":{"description":"Define the contact information for the recipient.","type":"object","properties":{"Email":{"description":"The email address of the recipient.","maxLength":250,"minLength":0,"pattern":"^[a-zA-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF0-9.!#$%&'*+\\-\\/=?^_`{|}~]+@(?=[a-z0-9A-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF])(?:[a-z0-9A-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF]|(?<![.-])\\.|(?<!\\.)-)*[a-z0-9A-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF]$","type":"string"},"GivenName":{"description":"The given name of the recipient.","maxLength":200,"minLength":0,"type":"string"},"Surname":{"description":"The surname of the recipient.","maxLength":200,"minLength":0,"type":"string"},"PhoneNumber":{"description":"The phone number of the recipient.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"},"LanguageCode":{"description":"The language of the recipient.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string"}}},"DraftActivityReplacePoliciesForP7MAction":{"description":"Define the general policies allowed for P7M action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"},"AllowAdhocPdfAttachments":{"description":"If true, the client is allowed to append adhoc documents.","type":"boolean"},"AllowRejectWorkstep":{"description":"If true, the client is allowed to reject the workstep.","type":"boolean"},"AllowUndoLastAction":{"description":"If true, the client is allowed to undo actions.","type":"boolean"},"AllowDownloadOfSignedP7MFiles":{"description":"If true, the client is allowed to download signed p7m files.","type":"boolean"}}},"DraftActivityReplaceP7MSignatureMethods":{"description":"The recipient configuration for signing with P7M.","type":"object","properties":{"LocalCertificate":{"description":"If true, a local certificate can be used.","type":"boolean"},"DisposableCertificate":{"$ref":"#/definitions/DraftActivityReplaceDisposableCertificateSignatureData","description":"The disposable certificate configuration for the action."},"RemoteCertificate":{"$ref":"#/definitions/DraftActivityReplaceRemoteCertificateSignatureData","description":"The remote certificate configuration for the action."},"SignaturePluginData":{"description":"The signature plugin configurations for the action.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceSignaturePluginSignatureData"}}}},"DraftActivityReplaceGeneralPoliciesForViewAction":{"description":"Define the general policies allowed for view action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"}}},"DraftActivityReplaceRecipientConfiguration":{"description":"The configuration of the recipient.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/DraftActivityReplaceContactInformation","description":"The contact information of the recipient."},"PersonalMessage":{"description":"The personal message for the recipient.","maxLength":204800,"minLength":0,"type":"string"},"AuthenticationConfiguration":{"$ref":"#/definitions/DraftActivityReplaceAuthenticationConfiguration","description":"The configuration for the authentication of the recipient."},"SendEmails":{"description":"If true, emails will be sent out for this recipient.","type":"boolean"},"AllowAccessAfterFinish":{"description":"If true, the recipient is allowed to access the action after it has been finished.\r\nIt is required that the organization has the AllowAccessFinishedWorkstep feature enabled.\r\nThe default value is taken from the OrganizationSettings.","type":"boolean"}}},"DraftActivityReplaceGeneralPoliciesForSignAction":{"description":"Define the general policies allowed for sign action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"},"AllowAdhocPdfAttachments":{"description":"If true, the client is allowed to append adhoc documents.","type":"boolean"},"AllowRejectWorkstep":{"description":"If true, the client is allowed to reject the workstep.","type":"boolean"},"AllowUndoLastAction":{"description":"If true, the client is allowed to undo actions.","type":"boolean"}}},"DraftActivityReplaceAdvancedRecipientConfiguration":{"description":"The advanced configuration for the recipient.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/DraftActivityReplaceContactInformation","description":"The contact information of the recipient."},"PersonalMessage":{"description":"The personal message for the recipient.","maxLength":204800,"minLength":0,"type":"string"},"AuthenticationConfiguration":{"$ref":"#/definitions/DraftActivityReplaceAuthenticationConfiguration","description":"The configuration for the authentication of the recipient."},"SendEmails":{"description":"If true, emails will be sent out for this recipient.","type":"boolean"},"AllowAccessAfterFinish":{"description":"If true, the recipient is allowed to access the action after it has been finished.\r\nIt is required that the organization has the AllowAccessFinishedWorkstep feature enabled.\r\nThe default value is taken from the OrganizationSettings.","type":"boolean"},"IncludedEmailAppLinks":{"$ref":"#/definitions/DraftActivityReplaceEmailAppLinks","description":"The configuration for mobile app links in email messages."},"AllowDelegation":{"description":"If true, the recipient may delegate this activity to another person.","type":"boolean"},"RequireViewContentBeforeFormFilling":{"description":"If true, the signer has to confirm the reading of all documents as first task.","type":"boolean"}}},"DraftActivityReplaceVisibleSignature":{"description":"A signature with a visual appearance on the document.","required":["FieldDefinition"],"type":"object","properties":{"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"UseExternalTimestampServer":{"description":"If true, a timestamp from an external server is embedded into the signature.","type":"boolean"},"FieldDefinition":{"$ref":"#/definitions/DraftActivityReplaceSignatureFieldDefinition","description":"The definition of the signature field.\r\nIt must be specified when the signature field is added.\r\nIt must not be specified when the signature field already exists."}}},"DraftActivityReplaceSignBulk":{"description":"A sign action for multiple recipients.","type":"object","properties":{"BulkRecipients":{"description":"The recipients that are part of the bulk.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceBulkRecipient"}},"SequenceMode":{"description":"The sequence mode.","enum":["NoSequenceEnforced","SequenceEnforced"],"type":"string"},"Elements":{"$ref":"#/definitions/DraftActivityReplaceElements","description":"The elements in the document (e.g. form fields) assigned to the recipient."},"FinishActionConfiguration":{"$ref":"#/definitions/DraftActivityReplaceFinishAction","description":"Defines what happens in the signing clients, after an action has been finished."},"BatchConfiguration":{"$ref":"#/definitions/DraftActivityReplaceBatchConfiguration","description":"The configuration of a signing batch."},"GeneralPoliciesOverrides":{"$ref":"#/definitions/DraftActivityReplaceGeneralPoliciesForSignAction","description":"Viewer policy settings for override."}}},"DraftActivityReplaceSign":{"description":"A sign action for the recipient.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/DraftActivityReplaceAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"SequenceMode":{"description":"The sequence mode.","enum":["NoSequenceEnforced","SequenceEnforced"],"type":"string"},"Elements":{"$ref":"#/definitions/DraftActivityReplaceElements","description":"The elements in the document (e.g. form fields) assigned to the recipient."},"FinishActionConfiguration":{"$ref":"#/definitions/DraftActivityReplaceFinishAction","description":"Defines what happens in the signing clients, after an action has been finished."},"SignatureDataConfiguration":{"$ref":"#/definitions/DraftActivityReplaceSignatureDataConfiguration","description":"The configuration of recipient data for special signatures."},"BatchConfiguration":{"$ref":"#/definitions/DraftActivityReplaceBatchConfiguration","description":"The configuration of a signing batch."},"GeneralPoliciesOverrides":{"$ref":"#/definitions/DraftActivityReplaceGeneralPoliciesForSignAction","description":"Viewer policy settings for override."}}},"DraftActivityReplaceSignAutomatic":{"description":"An automatic signing action.","type":"object","properties":{"ProfileId":{"description":"The identifier of the profile for the automatic signatures.","maxLength":500,"minLength":0,"type":"string"},"RenderingLanguageCode":{"description":"The rendering language for the automatic signatures.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string"},"VisibleSignatures":{"description":"The visible signatures define the optional visual representations for automatic signatures.\r\nIf none are defined, the automatic signatures are applied to the documents without a visual element.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/DraftActivityReplaceVisibleSignature"}}}},"EnvelopeGetResponse":{"description":"The response model for requesting the envelope overview.","type":"object","properties":{"Id":{"description":"The identifier of the envelope.","type":"string"},"EnvelopeStatus":{"description":"The status of the envelope.","enum":["Active","Completed","Canceled","Expired","Rejected"],"type":"string","x-ms-enum":{"name":"EnvelopeStatusExternal","modelAsString":false}},"Name":{"description":"The name of the envelope.","type":"string"},"SentDate":{"format":"date","description":"Date when the envelope was sent.","type":"string"},"EnvelopeBulkParentId":{"description":"The identifier of the BulkParent.","type":"string"},"Activities":{"description":"The steps for the envelope.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetActivity"}},"SenderUserInformation":{"$ref":"#/definitions/EnvelopeGetSenderUserInformation","description":"The information about the user who sent the envelope."}}},"EnvelopeGetActivity":{"description":"An activity in the process.","type":"object","properties":{"Id":{"description":"The identifier of the activity.","type":"string"},"Status":{"description":"The status of an action within the envelope.","enum":["Pending","Completed","Rejected","Delegated"],"type":"string","x-ms-enum":{"name":"EnvelopeGetActivityStatus","modelAsString":false}},"StatusReason":{"description":"Additional information why this particular status was reached.","type":"string"},"FinishedDate":{"format":"date-time","description":"The date when the action was finished.\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","type":"string"},"OpenedDate":{"format":"date-time","description":"The date when the action was accessed.\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","type":"string"},"Action":{"$ref":"#/definitions/EnvelopeGetAction","description":"The action assigned to the activity."}}},"EnvelopeGetSenderUserInformation":{"description":"The information about the user who sent the envelope.","type":"object","properties":{"Email":{"description":"The email address of the sender.","type":"string"},"GivenName":{"description":"The given name of the sender.","type":"string"},"Surname":{"description":"The surname of the sender.","type":"string"}}},"EnvelopeGetAction":{"description":"The action of the activity.","type":"object","properties":{"SendCopy":{"$ref":"#/definitions/EnvelopeGetSendCopy","description":"The definition of the copy action."},"SignAutomatic":{"$ref":"#/definitions/EnvelopeGetSignAutomatic","description":"The definition of the automatic sign action."},"Sign":{"$ref":"#/definitions/EnvelopeGetSign","description":"The definition of the sign action."},"View":{"$ref":"#/definitions/EnvelopeGetView","description":"The definition of the view action."},"SignAsP7M":{"$ref":"#/definitions/EnvelopeGetSignAsP7M","description":"The definition of the P7M sign action."}}},"EnvelopeGetSendCopy":{"description":"An action to send a copy of the documents to the recipient.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/EnvelopeGetContactInformation","description":"The contact information of the recipient."},"CopyingGroup":{"format":"int32","description":"The parallel group for copy actions.","type":"integer"}}},"EnvelopeGetSignAutomatic":{"description":"An automatic signing action.","type":"object","properties":{"ProfileId":{"description":"The identifier of the profile for the automatic signatures.","type":"string"},"RenderingLanguageCode":{"description":"The rendering language for the automatic signatures.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string"}}},"EnvelopeGetSign":{"description":"An action to sign documents.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/EnvelopeGetContactInformation","description":"The contact information of the recipient."},"LongLivedDisposableCertificateWarnings":{"description":"The warnings related to long lived disposable certificates.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetLongLivedDisposableCertificateWarning"}},"SigningGroup":{"format":"int32","description":"The parallel group for sign actions.","type":"integer"}}},"EnvelopeGetView":{"description":"An action to view and acknowledge the documents.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/EnvelopeGetContactInformation","description":"The contact information of the recipient."},"ViewingGroup":{"format":"int32","description":"The parallel group for view actions.","type":"integer"}}},"EnvelopeGetSignAsP7M":{"description":"An action to sign documents with P7M.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/EnvelopeGetContactInformation","description":"The contact information of the recipient."},"SignAsP7MGroup":{"format":"int32","description":"The parallel group for P7M actions.","type":"integer"}}},"EnvelopeGetContactInformation":{"description":"Defines the contact information for the recipient.","type":"object","properties":{"Email":{"description":"The email address of the recipient.","type":"string"},"GivenName":{"description":"The given name of the recipient.","type":"string"},"Surname":{"description":"The surname of the recipient.","type":"string"},"PhoneNumber":{"description":"The phone number of the recipient.","type":"string"},"LanguageCode":{"description":"The language of the recipient.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string","x-ms-enum":{"name":"LanguageCode","modelAsString":false}}}},"EnvelopeGetLongLivedDisposableCertificateWarning":{"description":"A warning for a long lived disposable certificate.","type":"object","properties":{"RequestId":{"description":"The identifier of the request.","type":"string"},"RemoteDeviceId":{"description":"The identifier of the remote device.","type":"string"}}},"EnvelopeGetFilesResponse":{"description":"The response model for containing the information about the files contained in the envelope.","type":"object","properties":{"Documents":{"description":"The finished documents of the envelope.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetFilesDocument"}},"AuditTrail":{"$ref":"#/definitions/EnvelopeGetFilesAuditTrail","description":"The references for the audit trail of the envelope."},"LegalDocuments":{"description":"The legal documents of the envelope.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetFilesLegalDocument"}}}},"EnvelopeGetFilesDocument":{"description":"The information about a finished document.","type":"object","properties":{"FileId":{"description":"The identifier of the file.","type":"string"},"FileName":{"description":"The name of the file.","type":"string"},"AuditTrailFileId":{"description":"The identifier of the audit trail file for this particular document.\r\nOnly available if \"generate separate audit trail per document\" was enabled for the organization.","type":"string"},"Attachments":{"description":"The attachments contained in the document.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetFilesDocumentAttachment"}},"PageCount":{"format":"int32","description":"The number of pages.","type":"integer"},"DocumentNumber":{"format":"int32","description":"The reference number of the document. It starts with 1.","type":"integer"}}},"EnvelopeGetFilesAuditTrail":{"description":"The references for the audit trail of the envelope.","type":"object","properties":{"FileId":{"description":"The identifier of the audit trail pdf file.","type":"string"},"XmlFileId":{"description":"The identifier of the audit trail xml file.","type":"string"}}},"EnvelopeGetFilesLegalDocument":{"description":"The information about the legal document of an envelope.","type":"object","properties":{"FileId":{"description":"The identifier of the file.","type":"string"},"FileName":{"description":"The name of the file.","type":"string"},"ActivityId":{"description":"The identifier of the activity.","type":"string"},"Email":{"description":"The email address of the recipient.","type":"string"}}},"EnvelopeGetFilesDocumentAttachment":{"description":"The information about an attachment of a document.","type":"object","properties":{"FileId":{"description":"The identifier of the file.","type":"string"},"FileName":{"description":"The name of the file.","type":"string"}}},"EnvelopeGetHistoryResponse":{"description":"Events and their status for the requested envelope","type":"object","properties":{"Events":{"description":"List of events that have or will occur","type":"array","items":{"$ref":"#/definitions/EnvelopeGetHistoryEvent"}},"EnvelopeHasBeenDeleted":{"description":"True if the envelope has been deleted, Events will be empty for deleted envelopes","type":"boolean"},"EnvelopeDeletionDate":{"format":"date-time","description":"The date when the envelope was deleted, if the envelope is not deleted yet its null\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","type":"string"}}},"EnvelopeGetHistoryEvent":{"description":"A history event of an envelope","type":"object","properties":{"CreationDate":{"format":"date-time","description":"Date of the creation of the event, some events may be fired at a later point after the CreationDate\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","type":"string"},"Type":{"description":"Type of the event","type":"string"},"AffectedRecipient":{"$ref":"#/definitions/EnvelopeGetHistoryEventRecipient","description":"The recipient affected by this event. \r\nMay be empty if its an envelope related event or the \r\nauthorized user is not allowed to manage the envelope"},"Completed":{"description":"Indicates whether or not the event is completed.\r\nAn event can be completed while having an error\r\nif the RemainingAttempts count reaches zero","type":"boolean"},"CompletedOn":{"format":"date-time","description":"Date of the completion of the event.\r\nMay be null if the event has not fired yet or is in an error state\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","type":"string"},"IsInErrorState":{"description":"Indicates whether or not the event has an error.\r\nAn event in an error state may be retried until the RemainingAttempts count reaches zero","type":"boolean"},"NextAttemptOn":{"format":"date-time","description":"Date when the event will be fired\r\nMay be null if an event is completed or the RemainingAttempts count reaches zero\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","type":"string"},"Attempt":{"format":"int32","description":"How often the event has been attempted so far","type":"integer"},"RemainingAttempts":{"format":"int32","description":"How many attempts are remaining until further attempts are halted.","type":"integer"},"ContextInformation":{"description":"Information about what the event has been doing or why it is in an error state","type":"string"},"TraceId":{"description":"Identifier to find associated logs to this event, if unset the even has not been fired yet","type":"string"}}},"EnvelopeGetHistoryEventRecipient":{"type":"object","properties":{"Id":{"format":"uuid","description":"The id of the recipient.","type":"string","example":"00000000-0000-0000-0000-000000000000"},"Email":{"description":"The email address of the recipient.","type":"string"},"GivenName":{"description":"The given name of the recipient.","type":"string"},"Surname":{"description":"The surname of the recipient.","type":"string"}}},"EnvelopeGetElementsResponse":{"description":"The response model for requesting document elements of a sent envelope.","type":"object","properties":{"UnassignedElements":{"$ref":"#/definitions/EnvelopeGetElementsElements","description":"The elements which are not assigned to any action."},"Activities":{"description":"The steps for the envelope.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsActivity"}}}},"EnvelopeGetElementsElements":{"description":"The configurable elements of the documents.","type":"object","properties":{"TextBoxes":{"description":"The text boxes.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsTextBox"}},"CheckBoxes":{"description":"The check boxes.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsCheckBox"}},"ComboBoxes":{"description":"The combo boxes.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsComboBox"}},"RadioButtons":{"description":"The radio buttons.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsRadioButtonGroup"}},"ListBoxes":{"description":"The list boxes.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsListBox"}},"Signatures":{"description":"The signatures.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsSignatureField"}},"Attachments":{"description":"The attachments.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsAttachment"}},"PredefinedFieldElements":{"$ref":"#/definitions/EnvelopeGetElementsPredefinedFieldElements","description":"The predefined field elements."},"LinkConfiguration":{"$ref":"#/definitions/EnvelopeGetElementsLinkConfiguration","description":"The links in the documents."},"AreaReadConfirmations":{"description":"The areas which have to be read.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsReadAreaConfirmation"}},"PageReadConfirmations":{"description":"The pages which have to be read.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsReadPagesConfirmation"}},"DocumentReadConfirmations":{"description":"The documents which have to be read.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsReadDocumentConfirmation"}}}},"EnvelopeGetElementsActivity":{"description":"Defines an activity in the process.","type":"object","properties":{"Id":{"description":"The identifier of the activity.","type":"string"},"Action":{"$ref":"#/definitions/EnvelopeGetElementsAction","description":"The action assigned to the activity."}}},"EnvelopeGetElementsTextBox":{"description":"The configuration of the text box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"Value":{"description":"The value of the text box.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"Validation":{"$ref":"#/definitions/EnvelopeGetElementsFieldValidation","description":"The configuration of the validation rules for the text box value."},"FieldDefinition":{"$ref":"#/definitions/EnvelopeGetElementsTextBoxDefinition","description":"The definition of the text box."}}},"EnvelopeGetElementsCheckBox":{"description":"The configuration of the check box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"IsChecked":{"description":"If true, the check box is checked.","type":"boolean"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeGetElementsCheckBoxDefinition","description":"The definition of the check box."}}},"EnvelopeGetElementsComboBox":{"description":"The configuration of the combo box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"Value":{"description":"The selected value of the combo box.","type":"string"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeGetElementsComboBoxDefinition","description":"The definition of the combo box."}}},"EnvelopeGetElementsRadioButtonGroup":{"description":"The configuration of the radio button group.","type":"object","properties":{"GroupName":{"description":"The name of the radio button group.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"SelectedItem":{"description":"The export value of the selected item of the radio button group.","type":"string"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeGetElementsRadioButtonDefinition","description":"The definition of the radio button group."}}},"EnvelopeGetElementsListBox":{"description":"The configuration of the list box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"PreSelectedItems":{"description":"The export values of the items which should be initially selected.","type":"array","items":{"type":"string"}},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeGetElementsListBoxDefinition","description":"The definition of the list box field."}}},"EnvelopeGetElementsSignatureField":{"description":"The configuration of the signature field.","type":"object","properties":{"ElementId":{"description":"The identifier of the signature.","type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","type":"string"},"IsSigned":{"description":"If true, the signature has been signed.","type":"boolean"},"FieldDescription":{"description":"The description of the signature.","type":"string"},"UseExternalTimestampServer":{"description":"If true, an timestamp from an external server is embedded into the signature.","type":"boolean"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"AllowedSignatureTypes":{"$ref":"#/definitions/EnvelopeGetElementsAllowedSignatureTypes","description":"The allowed types for the signature."},"FieldDefinition":{"$ref":"#/definitions/EnvelopeGetElementsSignatureFieldDefinition","description":"The definition of the signature field."},"TaskConfiguration":{"$ref":"#/definitions/EnvelopeGetElementsSignatureTaskConfiguration","description":"The configuration of the task."}}},"EnvelopeGetElementsAttachment":{"description":"The configuration of the attachment element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DisplayName":{"description":"The displayed name.","type":"string"},"DisplayIconType":{"description":"The type of the displayed icon.","enum":["Paperclip","Graph","PushPin","Tag"],"type":"string"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeGetElementsAttachmentDefinition","description":"The definition of the attachment element."}}},"EnvelopeGetElementsPredefinedFieldElements":{"description":"Defines the predefined fields which will be added and filled by the system.","type":"object","properties":{"TextFields":{"description":"The predefined text fields.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsPredefinedText"}},"EmailFields":{"description":"The recipient's email fields.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsEmail"}},"InitialsFields":{"description":"The recipient's initials fields.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsInitials"}},"GivenNameFields":{"description":"The recipient's given name fields.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsGivenName"}},"SurnameFields":{"description":"The recipient's surname fields.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsSurname"}},"FullNameFields":{"description":"The recipient's full name fields.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsFullName"}},"DateFields":{"description":"The current date fields.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsDate"}}}},"EnvelopeGetElementsLinkConfiguration":{"description":"The configuration of the link elements.","type":"object","properties":{"HyperLinks":{"description":"The list of hyperlink elements.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsHyperLink"}}}},"EnvelopeGetElementsReadAreaConfirmation":{"description":"The area that has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The document reference number of the element (starting with 1).","type":"integer"},"DisplayName":{"description":"The displayed name.","type":"string"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"Definition":{"$ref":"#/definitions/EnvelopeGetElementsReadingAreaDefinition","description":"The definition of the area."}}},"EnvelopeGetElementsReadPagesConfirmation":{"description":"Define which page has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","type":"string"},"PageNumber":{"format":"int32","description":"The number of the page that needs to be read.","type":"integer"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"}}},"EnvelopeGetElementsReadDocumentConfirmation":{"description":"Define which document has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","type":"string"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"}}},"EnvelopeGetElementsAction":{"description":"The action of the activity.","type":"object","properties":{"SignAutomatic":{"$ref":"#/definitions/EnvelopeGetElementsSignAutomatic","description":"The definition of the automatic sign action."},"Sign":{"$ref":"#/definitions/EnvelopeGetElementsSign","description":"The definition of the sign action."}}},"EnvelopeGetElementsFieldValidation":{"description":"The configuration of the field validation rules.","type":"object","properties":{"Type":{"description":"The type of the value.","enum":["None","Date","Email","Number","Phone","Time"],"type":"string","x-ms-enum":{"name":"FieldValidationType","modelAsString":false}},"DateValidationConfiguration":{"$ref":"#/definitions/EnvelopeGetElementsDateValidationConfiguration","description":"The validation rules for dates."},"NumberValidationConfiguration":{"$ref":"#/definitions/EnvelopeGetElementsNumberValidationConfiguration","description":"The validation rules for numbers."},"PhoneValidationConfiguration":{"$ref":"#/definitions/EnvelopeGetElementsPhoneValidationConfiguration","description":"The validation rules for phone numbers."},"TimeValidationConfiguration":{"$ref":"#/definitions/EnvelopeGetElementsTimeValidationConfiguration","description":"The validation rules for time values."}}},"EnvelopeGetElementsTextBoxDefinition":{"description":"The configuration of the text box.","type":"object","properties":{"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"MaxLength":{"format":"int32","description":"The maximum length of the text.","type":"integer"},"IsMultiline":{"description":"If true, the text box can have multiple lines.","type":"boolean"},"IsPassword":{"description":"If true, the text box behaves like a password input field and does not show the actually entered characters.","type":"boolean"},"TextFormat":{"$ref":"#/definitions/EnvelopeGetElementsTextFormat","description":"The configuration of the text format."},"Position":{"$ref":"#/definitions/EnvelopeGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/EnvelopeGetElementsSize","description":"The size of the form field."}}},"EnvelopeGetElementsCheckBoxDefinition":{"description":"The configuration of a check box.","type":"object","properties":{"ExportValue":{"description":"The value of the check box when it is checked.","type":"string"},"Position":{"$ref":"#/definitions/EnvelopeGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/EnvelopeGetElementsSize","description":"The size of the form field."},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"}}},"EnvelopeGetElementsComboBoxDefinition":{"description":"The configuration of the combo box.","type":"object","properties":{"TextFormat":{"$ref":"#/definitions/EnvelopeGetElementsTextFormat","description":"The configuration of the text format."},"Items":{"description":"A list of items that can be selected for the element.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsChoiceItem"}},"IsEditable":{"description":"If true, the combo box is editable.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/EnvelopeGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/EnvelopeGetElementsSize","description":"The size of the form field."}}},"EnvelopeGetElementsRadioButtonDefinition":{"description":"The configuration of the radio button group definition.","type":"object","properties":{"IsSelectUnison":{"description":"If true, radio buttons with the same <code>ExportValue<\/code> are checked and unchecked together.","type":"boolean"},"Items":{"description":"The list of radiobuttons that belong to the same group.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsRadioButtonItemDefinition"}}}},"EnvelopeGetElementsListBoxDefinition":{"description":"The configuration of the list box.","type":"object","properties":{"TextFormat":{"$ref":"#/definitions/EnvelopeGetElementsTextFormat","description":"The configuration of the text format."},"Items":{"description":"A list of items that can be selected for the element.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsChoiceItem"}},"IsMultiSelect":{"description":"If true, multiple values of the list box can be selected.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/EnvelopeGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/EnvelopeGetElementsSize","description":"The size of the form field."}}},"EnvelopeGetElementsAllowedSignatureTypes":{"description":"The definition of the allowed signature types for the signature.","type":"object","properties":{"ClickToSign":{"$ref":"#/definitions/EnvelopeGetElementsClickToSignSignatureType","description":"Allow signing with \"click to sign\"."},"DrawToSign":{"$ref":"#/definitions/EnvelopeGetElementsDrawToSignSignatureType","description":"Allow signing with \"draw to sign\"."},"TypeToSign":{"$ref":"#/definitions/EnvelopeGetElementsTypeToSignSignatureType","description":"Allow signing with \"type to sign\"."},"LocalCertificate":{"$ref":"#/definitions/EnvelopeGetElementsLocalCertificateSignatureType","description":"Allow signing with a local certificate."},"DisposableCertificate":{"$ref":"#/definitions/EnvelopeGetElementsDisposableCertificateSignatureType","description":"Allow signing with a disposable certificate."},"SwissComOnDemand":{"$ref":"#/definitions/EnvelopeGetElementsSwissComOnDemandSignatureType","description":"Allow signing with a Swisscom On-Demand certificate."},"ATrustCertificate":{"$ref":"#/definitions/EnvelopeGetElementsATrustCertificateSignatureType","description":"Allow signing with an A-Trust certificate."},"Biometric":{"$ref":"#/definitions/EnvelopeGetElementsBiometricSignatureType","description":"Allow signing with a biometric signature."},"RemoteCertificate":{"$ref":"#/definitions/EnvelopeGetElementsRemoteCertificateSignatureType","description":"Allow signing with a remote certificate."},"OneTimePassword":{"$ref":"#/definitions/EnvelopeGetElementsOneTimePasswordSignatureType","description":"Allow signing with a one time password (SMS-OTP)."},"SwedishBankId":{"$ref":"#/definitions/EnvelopeGetElementsSwedishBankIdSignatureType","description":"Allow signing with Swedish BankID."},"SignaturePlugins":{"description":"Allow signing with signature plugins.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsSignaturePluginSignatureType"}}}},"EnvelopeGetElementsSignatureFieldDefinition":{"description":"The settings of a positionable element.","type":"object","properties":{"Position":{"$ref":"#/definitions/EnvelopeGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/EnvelopeGetElementsSize","description":"The size of the form field."}}},"EnvelopeGetElementsSignatureTaskConfiguration":{"description":"The configuration of the signature task.","type":"object","properties":{"StampImprintDateConfiguration":{"$ref":"#/definitions/EnvelopeGetElementsStampImprintDateConfiguration","description":"The configuration of the stamp imprint date."},"BatchGroup":{"description":"The batch group.","type":"string"}}},"EnvelopeGetElementsAttachmentDefinition":{"description":"The settings of a positionable element.","type":"object","properties":{"Position":{"$ref":"#/definitions/EnvelopeGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/EnvelopeGetElementsSize","description":"The size of the form field."}}},"EnvelopeGetElementsPredefinedText":{"description":"The configuration of the element showing the predefined text.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"Value":{"description":"The value of the predefined text.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"EnvelopeGetElementsEmail":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"EnvelopeGetElementsInitials":{"description":"The configuration of the predefined element showing the initials.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"IncludeMiddleNameInitials":{"description":"If true, the initials from the middle names are included as well. \r\nThe initials are read from the given name. Additional names are expected to be separated by a space.","type":"boolean"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"EnvelopeGetElementsGivenName":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"EnvelopeGetElementsSurname":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"EnvelopeGetElementsFullName":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"EnvelopeGetElementsDate":{"description":"The configuration of the predefined element showing the date.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DateFormat":{"description":"The format of the date.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"EnvelopeGetElementsHyperLink":{"description":"The definition of the hyperlink element.","type":"object","properties":{"Id":{"description":"The identifier of the hyperlink.","type":"string"},"Uri":{"description":"The URI of the hyperlink.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeGetElementsLinkDefinition","description":"The definition of the hyperlink element."}}},"EnvelopeGetElementsReadingAreaDefinition":{"description":"The settings of a positionable element.","type":"object","properties":{"Position":{"$ref":"#/definitions/EnvelopeGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/EnvelopeGetElementsSize","description":"The size of the form field."}}},"EnvelopeGetElementsSignAutomatic":{"description":"An automatic signing action.","type":"object","properties":{"VisibleSignatures":{"description":"The visible signatures define the optional visual representations for automatic signatures.\r\nIf none are defined, the automatic signatures are applied to the documents without a visual element.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetElementsVisibleSignature"}}}},"EnvelopeGetElementsSign":{"description":"The elements, which are assigned to actions.","type":"object","properties":{"SequenceMode":{"description":"The sequence mode.","enum":["NoSequenceEnforced","SequenceEnforced"],"type":"string","x-ms-enum":{"name":"ElementSequenceMode","modelAsString":false}},"Elements":{"$ref":"#/definitions/EnvelopeGetElementsElements","description":"The definition of the assigned elements."}}},"EnvelopeGetElementsDateValidationConfiguration":{"description":"The validation rules for dates.","type":"object","properties":{"DateFormat":{"description":"The format of the dates.","type":"string"},"Range":{"$ref":"#/definitions/EnvelopeGetElementsFieldValidationRange","description":"The range of the values."}}},"EnvelopeGetElementsNumberValidationConfiguration":{"description":"The validation rules for numbers.","type":"object","properties":{"DecimalDigits":{"format":"int32","description":"The expected amount of decimal digits.","type":"integer"},"Symbol":{"description":"The expected symbol.","type":"string"},"SymbolLocation":{"description":"The defined symbol location.","enum":["Start","StartWithBlank","End","EndWithBlank"],"type":"string","x-ms-enum":{"name":"SymbolLocationType","modelAsString":false}},"GroupSeparator":{"description":"The expected thousands separator.","enum":["Comma","Point","Apostrophe","Blank","None"],"type":"string"},"DecimalSeparator":{"description":"The expected decimal separator.","enum":["Comma","Point","Apostrophe","None"],"type":"string","x-ms-enum":{"name":"DecimalSeparatorType","modelAsString":false}},"Range":{"$ref":"#/definitions/EnvelopeGetElementsFieldValidationRange","description":"The range of the values."}}},"EnvelopeGetElementsPhoneValidationConfiguration":{"description":"The validation rules for phone numbers.","type":"object","properties":{"Type":{"description":"The format of the phone numbers.","enum":["International","InternationalLeadingZeros","InternationalLeadingPlus"],"type":"string","x-ms-enum":{"name":"PhoneType","modelAsString":false}}}},"EnvelopeGetElementsTimeValidationConfiguration":{"description":"The validation rules for time values.","type":"object","properties":{"TimeFormat":{"description":"The format of the time values.","type":"string"},"Range":{"$ref":"#/definitions/EnvelopeGetElementsFieldValidationRange","description":"The range of the values."}}},"EnvelopeGetElementsTextFormat":{"description":"The configuration of the text format.","type":"object","properties":{"TextColor":{"description":"The color of the text.\r\nSix digit hexadecimal color starting with # in #RRGGBB format according to CSS Color Module Level 4, paragraph 5.2.","type":"string"},"FontSizeInPt":{"format":"double","description":"The size of the font in points.","type":"number"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"Bold":{"description":"If true, the bold font is used.","type":"boolean"},"Italic":{"description":"If true, the italic font is used.","type":"boolean"},"TextAlign":{"description":"The alignment of the text. The default alignment is left.","enum":["Left","Center","Right"],"type":"string","x-ms-enum":{"name":"TextAlignment","modelAsString":false}}}},"EnvelopeGetElementsPosition":{"description":"The position of an element on the document.","type":"object","properties":{"PageNumber":{"format":"int32","description":"The number of the page where the element is located. It starts with 1.","type":"integer"},"X":{"format":"double","description":"The X coordinate in points. It starts from the left.","type":"number"},"Y":{"format":"double","description":"The Y coordinate in points. It starts from the bottom.","type":"number"}}},"EnvelopeGetElementsSize":{"description":"The definition of the size of an element.","type":"object","properties":{"Width":{"format":"double","description":"The width of the element in points.","type":"number"},"Height":{"format":"double","description":"The height of the element in points.","type":"number"}}},"EnvelopeGetElementsChoiceItem":{"description":"The configuration of the choice item.","type":"object","properties":{"ExportValue":{"description":"The value of the element when the choice item is selected.","type":"string"},"DisplayValue":{"description":"The displayed value of the choice item.","type":"string"}}},"EnvelopeGetElementsRadioButtonItemDefinition":{"description":"The configuration of the radio button.","type":"object","properties":{"ExportValue":{"description":"The value of the element when the radio button is checked.","type":"string"},"IsChecked":{"description":"If true, the radio button is checked by default.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/EnvelopeGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/EnvelopeGetElementsSize","description":"The size of the form field."}}},"EnvelopeGetElementsClickToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeGetElementsClickToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeGetElementsDrawToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeGetElementsDrawToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeGetElementsTypeToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeGetElementsTypeToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeGetElementsLocalCertificateSignatureType":{"description":"The configuration of the LocalCertificate signature.","type":"object","properties":{"EnforcePreferredHashAlgorithm":{"description":"If true, the usage of the preferred hash algorithm is enforced.","type":"boolean"},"PreferredHashAlgorithm":{"description":"The preferred hash algorithm.","enum":["Sha256","Sha512"],"type":"string"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeGetElementsLocalCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeGetElementsDisposableCertificateSignatureType":{"description":"The configuration of the DisposableCertificate signature.","type":"object","properties":{"IsLongLived":{"description":"If true, the disposable certificate is long lived.","type":"boolean"},"ValidityInSeconds":{"format":"int32","description":"The validity of the certificate in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeGetElementsDisposableCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeGetElementsSwissComOnDemandSignatureType":{"description":"The configuration of the Swisscom On-Demand signature.","type":"object","properties":{"ValidityInSeconds":{"format":"int32","description":"The certificate validity in seconds.","type":"integer"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeGetElementsSwissComOnDemandStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeGetElementsATrustCertificateSignatureType":{"description":"The configuration of the A-Trust certificate signature.","type":"object","properties":{"TemplateId":{"description":"The identifier of the A-Trust template.","type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"}}},"EnvelopeGetElementsBiometricSignatureType":{"description":"The configuration of the Biometric signature.","type":"object","properties":{"BiometricVerification":{"description":"If true, a biometric verification is performed.","type":"boolean"},"AllowBiometricStoringOnly":{"description":"If true, the biometric signature might be stored without verification.","type":"boolean"},"StoreSignedResponseWithoutBioData":{"description":"If true, the signed response is stored without biometric data.","type":"boolean"},"BiometricServerUserId":{"description":"The identifier of the user on the biometric server.","type":"string"},"SignaturePositioning":{"description":"The allowed positioning of the biometric signature.","enum":["WithinField","OnPage","IntersectsWithField"],"type":"string","x-ms-enum":{"name":"BiometricSignaturePositioning","modelAsString":false}},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"}}},"EnvelopeGetElementsRemoteCertificateSignatureType":{"description":"The configuration of the RemoteCertificate signature.","type":"object","properties":{"ValidityInSeconds":{"format":"int32","description":"The validity of the certificate in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeGetElementsRemoteCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeGetElementsOneTimePasswordSignatureType":{"description":"The configuration of the OneTimePassword signature.","type":"object","properties":{"ValidityInSeconds":{"format":"int32","description":"The validity of the password in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeGetElementsOneTimePasswordStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeGetElementsSwedishBankIdSignatureType":{"description":"The configuration of the signature.","type":"object","properties":{"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeGetElementsSwedishBankIdStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeGetElementsSignaturePluginSignatureType":{"description":"The configuration of the signature plugin.","type":"object","properties":{"PluginId":{"description":"The identifier of the plugin.","type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeGetElementsPluginStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeGetElementsStampImprintDateConfiguration":{"description":"The configuration of the stamp imprint date","type":"object","properties":{"UseLocalTimezone":{"description":"If true, the local timezone is used.","type":"boolean"},"DateTimeFormat":{"description":"The format of the timestamp.","type":"string"}}},"EnvelopeGetElementsPredefinedElementDefinition":{"description":"The configuration of the predefined element.","type":"object","properties":{"TextFormat":{"$ref":"#/definitions/EnvelopeGetElementsTextFormat","description":"The configuration of the text format."},"Position":{"$ref":"#/definitions/EnvelopeGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/EnvelopeGetElementsSize","description":"The size of the form field."}}},"EnvelopeGetElementsLinkDefinition":{"description":"The settings of a positionable element.","type":"object","properties":{"Position":{"$ref":"#/definitions/EnvelopeGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/EnvelopeGetElementsSize","description":"The size of the form field."}}},"EnvelopeGetElementsVisibleSignature":{"description":"An automatic signature with a visual appearance on the document.","type":"object","properties":{"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Id":{"description":"The identifier of the signature field.","type":"string"},"UseExternalTimestampServer":{"description":"If true, a timestamp from an external server is embedded into the signature.","type":"boolean"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeGetElementsSignatureFieldDefinition","description":"The definition of the signature field."}}},"EnvelopeGetElementsFieldValidationRange":{"description":"The validation rules for a value range.","type":"object","properties":{"From":{"description":"The lower boundary of the range.","type":"string"},"To":{"description":"The upper boundary of the range.","type":"string"}}},"EnvelopeGetElementsClickToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeGetElementsDrawToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeGetElementsTypeToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeGetElementsLocalCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeGetElementsDisposableCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeGetElementsSwissComOnDemandStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeGetElementsRemoteCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeGetElementsOneTimePasswordStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayTransactionId":{"description":"If true, the transaction identifier is displayed.","type":"boolean"},"DisplayTransactionToken":{"description":"If true, the transaction token is displayed.","type":"boolean"},"DisplayPhoneNumber":{"description":"If true, the phone number of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeGetElementsSwedishBankIdStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayTransactionId":{"description":"If true, the transaction identifier is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeGetElementsPluginStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeGetViewerLinksResponse":{"description":"The response model for containing the available links to access the SignAnyWhere Viewer.","type":"object","properties":{"ViewerLinks":{"description":"The links to access the SignAnyWhere Viewer for the active activities of the envelope.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetViewerLinksViewerLink"}}}},"EnvelopeGetViewerLinksViewerLink":{"description":"The link to access the SignAnyWhere Viewer for a recipient.","type":"object","properties":{"ActivityId":{"description":"The identifier of the activity.","type":"string"},"Email":{"description":"The email address of the recipient.","type":"string"},"ViewerLink":{"description":"The URL to access the SignAnyWhere Viewer for this recipient.","type":"string"}}},"EnvelopeGetConfigurationResponse":{"description":"Configuration shared by all models.","type":"object","properties":{"MetaData":{"description":"The metadata of the envelope.","type":"string"},"AddDocumentTimestamp":{"description":"If true, a timestamp is added to all documents of the envelope at the end of each signing activity.","type":"boolean"},"ShareWithTeam":{"description":"If true, this envelope is shared with your teams.","type":"boolean"},"LockFormFieldsOnFinish":{"description":"If true, form fields are locked after envelope is finished.","type":"boolean"},"Activities":{"description":"The steps for the envelope.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetConfigurationActivity"}},"EmailConfiguration":{"$ref":"#/definitions/EnvelopeGetConfigurationEmailConfiguration","description":"The configuration for notifications."},"ReminderConfiguration":{"$ref":"#/definitions/EnvelopeGetConfigurationReminderConfiguration","description":"The configuration for reminders."},"ExpirationConfiguration":{"$ref":"#/definitions/EnvelopeGetConfigurationExpirationConfiguration","description":"The configuration of the expiration for the envelope."},"CallbackConfiguration":{"$ref":"#/definitions/EnvelopeGetConfigurationCallbackConfiguration","description":"The configuration of the callbacks for a custom integration."},"AgreementConfiguration":{"$ref":"#/definitions/EnvelopeGetConfigurationAgreementConfiguration","description":"The configuration of the agreement."},"SealingConfiguration":{"$ref":"#/definitions/EnvelopeGetConfigurationSealingConfiguration","description":"The configuration for sealing."}}},"EnvelopeGetConfigurationActivity":{"description":"An activity in the process.","type":"object","properties":{"Id":{"description":"The identifier of the activity.","type":"string"},"Action":{"$ref":"#/definitions/EnvelopeGetConfigurationAction","description":"The action assigned to the activity."},"VisibilityOptions":{"description":"The document visibility options for the activity.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetConfigurationVisibilityOption"}}}},"EnvelopeGetConfigurationEmailConfiguration":{"description":"The configuration for notifications.","type":"object","properties":{"Subject":{"description":"The subject of the sign notifications.","type":"string"},"Message":{"description":"The message of the sign notifications.","type":"string"},"SenderDisplayName":{"description":"The displayed name of the sender in the notifications.","type":"string"}}},"EnvelopeGetConfigurationReminderConfiguration":{"description":"The configuration for reminders.","type":"object","properties":{"Enabled":{"description":"If true, reminders are sent.","type":"boolean"},"FirstReminderInDays":{"format":"int32","description":"The amount of days until a reminder is sent to a signer or a viewer after the initial notification.","type":"integer"},"ReminderResendIntervalInDays":{"format":"int32","description":"The amount of days until a reminder is sent again to a signer or a viewer.","type":"integer"},"BeforeExpirationInDays":{"format":"int32","description":"The amount of days before the envelope expires and a reminder should be sent.","type":"integer"}}},"EnvelopeGetConfigurationExpirationConfiguration":{"description":"The configuration of the expiration for the sent envelope.","type":"object","properties":{"ExpirationDate":{"format":"date-time","description":"The absolute expiration date of the sent envelope.\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","type":"string"}}},"EnvelopeGetConfigurationCallbackConfiguration":{"description":"The configuration of the callbacks for a custom integration.","type":"object","properties":{"CallbackUrl":{"description":"The callback URL triggered when the envelope has been finished.","type":"string"},"StatusUpdateCallbackUrl":{"description":"The callback URL triggered for status updates of an envelope.","type":"string"},"ActivityActionCallbackConfiguration":{"$ref":"#/definitions/EnvelopeGetConfigurationActivityActionCallbackConfiguration","description":"The configuration of the callback for workstep events."}}},"EnvelopeGetConfigurationAgreementConfiguration":{"description":"The configuration of the agreement.","type":"object","properties":{"Translations":{"description":"The agreement and its translations to be used.\r\nIf no custom agreement is specified, the default organization agreement will be used.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetConfigurationAgreementTranslation"}}}},"EnvelopeGetConfigurationSealingConfiguration":{"description":"The configuration for sealing.","type":"object","properties":{"CertificateId":{"description":"Sealing certificate used.","type":"string"}}},"EnvelopeGetConfigurationAction":{"description":"The action of the activity.","type":"object","properties":{"SendCopy":{"$ref":"#/definitions/EnvelopeGetConfigurationSendCopy","description":"The configuration of the copy action."},"Sign":{"$ref":"#/definitions/EnvelopeGetConfigurationSign","description":"The configuration of the sign action."},"View":{"$ref":"#/definitions/EnvelopeGetConfigurationView","description":"The configuration of the view action."},"SignAsP7M":{"$ref":"#/definitions/EnvelopeGetConfigurationSignAsP7M","description":"The configuration of the P7M sign action."}}},"EnvelopeGetConfigurationVisibilityOption":{"description":"The options defining the document visibility.","type":"object","properties":{"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"IsHidden":{"description":"If true, the referenced document is hidden for the activity.","type":"boolean"}}},"EnvelopeGetConfigurationActivityActionCallbackConfiguration":{"description":"The configuration of the callback for workstep events.","type":"object","properties":{"Url":{"description":"The callback URL triggered for the selected events.","type":"string"},"ConfigurationActionCallbackSelection":{"$ref":"#/definitions/EnvelopeGetConfigurationActionCallbackSelection","description":"The selection of events which trigger the callback."}}},"EnvelopeGetConfigurationAgreementTranslation":{"description":"A translation for the agreement.","type":"object","properties":{"LanguageCode":{"description":"The language of the translated agreement.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string","x-ms-enum":{"name":"LanguageCode","modelAsString":false}},"Text":{"description":"The translated agreement.","type":"string"},"Header":{"description":"The header for the translated agreement.","type":"string"},"IsDefault":{"description":"If true, this translation is used as default.","type":"boolean"}}},"EnvelopeGetConfigurationSendCopy":{"description":"The configuration of an action to send a copy of the documents to the recipient.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/EnvelopeGetConfigurationBasicRecipientConfiguration","description":"The configuration of the recipient."},"CopyingGroup":{"format":"int32","description":"The parallel group for copy actions.","type":"integer"}}},"EnvelopeGetConfigurationSign":{"description":"The configuration of the sign action for the recipient.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/EnvelopeGetConfigurationAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"FinishActionConfiguration":{"$ref":"#/definitions/EnvelopeGetConfigurationFinishAction","description":"Defines what happens in the signing clients, after an action has been finished."},"SignatureDataConfiguration":{"$ref":"#/definitions/EnvelopeGetConfigurationSignatureDataConfiguration","description":"The configuration of recipient data for special signatures."},"BatchConfiguration":{"$ref":"#/definitions/EnvelopeGetConfigurationBatchConfiguration","description":"The configuration of a signing batch."},"SigningGroup":{"format":"int32","description":"The parallel group for sign actions.","type":"integer"},"GeneralPoliciesOverrides":{"$ref":"#/definitions/EnvelopeGetConfigurationGeneralPoliciesForSignAction","description":"Viewer policy settings for override."}}},"EnvelopeGetConfigurationView":{"description":"The configuration of the action to view and acknowledge the documents.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/EnvelopeGetConfigurationRecipientConfiguration","description":"The configuration of the recipient."},"ViewingGroup":{"format":"int32","description":"The parallel group for view actions.","type":"integer"},"GeneralPoliciesOverrides":{"$ref":"#/definitions/EnvelopeGetConfigurationGeneralPoliciesForViewAction","description":"Viewer policy settings for override."}}},"EnvelopeGetConfigurationSignAsP7M":{"description":"The configuration of an action to sign documents with P7M.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/EnvelopeGetConfigurationAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"SignatureMethods":{"$ref":"#/definitions/EnvelopeGetConfigurationP7MSignatureMethods","description":"The configuration of recipient data for P7M signatures."},"SignAsP7MGroup":{"format":"int32","description":"The parallel group for P7M actions.","type":"integer"},"GeneralPoliciesOverrides":{"$ref":"#/definitions/EnvelopeGetConfigurationGeneralPoliciesForP7MAction","description":"Viewer policy settings for override."}}},"EnvelopeGetConfigurationActionCallbackSelection":{"description":"The selection of events which trigger the callback.","type":"object","properties":{"ConfirmTransactionCode":{"description":"If true, the callback is triggered when a transaction code was sent. This is only used for legacy disposable certificates, after user accepted issuance of disposable certificate.","type":"boolean"},"AgreementAccepted":{"description":"If true, the callback is triggered when the user accepted the agreement.","type":"boolean"},"AgreementRejected":{"description":"If true, the callback is triggered when the user rejected the agreement.","type":"boolean"},"PrepareAuthenticationSuccess":{"description":"If true, the callback is triggered when the preparation of the authentication process succeeded.","type":"boolean"},"AuthenticationFailed":{"description":"If true, the callback is triggered when the user failed to authenticate.","type":"boolean"},"AuthenticationSuccess":{"description":"If true, the callback is triggered when the user succeeded to authenticate.","type":"boolean"},"AuditTrailRequested":{"description":"If true, the callback is triggered when the audit trail was requested.","type":"boolean"},"AuditTrailXmlRequested":{"description":"If true, the callback is triggered when the audit trail XML was requested.","type":"boolean"},"CalledPage":{"description":"If true, the callback is triggered when the SignAnyWhere Viewer was requested.","type":"boolean"},"DocumentDownloaded":{"description":"If true, the callback is triggered when the document download was requested.","type":"boolean"},"FlattenedDocumentDownloaded":{"description":"If true, the callback is triggered when the flattened document download was requested.","type":"boolean"},"AddedAnnotation":{"description":"If true, the callback is triggered when an annotation was added.","type":"boolean"},"AddedAttachment":{"description":"If true, the callback is triggered when an attachment was added.","type":"boolean"},"AppendedDocument":{"description":"If true, the callback is triggered when a document was appended.","type":"boolean"},"FormsFilled":{"description":"If true, the callback is triggered when a form field was filled.","type":"boolean"},"ConfirmReading":{"description":"If true, the callback is triggered when a reading task was completed.","type":"boolean"},"SendTransactionCode":{"description":"If true, the callback is triggered when a transaction code for a signature with type TransactionCode was sent using the TransactionCodeSenderPlugin.","type":"boolean"},"PrepareSignWorkstepDocument":{"description":"If true, the callback is triggered when a signature was prepared for signing.","type":"boolean"},"SignWorkstepDocument":{"description":"If true, the callback is triggered when a signature was applied.","type":"boolean"},"UndoAction":{"description":"If true, the callback is triggered when an action was undone.","type":"boolean"},"WorkstepCreated":{"description":"If true, the callback is triggered when a workstep was created.","type":"boolean"},"WorkstepFinished":{"description":"If true, the callback is triggered when a workstep was finished.","type":"boolean"},"WorkstepRejected":{"description":"If true, the callback is triggered when a workstep was rejected.","type":"boolean"},"DisablePolicyAndValidityChecks":{"description":"If true, the callback is triggered when policy and validity checks were disabled.","type":"boolean"},"EnablePolicyAndValidityChecks":{"description":"If true, the callback is triggered when policy and validity checks were enabled.","type":"boolean"},"AppendFileToWorkstep":{"description":"If true, the callback is triggered when a file was appended to the workstep.","type":"boolean"},"AppendTasksToWorkstep":{"description":"If true, the callback is triggered when a task was added to the workstep.","type":"boolean"},"SetOptionalDocumentState":{"description":"If true, the callback is triggered when an optional document became either active or inactive.","type":"boolean"},"PreparePayloadForBatch":{"description":"If true, the callback is triggered when the payload was prepared for batch signing.","type":"boolean"}}},"EnvelopeGetConfigurationBasicRecipientConfiguration":{"description":"The configuration of the recipient.","type":"object","properties":{"PersonalMessage":{"description":"The personal message for the recipient.","type":"string"}}},"EnvelopeGetConfigurationAdvancedRecipientConfiguration":{"description":"The advanced configuration for the recipient.","type":"object","properties":{"PersonalMessage":{"description":"The personal message for the recipient.","type":"string"},"AuthenticationConfiguration":{"$ref":"#/definitions/EnvelopeGetConfigurationAuthenticationConfiguration","description":"The configuration for the authentication of the recipient."},"SendEmails":{"description":"If true, emails will be sent out for this recipient.","type":"boolean"},"AllowAccessAfterFinish":{"description":"If true, the recipient is allowed to access the action after it has been finished.","type":"boolean"},"RequireViewContentBeforeFormFilling":{"description":"If true, the signer has to confirm the reading of all documents as first task.","type":"boolean"},"IncludedEmailAppLinks":{"$ref":"#/definitions/EnvelopeGetConfigurationEmailAppLinks","description":"The configuration for mobile app links in email messages."},"AllowDelegation":{"description":"If true, the recipient may delegate this activity.","type":"boolean"}}},"EnvelopeGetConfigurationFinishAction":{"description":"Defines what happens in the signing clients, after an action has been finished.","type":"object","properties":{"SignAnyWhereViewer":{"$ref":"#/definitions/EnvelopeGetConfigurationWebFinishAction","description":"The actions for the SAW Viewer."},"SignificantClientSignatureCaptureForIos":{"$ref":"#/definitions/EnvelopeGetConfigurationAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for iOS."},"SignificantClientSignatureCaptureForAndroid":{"$ref":"#/definitions/EnvelopeGetConfigurationAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for Android."},"SignificantClientSignatureCaptureForWindows":{"$ref":"#/definitions/EnvelopeGetConfigurationAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for Windows."},"KioskSdk":{"$ref":"#/definitions/EnvelopeGetConfigurationKioskFinishAction","description":"The actions for the SIGNificant Kiosk SDK."}}},"EnvelopeGetConfigurationSignatureDataConfiguration":{"description":"The recipient configuration for signing.","type":"object","properties":{"DisposableCertificate":{"$ref":"#/definitions/EnvelopeGetConfigurationDisposableCertificateSignatureData","description":"The disposable certificate configuration for the action."},"RemoteCertificate":{"$ref":"#/definitions/EnvelopeGetConfigurationRemoteCertificateSignatureData","description":"The remote certificate configuration for the action."},"SwissComOnDemand":{"$ref":"#/definitions/EnvelopeGetConfigurationSwissComOnDemandSignatureData","description":"The Swisscom On-Demand certificate configuration for the action."},"SmsOneTimePassword":{"$ref":"#/definitions/EnvelopeGetConfigurationSmsOneTimePasswordSignatureData","description":"The one time password configuration for the action (SMS-OTP)."},"ATrustCertificate":{"$ref":"#/definitions/EnvelopeGetConfigurationATrustCertificateSignatureData","description":"The A-Trust certificate configuration for the action."},"SwedishBankId":{"$ref":"#/definitions/EnvelopeGetConfigurationSwedishBankIdSignatureData","description":"The Swedish BankID configuration for the action."},"SignaturePluginData":{"description":"The signature plugin configurations for the action.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetConfigurationSignaturePluginSignatureData"}}}},"EnvelopeGetConfigurationBatchConfiguration":{"description":"The configuration of a signing batch.","type":"object","properties":{"Mode":{"description":"The mode, that will be used for batch signing.","enum":["Basic","OptIn","OptOut","OptOutWithRequiredAlwaysSelected","OptInWithRequiredAlwaysSelected"],"type":"string","x-ms-enum":{"name":"BatchMode","modelAsString":false}},"RequireScrollingOverAllSignaturesBeforeSigning":{"description":"If true, the user has to review all signatures in the batch signing dialog before signing.\r\nThis is only applicable when the <code>Mode<\/code> is set to <code>OptIn<\/code> or <code>OptOut<\/code>.","type":"boolean"}}},"EnvelopeGetConfigurationGeneralPoliciesForSignAction":{"description":"Define the general policies allowed for sign action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"},"AllowAdhocPdfAttachments":{"description":"If true, the client is allowed to append adhoc documents.","type":"boolean"},"AllowRejectWorkstep":{"description":"If true, the client is allowed to reject the workstep.","type":"boolean"},"AllowUndoLastAction":{"description":"If true, the client is allowed to undo actions.","type":"boolean"}}},"EnvelopeGetConfigurationRecipientConfiguration":{"description":"The configuration of the recipient.","type":"object","properties":{"PersonalMessage":{"description":"The personal message for the recipient.","type":"string"},"AuthenticationConfiguration":{"$ref":"#/definitions/EnvelopeGetConfigurationAuthenticationConfiguration","description":"The configuration for the authentication of the recipient."},"SendEmails":{"description":"If true, emails will be sent out for this recipient.","type":"boolean"},"AllowAccessAfterFinish":{"description":"If true, the recipient is allowed to access the action after it has been finished.","type":"boolean"}}},"EnvelopeGetConfigurationGeneralPoliciesForViewAction":{"description":"Define the general policies allowed for view action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"}}},"EnvelopeGetConfigurationP7MSignatureMethods":{"description":"The recipient configuration for signing with P7M.","type":"object","properties":{"LocalCertificate":{"description":"If true, a local certificate can be used.","type":"boolean"},"DisposableCertificate":{"$ref":"#/definitions/EnvelopeGetConfigurationDisposableCertificateSignatureData","description":"The disposable certificate configuration for the action."},"RemoteCertificate":{"$ref":"#/definitions/EnvelopeGetConfigurationRemoteCertificateSignatureData","description":"The remote certificate configuration for the action."},"SignaturePluginData":{"description":"The signature plugin configurations for the action.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetConfigurationSignaturePluginSignatureData"}}}},"EnvelopeGetConfigurationGeneralPoliciesForP7MAction":{"description":"Define the general policies allowed for P7M action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"},"AllowAdhocPdfAttachments":{"description":"If true, the client is allowed to append adhoc documents.","type":"boolean"},"AllowRejectWorkstep":{"description":"If true, the client is allowed to reject the workstep.","type":"boolean"},"AllowUndoLastAction":{"description":"If true, the client is allowed to undo actions.","type":"boolean"},"AllowDownloadOfSignedP7MFiles":{"description":"If true, the client is allowed to download signed p7m files.","type":"boolean"}}},"EnvelopeGetConfigurationAuthenticationConfiguration":{"description":"The definition of the authentications of the recipient.","type":"object","properties":{"AccessCode":{"$ref":"#/definitions/EnvelopeGetConfigurationAccessCodeAuthentication","description":"The configuration of the authentication with an access code."},"SmsOneTimePassword":{"$ref":"#/definitions/EnvelopeGetConfigurationSmsOneTimePasswordAuthentication","description":"The configuration of the authentication with one time password over SMS."},"SwedishBankId":{"$ref":"#/definitions/EnvelopeGetConfigurationSwedishBankIdAuthentication","description":"The configuration of the authentication with Swedish BankID."},"OAuthAuthentications":{"description":"The configurations of the authentication with OAuth.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetConfigurationOAuthAuthentication"}},"SamlAuthentications":{"description":"The configurations of the authentication with SAML.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetConfigurationSamlAuthentication"}}}},"EnvelopeGetConfigurationEmailAppLinks":{"description":"Configure if links for our Apps should be included in the document signing request email message.","type":"object","properties":{"Android":{"description":"If true, an Android app link is added to the email message.","type":"boolean"},"iOS":{"description":"If true, an iOS app link is added to the email message.","type":"boolean"},"Windows":{"description":"If true, a Windows app link is added to the email message.","type":"boolean"}}},"EnvelopeGetConfigurationWebFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RedirectUri":{"description":"The redirect uri.","type":"string"}}},"EnvelopeGetConfigurationAppFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RemoveDocumentFromRecentDocumentList":{"description":"If true, the document will be removed from the recent document list.","type":"boolean"},"CallClientActionOnlyAfterSuccessfulSync":{"description":"If true, the client action will be called only after a successful sync.","type":"boolean"},"CloseApp":{"description":"If true, the app will be closed.","type":"boolean"},"RedirectUri":{"description":"The redirect uri.","type":"string"}}},"EnvelopeGetConfigurationKioskFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RedirectUri":{"description":"The redirect uri.","type":"string"}}},"EnvelopeGetConfigurationDisposableCertificateSignatureData":{"description":"The recipient configuration for signing with a disposable certificate.","type":"object","properties":{"DocumentIssuingCountry":{"description":"The issuing country of the document.\r\nWill be used as country of residence, if lean is disabled.","type":"string"},"IdentificationIssuingCountry":{"description":"The issuing country of the identification.","type":"string"},"IdentificationType":{"description":"The type of identification in use.","enum":["None","ForeignTaxCode","PersonalNumber","Passport","NationalIdentityCard","ItalianTaxCode","NoSerialNumber","DrivingLicense","ResidencePermit","TemporaryResidencePermit","EmbassyDocument","AML"],"type":"string","x-ms-enum":{"name":"DisposableCertificateIdentificationType","modelAsString":false}},"PhoneNumber":{"description":"The phone number registered for identification.","type":"string"},"DocumentType":{"description":"The type of document used for the identification.","enum":["IdentityCard","DriverLicense","Passport","ResidencePermit","NationalElectronicIdentityCard","TemporaryResidencePermit","EmbassyDocument"],"type":"string","x-ms-enum":{"name":"DisposableCertificateDocumentType","modelAsString":false}},"DocumentIssuedBy":{"description":"The authority that issued the document.","type":"string"},"DocumentIssuedOn":{"format":"date","description":"The date when the document has been issued.\r\nA date in the format RFC 3339, section 5.6, 'full-date' (e.g. 2017-07-21).","type":"string"},"DocumentExpiryDate":{"format":"date","description":"The expiration date of the document.\r\nA date in the format RFC 3339, section 5.6, 'full-date' (e.g. 2017-07-21).","type":"string"},"SerialNumber":{"description":"The serial number of the certificate.","type":"string"},"DocumentNumber":{"description":"The identifier of the document.","type":"string"}}},"EnvelopeGetConfigurationRemoteCertificateSignatureData":{"description":"The recipient configuration for signing with a remote certificate.","type":"object","properties":{"UserId":{"description":"The identifier of the user.","type":"string"},"DeviceId":{"description":"The identifier of the device.","type":"string"}}},"EnvelopeGetConfigurationSwissComOnDemandSignatureData":{"description":"The recipient configuration for signing with a Swisscom On-Demand certificate.","type":"object","properties":{"PhoneNumber":{"description":"The phone number.","type":"string"},"CommonName":{"description":"The name of the certificate that is created or checked.","type":"string"},"Country":{"description":"The country.","type":"string"},"Locality":{"description":"The locality.","type":"string"},"OrganizationUnit":{"description":"The organizational unit.","type":"string"},"Organization":{"description":"The organization.","type":"string"},"SerialNumber":{"description":"The serial number.","type":"string"},"StateOrProvince":{"description":"The state or province.","type":"string"},"Pseudonym":{"description":"A name or key that uniquely identifies the user.","type":"string"}}},"EnvelopeGetConfigurationSmsOneTimePasswordSignatureData":{"description":"The recipient configuration for signing with a one time password sent via SMS.","type":"object","properties":{"PhoneNumber":{"description":"The phone number to which the one time password will be sent.","type":"string"}}},"EnvelopeGetConfigurationATrustCertificateSignatureData":{"description":"The recipient configuration for signing with an A-Trust certificate.","type":"object","properties":{"PhoneNumber":{"description":"The phone number of the recipient.","type":"string"}}},"EnvelopeGetConfigurationSwedishBankIdSignatureData":{"description":"The recipient configuration for signing with Swedish BankID.","type":"object","properties":{"PersonalNumber":{"description":"The personal number for signing.","type":"string"},"AllowAnyPersonalNumber":{"description":"If true, the personal number can be edited by the recipient.\r\nIf the personal number is empty and can be edited, a QR code for scanning is provided.","type":"boolean"}}},"EnvelopeGetConfigurationSignaturePluginSignatureData":{"description":"The recipient configuration for signing with a signature plugin.","type":"object","properties":{"PluginId":{"description":"The identifier of the signature plugin.","type":"string"},"Fields":{"description":"The plugin parameters referred to as the GSP sender data fields.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetConfigurationSignaturePluginParameter"}}}},"EnvelopeGetConfigurationAccessCodeAuthentication":{"description":"The configuration for authentication with a predefined access code.","type":"object","properties":{"Code":{"description":"The code for authenticating the recipient.","type":"string"}}},"EnvelopeGetConfigurationSmsOneTimePasswordAuthentication":{"description":"The configuration for authentication with a one time password sent over SMS.","type":"object","properties":{"PhoneNumber":{"description":"The phone number to which the one time password will be sent.","type":"string"}}},"EnvelopeGetConfigurationSwedishBankIdAuthentication":{"description":"The configuration for Swedish BankID authentication.","type":"object","properties":{"PersonalNumber":{"description":"The personal number for the authentication.","type":"string"},"AllowAnyPersonalNumber":{"description":"If true, the personal number can be edited by the recipient.\r\nIf the personal number is empty and can be edited, a QR code for scanning is provided.","type":"boolean"}}},"EnvelopeGetConfigurationOAuthAuthentication":{"description":"The configuration for authentication with an OAuth provider.","type":"object","properties":{"ProviderName":{"description":"The name of the OAuth provider.","type":"string"},"Validations":{"description":"The validation rules for the OAuth response.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetConfigurationAuthenticationValidation"}}}},"EnvelopeGetConfigurationSamlAuthentication":{"description":"The configuration for authentication with a SAML provider.","type":"object","properties":{"ProviderName":{"description":"The name of the SAML provider.","type":"string"},"Validations":{"description":"The validation rules for the SAML response.","type":"array","items":{"$ref":"#/definitions/EnvelopeGetConfigurationAuthenticationValidation"}}}},"EnvelopeGetConfigurationSignaturePluginParameter":{"description":"The definition of a signature plugin parameter.","type":"object","properties":{"Key":{"description":"The identifier of the parameter.","type":"string"},"Value":{"description":"The value of the parameter.","type":"string"}}},"EnvelopeGetConfigurationAuthenticationValidation":{"description":"A validation rule for an authentication response.","type":"object","properties":{"FieldReferenceId":{"description":"The identifier of the field.","type":"string"},"ExpectedValue":{"description":"The expected value of the field.","type":"string"}}},"EnvelopeFindRequest":{"description":"The request model for searching envelopes.","type":"object","properties":{"StartDate":{"format":"date-time","description":"If set, filter for envelopes which were sent after the start date.\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","maxLength":30,"minLength":20,"type":"string"},"EndDate":{"format":"date-time","description":"If set, filter for envelopes which were sent before the end date.\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","maxLength":30,"minLength":20,"type":"string"},"SearchText":{"description":"If set, the given text is searched in following fields:\r\nenvelope name and description\r\nnotification subject and message \r\nsender email address, given name and surname  \r\nrecipient email address, given name and surname\r\nNote: Using this search option is very resource intensive! It might take very long.","maxLength":500,"minLength":0,"type":"string"},"Status":{"description":"If set, envelopes in the given status are matched.","enum":["Canceled","Completed","Expired","Rejected","ActionRequired","WaitingForOthers","ExpiringSoon","Active"],"type":"string"},"InStatusSinceDays":{"description":"If set, envelopes having the given status for the specified days are matched.\r\nIt must be combined with Status.","type":"integer"},"SenderEmail":{"description":"If set, envelopes sent by the user with the given email address are matched.","maxLength":250,"minLength":0,"type":"string"},"CompletedByRecipientWithEmail":{"description":"If set, envelopes containing a completed activity, belonging to a recipient with the given email address, are matched.","maxLength":250,"minLength":0,"type":"string"},"RecipientEmail":{"description":"If set, envelopes containing a recipient with the given email address are matched.","maxLength":250,"minLength":0,"type":"string"},"WaitingForRecipientWithEmail":{"description":"If set, envelopes waiting for the recipient with the given email address are matched.","maxLength":250,"minLength":0,"type":"string"},"EnvelopeBulkParentId":{"description":"If set, envelopes belonging to the given BulkParent envelope are matched.","maxLength":36,"minLength":36,"type":"string"}}},"EnvelopeFindResponse":{"description":"The response model for the found envelopes.","type":"object","properties":{"Envelopes":{"description":"The envelopes which match the search criteria.","type":"array","items":{"$ref":"#/definitions/EnvelopeFindEnvelope"}}}},"EnvelopeFindEnvelope":{"description":"The response model for a found envelope.","type":"object","properties":{"Status":{"description":"The status of the envelope.","enum":["Active","Completed","Canceled","Expired","Rejected"],"type":"string","x-ms-enum":{"name":"EnvelopeStatusExternal","modelAsString":false}},"Id":{"description":"The identifier of the envelope.","type":"string"},"Name":{"description":"The name of the envelope.","type":"string"},"MetaData":{"description":"The metadata of the envelope.","type":"string"},"EnvelopeBulkParentId":{"description":"The identifier of the BulkParent envelope.\r\nOnly set, if the envelope is part of a bulk.","type":"string"},"IsExpiringSoon":{"description":"If true, the envelope will expire within the configured time period  [Configuration key: filterExpiringSoonDays, Default: 4 days].","type":"boolean"}}},"EnvelopeSendDocument":{"description":"Define a document.","required":["FileId"],"type":"object","properties":{"FileId":{"description":"The identifier of the file.","maxLength":36,"minLength":36,"type":"string"},"DocumentNumber":{"format":"int32","description":"The document number.\r\nIf the document number is 0 for all documents, the order of the documents is used as number.\r\nThe document number must not be duplicated.\r\nThe document number must be set for all documents or none.","type":"integer"}}},"EnvelopeSendUnassignedElements":{"description":"The configurable elements of a document, which are also stored within the document.","type":"object","properties":{"TextBoxes":{"description":"The text boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendTextBox"}},"CheckBoxes":{"description":"The check boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendCheckBox"}},"ComboBoxes":{"description":"The combo boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendComboBox"}},"RadioButtons":{"description":"The radio buttons.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendRadioButtonGroup"}},"ListBoxes":{"description":"The list boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendListBox"}}}},"EnvelopeSendActivity":{"description":"Define an activity in the process.","type":"object","properties":{"Action":{"$ref":"#/definitions/EnvelopeSendAction","description":"The action assigned to the activity."},"VisibilityOptions":{"description":"The document visibility options for the activity.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendVisibilityOption"}}}},"EnvelopeSendEmailConfiguration":{"description":"The configuration for notifications.","type":"object","properties":{"Subject":{"description":"The subject of the sign notifications.","maxLength":300,"minLength":0,"type":"string"},"Message":{"description":"The message of the sign notifications.","maxLength":204800,"minLength":0,"type":"string"},"SenderDisplayName":{"description":"The displayed name of the sender in the notifications.","maxLength":200,"minLength":0,"type":"string"}}},"EnvelopeSendAgreementConfiguration":{"description":"The configuration of the agreement.","type":"object","properties":{"Translations":{"description":"The agreement and its translations to be used.\r\nIf no custom agreement is specified, the default organization agreement will be used.","maxItems":228,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendAgreementTranslation"}}}},"EnvelopeSendSealingConfiguration":{"description":"The sealing configuration for the envelope","type":"object","properties":{"CertificateId":{"description":"Custom Sealing certificate identifier.","maxLength":36,"minLength":0,"type":"string"}}},"EnvelopeSendAction":{"description":"The action of the activity. Exactly one definition must be used!","type":"object","properties":{"SendCopy":{"$ref":"#/definitions/EnvelopeSendSendCopy","description":"The definition of the copy action."},"SignAutomatic":{"$ref":"#/definitions/EnvelopeSendSignAutomatic","description":"The definition of the automatic sign action."},"Sign":{"$ref":"#/definitions/EnvelopeSendSign","description":"The definition of the sign action."},"View":{"$ref":"#/definitions/EnvelopeSendView","description":"The definition of the view action."},"SignAsP7M":{"$ref":"#/definitions/EnvelopeSendSignAsP7M","description":"The definition of the P7M sign action."}}},"EnvelopeSendVisibilityOption":{"description":"The options defining the document visibility.","type":"object","properties":{"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"IsHidden":{"description":"If true, the referenced document is hidden for the activity.","type":"boolean"}}},"EnvelopeSendActivityActionCallbackConfiguration":{"description":"The configuration of the callback for workstep events.","required":["Url"],"type":"object","properties":{"Url":{"description":"The callback URL triggered for the selected events.","maxLength":8000,"minLength":0,"type":"string"},"ActionCallbackSelection":{"$ref":"#/definitions/EnvelopeSendActionCallbackSelection","description":"The selection of events which trigger the callback."}}},"EnvelopeSendAgreementTranslation":{"description":"A translation for the agreement.","required":["LanguageCode","Text"],"type":"object","properties":{"LanguageCode":{"description":"The language of the translated agreement.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string","x-ms-enum":{"name":"LanguageCode","modelAsString":false}},"Text":{"description":"The translated agreement.","maxLength":204800,"minLength":0,"type":"string"},"Header":{"description":"The header for the translated agreement.","maxLength":1000,"minLength":0,"type":"string"},"IsDefault":{"description":"If true, this translation is used as default.","type":"boolean"}}},"EnvelopeSendFieldValidation":{"description":"The configuration of the field validation rules.","type":"object","properties":{"Type":{"description":"The type of the value.","enum":["None","Date","Email","Number","Phone","Time"],"type":"string","x-ms-enum":{"name":"FieldValidationType","modelAsString":false}},"DateValidationConfiguration":{"$ref":"#/definitions/EnvelopeSendDateValidationConfiguration","description":"The validation rules for dates."},"NumberValidationConfiguration":{"$ref":"#/definitions/EnvelopeSendNumberValidationConfiguration","description":"The validation rules for numbers."},"PhoneValidationConfiguration":{"$ref":"#/definitions/EnvelopeSendPhoneValidationConfiguration","description":"The validation rules for phone numbers."},"TimeValidationConfiguration":{"$ref":"#/definitions/EnvelopeSendTimeValidationConfiguration","description":"The validation rules for time values."}}},"EnvelopeSendSendCopy":{"description":"An action to send a copy of the documents to the recipient.","required":["RecipientConfiguration"],"type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/EnvelopeSendBasicRecipientConfiguration","description":"The configuration of the recipient."},"CopyingGroup":{"description":"The group for defining parallel copy actions.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeSendView":{"description":"An action to view and acknowledge the documents.","required":["RecipientConfiguration"],"type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/EnvelopeSendRecipientConfiguration","description":"The configuration of the recipient."},"ViewingGroup":{"description":"The group for defining parallel view actions.","maxLength":500,"minLength":0,"type":"string"},"GeneralPoliciesOverrides":{"$ref":"#/definitions/EnvelopeSendGeneralPoliciesForViewAction","description":"Viewer policy settings for override."}}},"EnvelopeSendSignAsP7M":{"description":"An action to sign the documents with P7M.","required":["RecipientConfiguration","SignatureMethods"],"type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/EnvelopeSendAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"SignatureMethods":{"$ref":"#/definitions/EnvelopeSendP7MSignatureMethods","description":"The configuration of recipient data for P7M signatures."},"SignAsP7MGroup":{"description":"The group for defining parallel P7M actions.","maxLength":500,"minLength":0,"type":"string"},"GeneralPoliciesOverrides":{"$ref":"#/definitions/EnvelopeSendGeneralPoliciesForP7MAction","description":"Viewer policy settings for override."}}},"EnvelopeSendDateValidationConfiguration":{"description":"The validation rules for dates.","type":"object","properties":{"DateFormat":{"description":"The format of the dates.","maxLength":50,"minLength":0,"type":"string"},"Range":{"$ref":"#/definitions/EnvelopeSendFieldValidationRange","description":"The range of the values."}}},"EnvelopeSendTimeValidationConfiguration":{"description":"The validation rules for time values.","type":"object","properties":{"TimeFormat":{"description":"The format of the time values.","maxLength":50,"minLength":0,"type":"string"},"Range":{"$ref":"#/definitions/EnvelopeSendFieldValidationRange","description":"The range of the values."}}},"EnvelopeSendPosition":{"description":"The position of an element on the document.","required":["X","Y"],"type":"object","properties":{"PageNumber":{"format":"int32","description":"The number of the page where the element is located. It starts with 1.","type":"integer"},"X":{"format":"double","description":"The X coordinate in points. It starts from the left.","type":"number"},"Y":{"format":"double","description":"The Y coordinate in points. It starts from the bottom.","type":"number"}}},"EnvelopeSendSize":{"description":"The definition of the size of an element.","required":["Width","Height"],"type":"object","properties":{"Width":{"format":"double","description":"The width of the element in points.","type":"number"},"Height":{"format":"double","description":"The height of the element in points.","type":"number"}}},"EnvelopeSendChoiceItem":{"description":"The configuration of the choice item.","required":["DisplayValue"],"type":"object","properties":{"ExportValue":{"description":"The value of the element when the choice item is selected.","maxLength":500,"minLength":0,"type":"string"},"DisplayValue":{"description":"The displayed value of the choice item.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeSendBasicRecipientConfiguration":{"description":"The configuration of the recipient.","required":["ContactInformation"],"type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/EnvelopeSendContactInformation","description":"The contact information of the recipient."},"PersonalMessage":{"description":"The personal message for the recipient.","maxLength":204800,"minLength":0,"type":"string"}}},"EnvelopeSendElements":{"description":"The configurable elements of the documents.","type":"object","properties":{"TextBoxes":{"description":"The text boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendTextBox"}},"CheckBoxes":{"description":"The check boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendCheckBox"}},"ComboBoxes":{"description":"The combo boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendComboBox"}},"RadioButtons":{"description":"The radio buttons.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendRadioButtonGroup"}},"ListBoxes":{"description":"The list boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendListBox"}},"Signatures":{"description":"The signatures.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendSignatureField"}},"Attachments":{"description":"The attachments.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendAttachment"}},"PredefinedFieldElements":{"$ref":"#/definitions/EnvelopeSendPredefinedFieldElements","description":"The predefined field elements."},"LinkConfiguration":{"$ref":"#/definitions/EnvelopeSendLinkConfiguration","description":"The links in the documents."},"AreaReadConfirmations":{"description":"The areas which have to be read.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendReadAreaConfirmation"}},"PageReadConfirmations":{"description":"The pages which have to be read.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendReadPagesConfirmation"}},"DocumentReadConfirmations":{"description":"The documents which have to be read.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendReadDocumentConfirmation"}}}},"EnvelopeSendFinishAction":{"description":"Define what happens in the signing clients, after an action has been finished.","type":"object","properties":{"SignAnyWhereViewer":{"$ref":"#/definitions/EnvelopeSendClientFinishAction","description":"The actions for the SAW Viewer."},"SignificantClientSignatureCaptureForIos":{"$ref":"#/definitions/EnvelopeSendAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for iOS."},"SignificantClientSignatureCaptureForAndroid":{"$ref":"#/definitions/EnvelopeSendAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for Android."},"SignificantClientSignatureCaptureForWindows":{"$ref":"#/definitions/EnvelopeSendAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for Windows."},"KioskSdk":{"$ref":"#/definitions/EnvelopeSendKioskFinishAction","description":"The actions for the SIGNificant Kiosk SDK."}}},"EnvelopeSendSignatureDataConfiguration":{"description":"The recipient configuration for signing.","type":"object","properties":{"DisposableCertificate":{"$ref":"#/definitions/EnvelopeSendDisposableCertificateSignatureData","description":"The disposable certificate configuration for the action."},"RemoteCertificate":{"$ref":"#/definitions/EnvelopeSendRemoteCertificateSignatureData","description":"The remote certificate configuration for the action."},"SwissComOnDemand":{"$ref":"#/definitions/EnvelopeSendSwissComOnDemandSignatureData","description":"The Swisscom On-Demand certificate configuration for the action."},"SmsOneTimePassword":{"$ref":"#/definitions/EnvelopeSendSmsOneTimePasswordSignatureData","description":"The one time password configuration for the action (SMS-OTP)."},"ATrustCertificate":{"$ref":"#/definitions/EnvelopeSendATrustCertificateSignatureData","description":"The A-Trust certificate configuration for the action."},"SwedishBankId":{"$ref":"#/definitions/EnvelopeSendSwedishBankIdSignatureData","description":"The Swedish BankID configuration for the action."},"SignaturePluginData":{"description":"The signature plugin configurations for the action.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendSignaturePluginSignatureData"}}}},"EnvelopeSendBatchConfiguration":{"description":"The configuration of a signing batch.","type":"object","properties":{"Mode":{"description":"The mode, that will be used for batch signing.","enum":["Basic","OptIn","OptOut","OptOutWithRequiredAlwaysSelected","OptInWithRequiredAlwaysSelected"],"type":"string","x-ms-enum":{"name":"BatchMode","modelAsString":false}},"RequireScrollingOverAllSignaturesBeforeSigning":{"description":"If true, the user has to review all signatures in the batch signing dialog before signing.\r\nThis is only applicable when the <code>Mode<\/code> is set to <code>OptIn<\/code> or <code>OptOut<\/code>.","type":"boolean"}}},"EnvelopeSendFieldValidationRange":{"description":"The validation rules for a value range.","type":"object","properties":{"From":{"description":"The lower boundary of the range.","maxLength":100,"minLength":0,"type":"string"},"To":{"description":"The upper boundary of the range.","maxLength":100,"minLength":0,"type":"string"}}},"EnvelopeSendSignatureFieldDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/EnvelopeSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeSendSize","description":"The size of the element."}}},"EnvelopeSendAuthenticationConfiguration":{"description":"The definition of the authentications of the recipient.","type":"object","properties":{"AccessCode":{"$ref":"#/definitions/EnvelopeSendAccessCodeAuthentication","description":"The configuration of the authentication with an access code."},"SmsOneTimePassword":{"$ref":"#/definitions/EnvelopeSendSmsOneTimePasswordAuthentication","description":"The configuration of the authentication with one time password over SMS."},"SwedishBankId":{"$ref":"#/definitions/EnvelopeSendSwedishBankIdAuthentication","description":"The configuration of the authentication with Swedish BankID."},"OAuthAuthentications":{"description":"The configurations of the authentication with OAuth.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendOAuthAuthentication"}},"SamlAuthentications":{"description":"The configurations of the authentication with SAML.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendSamlAuthentication"}}}},"EnvelopeSendPredefinedFieldElements":{"description":"Define the predefined fields which will be added and filled by the system.","type":"object","properties":{"TextFields":{"description":"The predefined text fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendPredefinedText"}},"EmailFields":{"description":"The recipient's email fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendEmail"}},"InitialsFields":{"description":"The recipient's initials fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendInitials"}},"GivenNameFields":{"description":"The recipient's given name fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendGivenName"}},"SurnameFields":{"description":"The recipient's surname fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendSurname"}},"FullNameFields":{"description":"The recipient's full name fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendFullName"}},"DateFields":{"description":"The current date fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendDate"}}}},"EnvelopeSendLinkConfiguration":{"description":"The configuration of the link elements.","type":"object","properties":{"HyperLinks":{"description":"The list of hyperlink elements.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendHyperLink"}}}},"EnvelopeSendClientFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RedirectUri":{"description":"The redirect uri.","maxLength":8000,"minLength":0,"type":"string"}}},"EnvelopeSendAppFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RemoveDocumentFromRecentDocumentList":{"description":"If true, the document will be removed from the recent document list.","type":"boolean"},"CallClientActionOnlyAfterSuccessfulSync":{"description":"If true, the client action will be called only after a successful sync.","type":"boolean"},"CloseApp":{"description":"If true, the app will be closed.","type":"boolean"},"RedirectUri":{"description":"The redirect uri.","maxLength":8000,"minLength":0,"type":"string"}}},"EnvelopeSendKioskFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RedirectUri":{"description":"The redirect uri.","maxLength":8000,"minLength":0,"type":"string"}}},"EnvelopeSendRemoteCertificateSignatureData":{"description":"The recipient configuration for signing with a remote certificate.","type":"object","properties":{"UserId":{"description":"The identifier of the user.","maxLength":500,"minLength":0,"type":"string"},"DeviceId":{"description":"The identifier of the device.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeSendSwissComOnDemandSignatureData":{"description":"The recipient configuration for signing with a Swisscom On-Demand certificate.","type":"object","properties":{"PhoneNumber":{"description":"The phone number.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"},"CommonName":{"description":"The name of the certificate that is created or checked.","maxLength":500,"minLength":0,"type":"string"},"Country":{"description":"The country.","maxLength":500,"minLength":0,"type":"string"},"Locality":{"description":"The locality.","maxLength":500,"minLength":0,"type":"string"},"OrganizationUnits":{"description":"The organizational units.","maxItems":228,"type":"array","items":{"maxLength":500,"type":"string"}},"Organization":{"description":"The organization.","maxLength":500,"minLength":0,"type":"string"},"SerialNumber":{"description":"The serial number.","maxLength":500,"minLength":0,"type":"string"},"StateOrProvince":{"description":"The state or province.","maxLength":500,"minLength":0,"type":"string"},"Pseudonym":{"description":"A name or key that uniquely identifies the user.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeSendSmsOneTimePasswordSignatureData":{"description":"The recipient configuration for signing with a one time password sent via SMS.","type":"object","properties":{"PhoneNumber":{"description":"The phone number to which the one time password will be sent.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"}}},"EnvelopeSendATrustCertificateSignatureData":{"description":"The recipient configuration for signing with an A-Trust certificate.","type":"object","properties":{"PhoneNumber":{"description":"The phone number of the recipient.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"}}},"EnvelopeSendSwedishBankIdSignatureData":{"description":"The recipient configuration for signing with Swedish BankID.","type":"object","properties":{"PersonalNumber":{"description":"The personal number for signing.","maxLength":500,"minLength":0,"type":"string"},"AllowAnyPersonalNumber":{"description":"If true, the personal number can be edited by the recipient.\r\nIf the personal number is empty and can be edited, a QR code for scanning is provided.","type":"boolean"}}},"EnvelopeSendSignaturePluginSignatureData":{"description":"The recipient configuration for signing with a signature plugin.","type":"object","properties":{"PluginId":{"description":"The identifier of the signature plugin.","maxLength":500,"minLength":0,"type":"string"},"Fields":{"description":"The plugin parameters referred to as the GSP sender data fields.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendSignaturePluginParameter"}}}},"EnvelopeSendAccessCodeAuthentication":{"description":"The configuration for authentication with a predefined access code.","required":["Code"],"type":"object","properties":{"Code":{"description":"The code for authenticating the recipient.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeSendSmsOneTimePasswordAuthentication":{"description":"The configuration for authentication with a one time password sent over SMS.","type":"object","properties":{"PhoneNumber":{"description":"The phone number to which the one time password will be sent.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"}}},"EnvelopeSendSwedishBankIdAuthentication":{"description":"The configuration for Swedish BankID authentication.","type":"object","properties":{"PersonalNumber":{"description":"The personal number for the authentication.","maxLength":500,"minLength":0,"type":"string"},"AllowAnyPersonalNumber":{"description":"If true, the personal number can be edited by the recipient.\r\nIf the personal number is empty and can be edited, a QR code for scanning is provided.","type":"boolean"}}},"EnvelopeSendOAuthAuthentication":{"description":"The configuration for authentication with an OAuth provider.","required":["ProviderName"],"type":"object","properties":{"ProviderName":{"description":"The name of the OAuth provider.","maxLength":500,"minLength":0,"type":"string"},"Validations":{"description":"The validation rules for the OAuth response.","maxItems":100,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendAuthenticationValidation"}}}},"EnvelopeSendSamlAuthentication":{"description":"The configuration for authentication with a SAML provider.","required":["ProviderName"],"type":"object","properties":{"ProviderName":{"description":"The name of the SAML provider.","maxLength":500,"minLength":0,"type":"string"},"Validations":{"description":"The validation rules for the SAML response.","maxItems":100,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendAuthenticationValidation"}}}},"EnvelopeSendAllowedSignatureTypes":{"description":"The definition of the allowed signature types for the signature.","type":"object","properties":{"ClickToSign":{"$ref":"#/definitions/EnvelopeSendClickToSignSignatureType","description":"Allow signing with \"click to sign\"."},"DrawToSign":{"$ref":"#/definitions/EnvelopeSendDrawToSignSignatureType","description":"Allow signing with \"draw to sign\"."},"TypeToSign":{"$ref":"#/definitions/EnvelopeSendTypeToSignSignatureType","description":"Allow signing with \"type to sign\"."},"LocalCertificate":{"$ref":"#/definitions/EnvelopeSendLocalCertificateSignatureType","description":"Allow signing with a local certificate."},"DisposableCertificate":{"$ref":"#/definitions/EnvelopeSendDisposableCertificateSignatureType","description":"Allow signing with a disposable certificate."},"SwissComOnDemand":{"$ref":"#/definitions/EnvelopeSendSwissComOnDemandSignatureType","description":"Allow signing with a Swisscom On-Demand certificate."},"ATrustCertificate":{"$ref":"#/definitions/EnvelopeSendATrustCertificateSignatureType","description":"Allow signing with an A-Trust certificate."},"Biometric":{"$ref":"#/definitions/EnvelopeSendBiometricSignatureType","description":"Allow signing with a biometric signature."},"RemoteCertificate":{"$ref":"#/definitions/EnvelopeSendRemoteCertificateSignatureType","description":"Allow signing with a remote certificate."},"OneTimePassword":{"$ref":"#/definitions/EnvelopeSendOneTimePasswordSignatureType","description":"Allow signing with a one time password (SMS-OTP)."},"SwedishBankId":{"$ref":"#/definitions/EnvelopeSendSwedishBankIdSignatureType","description":"Allow signing with Swedish BankID."},"SignaturePlugins":{"description":"Allow signing with signature plugins.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendSignaturePluginSignatureType"}}}},"EnvelopeSendSignatureTaskConfiguration":{"description":"The configuration of the signature task.","type":"object","properties":{"StampImprintDateConfiguration":{"$ref":"#/definitions/EnvelopeSendStampImprintDateConfiguration","description":"The configuration of the stamp imprint date."},"BatchGroup":{"description":"The batch group.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeSendAttachmentDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/EnvelopeSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeSendSize","description":"The size of the element."}}},"EnvelopeSendPredefinedText":{"description":"The configuration of the element showing the predefined text.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Value":{"description":"The value of the predefined text.","maxLength":1000,"minLength":0,"type":"string"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeSendPredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeSendEmail":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeSendPredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeSendGivenName":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeSendPredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeSendSurname":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeSendPredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeSendFullName":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeSendPredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeSendDate":{"description":"The configuration of the predefined element showing the date.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DateFormat":{"description":"The format of the date.","maxLength":50,"minLength":0,"type":"string"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeSendPredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeSendHyperLink":{"description":"The definition of the hyperlink element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Uri":{"description":"The URI of the hyperlink.","maxLength":8000,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeSendLinkDefinition","description":"The definition of the hyperlink element.\r\nIt must be specified when the hyperlink element is added.\r\nIt must not be specified when the hyperlink element already exists."}}},"EnvelopeSendReadingAreaDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/EnvelopeSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeSendSize","description":"The size of the element."}}},"EnvelopeSendSignaturePluginParameter":{"description":"The definition of a signature plugin parameter.","type":"object","properties":{"Key":{"description":"The identifier of the parameter.","maxLength":500,"minLength":0,"type":"string"},"Value":{"description":"The value of the parameter.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeSendAuthenticationValidation":{"description":"A validation rule for an authentication response.","type":"object","properties":{"FieldReferenceId":{"description":"The identifier of the field.","maxLength":500,"minLength":0,"type":"string"},"ExpectedValue":{"description":"The expected value of the field.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeSendPredefinedElementDefinition":{"description":"The configuration of the predefined element.","required":["Position","Size"],"type":"object","properties":{"TextFormat":{"$ref":"#/definitions/EnvelopeSendTextFormat","description":"The configuration of the text format."},"Position":{"$ref":"#/definitions/EnvelopeSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeSendSize","description":"The size of the element."}}},"EnvelopeSendLinkDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/EnvelopeSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeSendSize","description":"The size of the element."}}},"EnvelopeSendPluginStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeSendSwedishBankIdStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayTransactionId":{"description":"If true, the transaction identifier is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeSendOneTimePasswordStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayTransactionId":{"description":"If true, the transaction identifier is displayed.","type":"boolean"},"DisplayTransactionToken":{"description":"If true, the transaction token is displayed.","type":"boolean"},"DisplayPhoneNumber":{"description":"If true, the phone number of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeSendRemoteCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeSendSwissComOnDemandStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeSendDisposableCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeSendLocalCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeSendTypeToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeSendDrawToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeSendClickToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeSendStampImprintDateConfiguration":{"description":"The configuration of the stamp imprint date.","type":"object","properties":{"UseLocalTimezone":{"description":"If true, the local timezone is used.","type":"boolean"},"DateTimeFormat":{"description":"The format of the timestamp.","maxLength":50,"minLength":0,"type":"string"}}},"EnvelopeSendSignaturePluginSignatureType":{"description":"The configuration of the signature plugin.","type":"object","properties":{"PluginId":{"description":"The identifier of the plugin.","maxLength":500,"minLength":0,"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeSendPluginStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeSendSwedishBankIdSignatureType":{"description":"The configuration of the signature.","type":"object","properties":{"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeSendSwedishBankIdStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeSendOneTimePasswordSignatureType":{"description":"The configuration of the OneTimePassword signature.","type":"object","properties":{"ValidityInSeconds":{"description":"The validity of the password in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeSendOneTimePasswordStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeSendRemoteCertificateSignatureType":{"description":"The configuration of the RemoteCertificate signature.","type":"object","properties":{"ValidityInSeconds":{"description":"The validity of the certificate in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeSendRemoteCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeSendBiometricSignatureType":{"description":"The configuration of the Biometric signature.","type":"object","properties":{"BiometricVerification":{"description":"If true, a biometric verification is performed.","type":"boolean"},"AllowBiometricStoringOnly":{"description":"If true, the biometric signature might be stored without verification.","type":"boolean"},"StoreSignedResponseWithoutBioData":{"description":"If true, the signed response is stored without biometric data.","type":"boolean"},"BiometricServerUserId":{"description":"The identifier of the user on the biometric server.","maxLength":50,"minLength":0,"type":"string"},"SignaturePositioning":{"description":"The allowed positioning of the biometric signature.","enum":["WithinField","OnPage","IntersectsWithField"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"}}},"EnvelopeSendATrustCertificateSignatureType":{"description":"The configuration of the A-Trust certificate signature.","type":"object","properties":{"TemplateId":{"description":"The identifier of the A-Trust template.","maxLength":500,"minLength":0,"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"}}},"EnvelopeSendSwissComOnDemandSignatureType":{"description":"The configuration of the Swisscom On-Demand signature.","type":"object","properties":{"ValidityInSeconds":{"description":"The validity of the certificate in seconds.","type":"integer"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeSendSwissComOnDemandStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeSendDisposableCertificateSignatureType":{"description":"The configuration of the DisposableCertificate signature.","type":"object","properties":{"IsLongLived":{"description":"If true, the disposable certificate is long lived.","type":"boolean"},"ValidityInSeconds":{"description":"The validity of the certificate in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeSendDisposableCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeSendLocalCertificateSignatureType":{"description":"The configuration of the LocalCertificate signature.","type":"object","properties":{"EnforcePreferredHashAlgorithm":{"description":"If true, the usage of the preferred hash algorithm is enforced.","type":"boolean"},"PreferredHashAlgorithm":{"description":"The preferred hash algorithm.","enum":["Sha256","Sha512"],"type":"string"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeSendLocalCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeSendTypeToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeSendTypeToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeSendDrawToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeSendDrawToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeSendClickToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeSendClickToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeSendInitials":{"description":"The configuration of the predefined element showing the initials.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"IncludeMiddleNameInitials":{"description":"If true, the initials from the middle names are included as well. \r\nThe initials are read from the given name. Additional names are expected to be separated by a space.","type":"boolean"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeSendPredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeSendDisposableCertificateSignatureData":{"description":"The recipient configuration for signing with a disposable certificate.","type":"object","properties":{"DocumentIssuingCountry":{"description":"The issuing country of the document.\r\nWill be used as country of residence, if lean is disabled.","maxLength":500,"minLength":0,"type":"string"},"IdentificationIssuingCountry":{"description":"The issuing country of the identification.","maxLength":500,"minLength":0,"type":"string"},"IdentificationType":{"description":"The type of identification in use.","enum":["None","ForeignTaxCode","PersonalNumber","Passport","NationalIdentityCard","ItalianTaxCode","NoSerialNumber","DrivingLicense","ResidencePermit","TemporaryResidencePermit","EmbassyDocument","AML"],"type":"string","x-ms-enum":{"name":"DisposableCertificateIdentificationType","modelAsString":false}},"PhoneNumber":{"description":"The phone number registered for identification.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"},"DocumentType":{"description":"The type of document used for the identification.","enum":["IdentityCard","DriverLicense","Passport","ResidencePermit","NationalElectronicIdentityCard","TemporaryResidencePermit","EmbassyDocument"],"type":"string"},"DocumentIssuedBy":{"description":"The authority that issued the document.","maxLength":500,"minLength":0,"type":"string"},"DocumentIssuedOn":{"format":"date","description":"The date when the document has been issued.\r\nA date in the format RFC 3339, section 5.6, 'full-date' (e.g. 2017-07-21).","maxLength":10,"minLength":10,"type":"string"},"DocumentExpiryDate":{"format":"date","description":"The expiration date of the document.\r\nA date in the format RFC 3339, section 5.6, 'full-date' (e.g. 2017-07-21).","maxLength":10,"minLength":10,"type":"string"},"SerialNumber":{"description":"The serial number of the certificate.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"description":"The identifier of the document.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeSendReadDocumentConfirmation":{"description":"The document which has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"}}},"EnvelopeSendReadPagesConfirmation":{"description":"The page which has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"PageNumber":{"format":"int32","description":"The number of the page that needs to be read. Starting with 1.","type":"integer"},"GuidingOrder":{"description":"The order of the element.","type":"integer"}}},"EnvelopeSendReadAreaConfirmation":{"description":"The area that has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"Definition":{"$ref":"#/definitions/EnvelopeSendReadingAreaDefinition","description":"The definition of the area.\r\nWhen adding a new element, it has to be specified .\r\nWhen the field already exists, it must not be specified."}}},"EnvelopeSendAttachment":{"description":"The configuration of the attachment element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"DisplayIconType":{"description":"The type of the displayed icon. If no icon is provided Paperclip will be used.","enum":["Paperclip","Graph","PushPin","Tag"],"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeSendAttachmentDefinition","description":"The definition of the attachment element.\r\nIt must be specified when the attachment element is added.\r\nIt must not be specified when the attachment element already exists."}}},"EnvelopeSendSignatureField":{"description":"The configuration of the signature field.","required":["ElementId","AllowedSignatureTypes"],"type":"object","properties":{"ElementId":{"description":"The identifier of the signature.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"FieldDescription":{"description":"The description of the signature.","maxLength":500,"minLength":0,"type":"string"},"UseExternalTimestampServer":{"description":"If true, a timestamp from an external server is embedded into the signature.","type":"boolean"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"AllowedSignatureTypes":{"$ref":"#/definitions/EnvelopeSendAllowedSignatureTypes","description":"The allowed types for the signature."},"FieldDefinition":{"$ref":"#/definitions/EnvelopeSendSignatureFieldDefinition","description":"The definition of the signature field.\r\nIt must be specified when the signature field is added.\r\nIt must not be specified when the signature field already exists."},"TaskConfiguration":{"$ref":"#/definitions/EnvelopeSendSignatureTaskConfiguration","description":"The configuration of the task."}}},"EnvelopeSendEmailAppLinks":{"description":"Configure if links for our apps should be included in the recipient document signing request email message.","type":"object","properties":{"Android":{"description":"If true, an Android app link is added to the email message.","type":"boolean"},"iOS":{"description":"If true, an iOS app link is added to the email message.","type":"boolean"},"Windows":{"description":"If true, a Windows app link is added to the email message.","type":"boolean"}}},"EnvelopeSendContactInformation":{"description":"Define the contact information for the recipient.","required":["Email","GivenName","Surname"],"type":"object","properties":{"Email":{"description":"The email address of the recipient.","maxLength":250,"minLength":0,"pattern":"^[a-zA-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF0-9.!#$%&'*+\\-\\/=?^_`{|}~]+@(?=[a-z0-9A-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF])(?:[a-z0-9A-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF]|(?<![.-])\\.|(?<!\\.)-)*[a-z0-9A-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF]$","type":"string"},"GivenName":{"description":"The given name of the recipient.","maxLength":200,"minLength":0,"type":"string"},"Surname":{"description":"The surname of the recipient.","maxLength":200,"minLength":0,"type":"string"},"PhoneNumber":{"description":"The phone number of the recipient.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"},"LanguageCode":{"description":"The language of the recipient.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string"}}},"EnvelopeSendGeneralPoliciesForP7MAction":{"description":"Define the general policies allowed for P7M action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"},"AllowAdhocPdfAttachments":{"description":"If true, the client is allowed to append adhoc documents.","type":"boolean"},"AllowRejectWorkstep":{"description":"If true, the client is allowed to reject the workstep.","type":"boolean"},"AllowUndoLastAction":{"description":"If true, the client is allowed to undo actions.","type":"boolean"},"AllowDownloadOfSignedP7MFiles":{"description":"If true, the client is allowed to download signed p7m files.","type":"boolean"}}},"EnvelopeSendP7MSignatureMethods":{"description":"The recipient configuration for signing with P7M.","type":"object","properties":{"LocalCertificate":{"description":"If true, a local certificate can be used.","type":"boolean"},"DisposableCertificate":{"$ref":"#/definitions/EnvelopeSendDisposableCertificateSignatureData","description":"The disposable certificate configuration for the action."},"RemoteCertificate":{"$ref":"#/definitions/EnvelopeSendRemoteCertificateSignatureData","description":"The remote certificate configuration for the action."},"SignaturePluginData":{"description":"The signature plugin configurations for the action.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendSignaturePluginSignatureData"}}}},"EnvelopeSendGeneralPoliciesForViewAction":{"description":"Define the general policies allowed for view action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"}}},"EnvelopeSendRecipientConfiguration":{"description":"The configuration of the recipient.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/EnvelopeSendContactInformation","description":"The contact information of the recipient."},"PersonalMessage":{"description":"The personal message for the recipient.","maxLength":204800,"minLength":0,"type":"string"},"AuthenticationConfiguration":{"$ref":"#/definitions/EnvelopeSendAuthenticationConfiguration","description":"The configuration for the authentication of the recipient."},"SendEmails":{"description":"If true, emails will be sent out for this recipient.","type":"boolean"},"AllowAccessAfterFinish":{"description":"If true, the recipient is allowed to access the action after it has been finished.\r\nIt is required that the organization has the AllowAccessFinishedWorkstep feature enabled.\r\nThe default value is taken from the OrganizationSettings.","type":"boolean"}}},"EnvelopeSendGeneralPoliciesForSignAction":{"description":"Define the general policies allowed for sign action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"},"AllowAdhocPdfAttachments":{"description":"If true, the client is allowed to append adhoc documents.","type":"boolean"},"AllowRejectWorkstep":{"description":"If true, the client is allowed to reject the workstep.","type":"boolean"},"AllowUndoLastAction":{"description":"If true, the client is allowed to undo actions.","type":"boolean"}}},"EnvelopeSendAdvancedRecipientConfiguration":{"description":"The advanced configuration for the recipient.","required":["ContactInformation"],"type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/EnvelopeSendContactInformation","description":"The contact information of the recipient."},"PersonalMessage":{"description":"The personal message for the recipient.","maxLength":204800,"minLength":0,"type":"string"},"AuthenticationConfiguration":{"$ref":"#/definitions/EnvelopeSendAuthenticationConfiguration","description":"The configuration for the authentication of the recipient."},"SendEmails":{"description":"If true, emails will be sent out for this recipient.","type":"boolean"},"AllowAccessAfterFinish":{"description":"If true, the recipient is allowed to access the action after it has been finished.\r\nIt is required that the organization has the AllowAccessFinishedWorkstep feature enabled.\r\nThe default value is taken from the OrganizationSettings.","type":"boolean"},"IncludedEmailAppLinks":{"$ref":"#/definitions/EnvelopeSendEmailAppLinks","description":"The configuration for mobile app links in email messages."},"AllowDelegation":{"description":"If true, the recipient may delegate this activity to another person.","type":"boolean"},"RequireViewContentBeforeFormFilling":{"description":"If true, the signer has to confirm the reading of all documents as first task.","type":"boolean"}}},"EnvelopeSendVisibleSignature":{"description":"A signature with a visual appearance on the document.","required":["DocumentNumber","FieldDefinition"],"type":"object","properties":{"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"UseExternalTimestampServer":{"description":"If true, a timestamp from an external server is embedded into the signature.","type":"boolean"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeSendSignatureFieldDefinition","description":"The definition of the signature field.\r\nIt must be specified when the signature field is added.\r\nIt must not be specified when the signature field already exists."}}},"EnvelopeSendRadioButtonItemDefinition":{"description":"The configuration of the radio button.","required":["Position","Size"],"type":"object","properties":{"ExportValue":{"description":"The value of the element when the radio button is checked.","maxLength":500,"minLength":0,"type":"string"},"IsChecked":{"description":"If true, the radio button is checked by default.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/EnvelopeSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeSendSize","description":"The size of the element."}}},"EnvelopeSendTextFormat":{"description":"The configuration of the text format.","type":"object","properties":{"TextColor":{"description":"The color of the text. The default color is black.\r\nSix digit hexadecimal color that starts with # in #RRGGBB format according to CSS Color Module Level 4, paragraph 5.2.","maxLength":7,"minLength":7,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"number"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"Bold":{"description":"If true, the bold font is used.","type":"boolean"},"Italic":{"description":"If true, the italic font is used.","type":"boolean"},"TextAlign":{"description":"The alignment of the text. The default alignment is left.","enum":["Left","Center","Right"],"type":"string"}}},"EnvelopeSendPhoneValidationConfiguration":{"description":"The validation rules for phone numbers.","type":"object","properties":{"Type":{"description":"The format of the phone numbers.","enum":["International","InternationalLeadingZeros","InternationalLeadingPlus"],"type":"string"}}},"EnvelopeSendNumberValidationConfiguration":{"description":"The validation rules for numbers.","type":"object","properties":{"DecimalDigits":{"description":"The expected amount of decimal digits.","type":"integer"},"Symbol":{"description":"The expected symbol.","maxLength":5,"minLength":0,"type":"string"},"SymbolLocation":{"description":"The defined symbol location.","enum":["Start","StartWithBlank","End","EndWithBlank"],"type":"string"},"GroupSeparator":{"description":"The expected thousands separator.","enum":["Comma","Point","Apostrophe","Blank","None"],"type":"string"},"DecimalSeparator":{"description":"The expected decimal separator.","enum":["Comma","Point","Apostrophe","None"],"type":"string","x-ms-enum":{"name":"DecimalSeparatorType","modelAsString":false}},"Range":{"$ref":"#/definitions/EnvelopeSendFieldValidationRange","description":"The range of the values."}}},"EnvelopeSendActionCallbackSelection":{"description":"The selection of events which trigger the callback.","type":"object","properties":{"ConfirmTransactionCode":{"description":"If true, the callback is triggered when a transaction code was sent. This is only used for legacy disposable certificates, after user accepted issuance of disposable certificate.","type":"boolean"},"AgreementAccepted":{"description":"If true, the callback is triggered when the user accepted the agreement.","type":"boolean"},"AgreementRejected":{"description":"If true, the callback is triggered when the user rejected the agreement.","type":"boolean"},"PrepareAuthenticationSuccess":{"description":"If true, the callback is triggered when the preparation of the authentication process succeeded.","type":"boolean"},"AuthenticationFailed":{"description":"If true, the callback is triggered when the user failed to authenticate.","type":"boolean"},"AuthenticationSuccess":{"description":"If true, the callback is triggered when the user succeeded to authenticate.","type":"boolean"},"AuditTrailRequested":{"description":"If true, the callback is triggered when the audit trail was requested.","type":"boolean"},"AuditTrailXmlRequested":{"description":"If true, the callback is triggered when the audit trail XML was requested.","type":"boolean"},"CalledPage":{"description":"If true, the callback is triggered when the SignAnyWhere Viewer was requested.","type":"boolean"},"DocumentDownloaded":{"description":"If true, the callback is triggered when the document download was requested.","type":"boolean"},"FlattenedDocumentDownloaded":{"description":"If true, the callback is triggered when the flattened document download was requested.","type":"boolean"},"AddedAnnotation":{"description":"If true, the callback is triggered when an annotation was added.","type":"boolean"},"AddedAttachment":{"description":"If true, the callback is triggered when an attachment was added.","type":"boolean"},"AppendedDocument":{"description":"If true, the callback is triggered when a document was appended.","type":"boolean"},"FormsFilled":{"description":"If true, the callback is triggered when a form field was filled.","type":"boolean"},"ConfirmReading":{"description":"If true, the callback is triggered when a reading task was completed.","type":"boolean"},"SendTransactionCode":{"description":"If true, the callback is triggered when a transaction code for a signature with type TransactionCode was sent using the TransactionCodeSenderPlugin.","type":"boolean"},"PrepareSignWorkstepDocument":{"description":"If true, the callback is triggered when a signature was prepared for signing.","type":"boolean"},"SignWorkstepDocument":{"description":"If true, the callback is triggered when a signature was applied.","type":"boolean"},"UndoAction":{"description":"If true, the callback is triggered when an action was undone.","type":"boolean"},"WorkstepCreated":{"description":"If true, the callback is triggered when a workstep was created.","type":"boolean"},"WorkstepFinished":{"description":"If true, the callback is triggered when a workstep was finished.","type":"boolean"},"WorkstepRejected":{"description":"If true, the callback is triggered when a workstep was rejected.","type":"boolean"},"DisablePolicyAndValidityChecks":{"description":"If true, the callback is triggered when policy and validity checks were disabled.","type":"boolean"},"EnablePolicyAndValidityChecks":{"description":"If true, the callback is triggered when policy and validity checks were enabled.","type":"boolean"},"AppendFileToWorkstep":{"description":"If true, the callback is triggered when a file was appended to the workstep.","type":"boolean"},"AppendTasksToWorkstep":{"description":"If true, the callback is triggered when a task was added to the workstep.","type":"boolean"},"SetOptionalDocumentState":{"description":"If true, the callback is triggered when an optional document became either active or inactive.","type":"boolean"},"PreparePayloadForBatch":{"description":"If true, the callback is triggered when the payload was prepared for batch signing.","type":"boolean"}}},"EnvelopeSendSign":{"description":"A sign action for the recipient.","required":["RecipientConfiguration"],"type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/EnvelopeSendAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"SequenceMode":{"description":"The sequence mode.","enum":["NoSequenceEnforced","SequenceEnforced"],"type":"string"},"Elements":{"$ref":"#/definitions/EnvelopeSendElements","description":"The elements in the document (e.g. form fields) assigned to the recipient."},"FinishActionConfiguration":{"$ref":"#/definitions/EnvelopeSendFinishAction","description":"Defines what happens in the signing clients, after an action has been finished."},"SignatureDataConfiguration":{"$ref":"#/definitions/EnvelopeSendSignatureDataConfiguration","description":"The configuration of recipient data for special signatures."},"BatchConfiguration":{"$ref":"#/definitions/EnvelopeSendBatchConfiguration","description":"The configuration of a signing batch."},"SigningGroup":{"description":"The group for defining parallel sign actions.","maxLength":500,"minLength":0,"type":"string"},"GeneralPoliciesOverrides":{"$ref":"#/definitions/EnvelopeSendGeneralPoliciesForSignAction","description":"Viewer policy settings for override."}}},"EnvelopeSendSignAutomatic":{"description":"An automatic signing action.","required":["ProfileId"],"type":"object","properties":{"ProfileId":{"description":"The identifier of the profile for the automatic signatures.","maxLength":500,"minLength":0,"type":"string"},"RenderingLanguageCode":{"description":"The rendering language for the automatic signatures.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string"},"VisibleSignatures":{"description":"The visible signatures define the optional visual representations for automatic signatures.\r\nIf none are defined, the automatic signatures are applied to the documents without a visual element.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendVisibleSignature"}}}},"EnvelopeSendListBoxDefinition":{"description":"The configuration of the combo box.","required":["Items","Position","Size"],"type":"object","properties":{"TextFormat":{"$ref":"#/definitions/EnvelopeSendTextFormat","description":"The configuration of the text format."},"Items":{"description":"A list of items that can be selected for the element.","maxItems":50,"minItems":1,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendChoiceItem"}},"IsMultiSelect":{"description":"If true, multiple values of the list box can be selected.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/EnvelopeSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeSendSize","description":"The size of the element."}}},"EnvelopeSendRadioButtonGroupDefinition":{"description":"The configuration of the radio button group definition.","type":"object","properties":{"IsSelectUnison":{"description":"If true, radiobuttons with the same <code>ExportValue<\/code> are checked and unchecked together.","type":"boolean"},"Items":{"description":"The list of radio buttons that belong to the same group.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendRadioButtonItemDefinition"}}}},"EnvelopeSendComboBoxDefinition":{"description":"The configuration of the combo box.","required":["Items","Position","Size"],"type":"object","properties":{"TextFormat":{"$ref":"#/definitions/EnvelopeSendTextFormat","description":"The configuration of the text format."},"Items":{"description":"A list of items that can be selected for the element.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendChoiceItem"}},"IsEditable":{"description":"If true, the combo box is editable.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/EnvelopeSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeSendSize","description":"The size of the element."}}},"EnvelopeSendCheckBoxDefinition":{"description":"The configuration of a check box.","required":["Position","Size"],"type":"object","properties":{"ExportValue":{"description":"The value of the check box when it is checked.","maxLength":500,"minLength":0,"type":"string"},"Position":{"$ref":"#/definitions/EnvelopeSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeSendSize","description":"The size of the element."},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"}}},"EnvelopeSendTextBoxDefinition":{"description":"The configuration of the text box.","required":["Position","Size"],"type":"object","properties":{"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"MaxLength":{"description":"The maximum length of the text.","type":"integer"},"IsMultiline":{"description":"If true, the text box can have multiple lines.","type":"boolean"},"IsPassword":{"description":"If true, the text box behaves like a password input field and does not show the actually entered characters.","type":"boolean"},"TextFormat":{"$ref":"#/definitions/EnvelopeSendTextFormat","description":"The configuration of the text format."},"Position":{"$ref":"#/definitions/EnvelopeSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeSendSize","description":"The size of the element."}}},"EnvelopeSendListBox":{"description":"The configuration of the list box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"PreSelectedItems":{"description":"The export values of the items which should be initially selected.","maxItems":50,"type":"array","items":{"maxLength":500,"type":"string"}},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeSendListBoxDefinition","description":"The definition of the list box field.\r\nIt must be specified when the list box is added.\r\nIt must not be specified when the list box already exists."}}},"EnvelopeSendRadioButtonGroup":{"description":"The configuration of the radio button group.","type":"object","properties":{"GroupName":{"description":"The name of the radio button group.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"SelectedItem":{"description":"The export value of the selected item of the radio button group.","maxLength":500,"minLength":0,"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeSendRadioButtonGroupDefinition","description":"The definition of the radio button group.\r\nIt must be specified when the radio button group is added.\r\nIt must not be specified when the radio button group already exists."}}},"EnvelopeSendComboBox":{"description":"The configuration of the combo box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"Value":{"description":"The selected value of the combo box.","maxLength":500,"minLength":0,"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeSendComboBoxDefinition","description":"The definition of the combo box.\r\nIt must be specified when the combo box is added.\r\nIt must not be specified when the combo box already exists."}}},"EnvelopeSendCheckBox":{"description":"The configuration of the check box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"IsChecked":{"description":"If true, the check box is checked.","type":"boolean"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeSendCheckBoxDefinition","description":"The definition of the check box.\r\nIt must be specified when the check box is added.\r\nIt must not be specified when the check box already exists."}}},"EnvelopeSendTextBox":{"description":"The configuration of the text box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"Value":{"description":"The value of the text box.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"Validation":{"$ref":"#/definitions/EnvelopeSendFieldValidation","description":"The configuration of the validation rules for the text box value."},"FieldDefinition":{"$ref":"#/definitions/EnvelopeSendTextBoxDefinition","description":"The definition of the text box.\r\nIt must be specified when the check box is added.\r\nIt must not be specified when the check box already exists."}}},"EnvelopeSendCallbackConfiguration":{"description":"The configuration of the callbacks for a custom integration.","type":"object","properties":{"CallbackUrl":{"description":"The callback URL triggered when the envelope has been finished.","maxLength":8000,"minLength":0,"type":"string"},"StatusUpdateCallbackUrl":{"description":"The callback URL triggered for status updates of an envelope.","maxLength":8000,"minLength":0,"type":"string"},"ActivityActionCallbackConfiguration":{"$ref":"#/definitions/EnvelopeSendActivityActionCallbackConfiguration","description":"The configuration of the callback for workstep events."}}},"EnvelopeSendExpirationConfiguration":{"description":"The configuration of the expiration for the envelope.","type":"object","properties":{"ExpirationInSecondsAfterSending":{"description":"The relative expiration in seconds after sending the envelope.\r\nMust be a positive number between 600 and the maximum envelope validity located in the system configuration [Configuration key: maxEnvelopeValidityInDays, Default: 2419200 seconds (28 days)].\r\nMust not be defined when property <code>ExpirationDate<\/code> is specified.","type":"integer"},"ExpirationDate":{"format":"date-time","description":"The absolute expiration date of the envelope.\r\nMust not be in the past.\r\nMust not be defined when property <code>ExpirationInSecondsAfterSending<\/code> is specified.\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","maxLength":30,"minLength":20,"type":"string"}}},"EnvelopeSendReminderConfiguration":{"description":"The configuration for reminders.","type":"object","properties":{"Enabled":{"description":"If true, reminders are sent.","type":"boolean"},"FirstReminderInDays":{"description":"The amount of days until a reminder is sent to a signer or a viewer after the initial notification.","type":"integer"},"ReminderResendIntervalInDays":{"description":"The amount of days until a reminder is sent again to a signer or a viewer.","type":"integer"},"BeforeExpirationInDays":{"description":"The amount of days before the envelope expires and a reminder should be sent.","type":"integer"}}},"EnvelopeSendRequest":{"description":"The request model for sending an envelope.","required":["Documents","Name","Activities"],"type":"object","properties":{"Documents":{"description":"The documents for the envelope.","maxItems":50,"minItems":1,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendDocument"}},"Name":{"description":"The name of the envelope.","maxLength":100,"minLength":0,"type":"string"},"MetaData":{"description":"The metadata of the envelope.","maxLength":204800,"minLength":0,"type":"string"},"AddDocumentTimestamp":{"description":"If true, a timestamp is added to all documents of the envelope at the end of each signing activity.","type":"boolean"},"ShareWithTeam":{"description":"If true, this envelope is shared with your teams.","type":"boolean"},"LockFormFieldsOnFinish":{"description":"If true, form fields are locked after the envelope is finished.","type":"boolean"},"UnassignedElements":{"$ref":"#/definitions/EnvelopeSendUnassignedElements","description":"The elements which are not assigned to any action."},"Activities":{"description":"The steps for the envelope.","maxItems":50,"minItems":1,"type":"array","items":{"$ref":"#/definitions/EnvelopeSendActivity"}},"EmailConfiguration":{"$ref":"#/definitions/EnvelopeSendEmailConfiguration","description":"The configuration for notifications."},"ReminderConfiguration":{"$ref":"#/definitions/EnvelopeSendReminderConfiguration","description":"The configuration for reminders."},"ExpirationConfiguration":{"$ref":"#/definitions/EnvelopeSendExpirationConfiguration","description":"The configuration of the expiration for the envelope."},"CallbackConfiguration":{"$ref":"#/definitions/EnvelopeSendCallbackConfiguration","description":"The configuration of the callbacks for a custom integration."},"AgreementConfiguration":{"$ref":"#/definitions/EnvelopeSendAgreementConfiguration","description":"The configuration of the agreement.\r\nRequires that the organization allows custom agreement settings."},"SealingConfiguration":{"$ref":"#/definitions/EnvelopeSendSealingConfiguration","description":"The custom sealing configuration for the envelope."}}},"EnvelopeCancelRequest":{"description":"The request model for canceling an envelope.","required":["EnvelopeId"],"type":"object","properties":{"EnvelopeId":{"description":"The identifier of the envelope.","maxLength":36,"minLength":36,"type":"string"}}},"EnvelopeDeleteRequest":{"description":"The request model for deleting an envelope.","required":["EnvelopeId"],"type":"object","properties":{"EnvelopeId":{"description":"The identifier of the envelope.","maxLength":36,"minLength":36,"type":"string"}}},"EnvelopeRemindRequest":{"description":"The request model for sending reminder notifications for an active envelope.","required":["EnvelopeId"],"type":"object","properties":{"EnvelopeId":{"description":"The identifier of the envelope.","maxLength":36,"minLength":36,"type":"string"}}},"EnvelopeRemindResponse":{"description":"The response model after sending reminder notifications.","type":"object","properties":{"TotalSentReminders":{"format":"int32","description":"The amount of reminder notifications which were sent out.","type":"integer"},"TotalBlockedByRateLimit":{"format":"int32","description":"The amount of skipped reminder notifications due to rate limit.","type":"integer"},"TotalBlockedByDisabledEmail":{"format":"int32","description":"The amount of skipped reminder notifications due to disabled notification sending for the recipient.","type":"integer"},"TotalBlockedByNotificationSetting":{"format":"int32","description":"The amount of skipped reminder notifications due to disabled notifications by the user.","type":"integer"}}},"EnvelopeUnlockRequest":{"description":"The request model for unlocking an envelope.","required":["EnvelopeId"],"type":"object","properties":{"EnvelopeId":{"description":"The identifier of the envelope.","maxLength":36,"minLength":36,"type":"string"}}},"EnvelopeRestartExpiredRequest":{"description":"The request model for restarting an expired envelope.","required":["EnvelopeId"],"type":"object","properties":{"EnvelopeId":{"description":"The identifier of the envelope.","maxLength":36,"minLength":36,"type":"string"},"ExpirationInSecondsAfterSending":{"description":"The relative expiration in seconds after sending the envelope.\r\nMust be a positive number between 600 and the maximum envelope validity located in the system configuration [Configuration key: maxEnvelopeValidityInDays, Default: 2419200 seconds (28 days)].\r\nMust not be defined when property <code>ExpirationDate<\/code> is specified.","type":"integer"},"ExpirationDate":{"format":"date-time","description":"The absolute expiration date of the envelope.\r\nMust not be in the past.\r\nMust not be defined when property <code>ExpirationInSecondsAfterSending<\/code> is specified.\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","maxLength":30,"minLength":20,"type":"string"}}},"EnvelopeActivityDeleteRequest":{"description":"The request model for deleting an activity.","required":["ActivityId"],"type":"object","properties":{"ActivityId":{"description":"The identifier of the activity.","maxLength":36,"minLength":36,"type":"string"}}},"EnvelopeActivityReplaceRequest":{"description":"Define an activity in the process.","required":["ActivityId"],"type":"object","properties":{"ActivityId":{"description":"The identifier of the activity.","maxLength":36,"minLength":36,"type":"string"},"Action":{"$ref":"#/definitions/EnvelopeActivityReplaceAction","description":"The action assigned to the activity."},"VisibilityOptions":{"description":"The document visibility options for the activity.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceVisibilityOption"}}}},"EnvelopeActivityReplaceAction":{"description":"The action of the activity. Exactly one definition must be used!","type":"object","properties":{"SendCopy":{"$ref":"#/definitions/EnvelopeActivityReplaceSendCopy","description":"The definition of the copy action."},"SignAutomatic":{"$ref":"#/definitions/EnvelopeActivityReplaceSignAutomatic","description":"The definition of the automatic sign action."},"Sign":{"$ref":"#/definitions/EnvelopeActivityReplaceSign","description":"The definition of the sign action."},"View":{"$ref":"#/definitions/EnvelopeActivityReplaceView","description":"The definition of the view action."},"SignAsP7M":{"$ref":"#/definitions/EnvelopeActivityReplaceSignAsP7M","description":"The definition of the P7M sign action."}}},"EnvelopeActivityReplaceVisibilityOption":{"description":"The options defining the document visibility.","type":"object","properties":{"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"IsHidden":{"description":"If true, the referenced document is hidden for the activity.","type":"boolean"}}},"EnvelopeActivityReplaceSendCopy":{"description":"An action to send a copy of the documents to the recipient.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceBasicRecipientConfiguration","description":"The configuration of the recipient."}}},"EnvelopeActivityReplaceView":{"description":"An action to view and acknowledge the documents.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceRecipientConfiguration","description":"The configuration of the recipient."},"GeneralPoliciesOverrides":{"$ref":"#/definitions/EnvelopeActivityReplaceGeneralPoliciesForViewAction","description":"Viewer policy settings for override."}}},"EnvelopeActivityReplaceSignAsP7M":{"description":"An action to sign the documents with P7M.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"SignatureMethods":{"$ref":"#/definitions/EnvelopeActivityReplaceP7MSignatureMethods","description":"The configuration of recipient data for P7M signatures."},"GeneralPoliciesOverrides":{"$ref":"#/definitions/EnvelopeActivityReplaceGeneralPoliciesForP7MAction","description":"Viewer policy settings for override."}}},"EnvelopeActivityReplaceBasicRecipientConfiguration":{"description":"The configuration of the recipient.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/EnvelopeActivityReplaceContactInformation","description":"The contact information of the recipient."},"PersonalMessage":{"description":"The personal message for the recipient.","maxLength":204800,"minLength":0,"type":"string"}}},"EnvelopeActivityReplaceElements":{"description":"The elements of the documents which are assigned to the activity.","type":"object","properties":{"TextBoxes":{"description":"The text boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceTextBox"}},"CheckBoxes":{"description":"The check boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceCheckBox"}},"ComboBoxes":{"description":"The combo boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceComboBox"}},"RadioButtons":{"description":"The radio buttons.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceRadioButtonGroup"}},"ListBoxes":{"description":"The list boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceListBox"}},"Signatures":{"description":"The signatures.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceSignatureField"}},"Attachments":{"description":"The attachments.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceAttachment"}},"PredefinedFieldElements":{"$ref":"#/definitions/EnvelopeActivityReplacePredefinedFieldElements","description":"The predefined field elements."},"LinkConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceLinkConfiguration","description":"The links in the documents."},"AreaReadConfirmations":{"description":"The areas which have to be read.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceReadAreaConfirmation"}},"PageReadConfirmations":{"description":"The pages which have to be read.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceReadPagesConfirmation"}},"DocumentReadConfirmations":{"description":"The documents which have to be read.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceReadDocumentConfirmation"}}}},"EnvelopeActivityReplaceFinishAction":{"description":"Define what happens in the signing clients, after an action has been finished.","type":"object","properties":{"SignAnyWhereViewer":{"$ref":"#/definitions/EnvelopeActivityReplaceClientFinishAction","description":"The actions for the SAW Viewer."},"SignificantClientSignatureCaptureForIos":{"$ref":"#/definitions/EnvelopeActivityReplaceAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for iOS."},"SignificantClientSignatureCaptureForAndroid":{"$ref":"#/definitions/EnvelopeActivityReplaceAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for Android."},"SignificantClientSignatureCaptureForWindows":{"$ref":"#/definitions/EnvelopeActivityReplaceAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for Windows."},"KioskSdk":{"$ref":"#/definitions/EnvelopeActivityReplaceKioskFinishAction","description":"The actions for the SIGNificant Kiosk SDK."}}},"EnvelopeActivityReplaceSignatureDataConfiguration":{"description":"The recipient configuration for signing.","type":"object","properties":{"DisposableCertificate":{"$ref":"#/definitions/EnvelopeActivityReplaceDisposableCertificateSignatureData","description":"The disposable certificate configuration for the action."},"RemoteCertificate":{"$ref":"#/definitions/EnvelopeActivityReplaceRemoteCertificateSignatureData","description":"The remote certificate configuration for the action."},"SwissComOnDemand":{"$ref":"#/definitions/EnvelopeActivityReplaceSwissComOnDemandSignatureData","description":"The Swisscom On-Demand certificate configuration for the action."},"SmsOneTimePassword":{"$ref":"#/definitions/EnvelopeActivityReplaceSmsOneTimePasswordSignatureData","description":"The one time password configuration for the action (SMS-OTP)."},"ATrustCertificate":{"$ref":"#/definitions/EnvelopeActivityReplaceATrustCertificateSignatureData","description":"The A-Trust certificate configuration for the action."},"SwedishBankId":{"$ref":"#/definitions/EnvelopeActivityReplaceSwedishBankIdSignatureData","description":"The Swedish BankID configuration for the action."},"SignaturePluginData":{"description":"The signature plugin configurations for the action.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceSignaturePluginSignatureData"}}}},"EnvelopeActivityReplaceBatchConfiguration":{"description":"The configuration of a signing batch.","type":"object","properties":{"Mode":{"description":"The mode, that will be used for batch signing.","enum":["Basic","OptIn","OptOut","OptOutWithRequiredAlwaysSelected","OptInWithRequiredAlwaysSelected"],"type":"string","x-ms-enum":{"name":"BatchMode","modelAsString":false}},"RequireScrollingOverAllSignaturesBeforeSigning":{"description":"If true, the user has to review all signatures in the batch signing dialog before signing.\r\nThis is only applicable when the <code>Mode<\/code> is set to <code>OptIn<\/code> or <code>OptOut<\/code>.","type":"boolean"}}},"EnvelopeActivityReplaceSignatureFieldDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/EnvelopeActivityReplacePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeActivityReplaceSize","description":"The size of the element."}}},"EnvelopeActivityReplaceAuthenticationConfiguration":{"description":"The definition of the authentications of the recipient.","type":"object","properties":{"AccessCode":{"$ref":"#/definitions/EnvelopeActivityReplaceAccessCodeAuthentication","description":"The configuration of the authentication with an access code."},"SmsOneTimePassword":{"$ref":"#/definitions/EnvelopeActivityReplaceSmsOneTimePasswordAuthentication","description":"The configuration of the authentication with one time password over SMS."},"SwedishBankId":{"$ref":"#/definitions/EnvelopeActivityReplaceSwedishBankIdAuthentication","description":"The configuration of the authentication with Swedish BankID."},"OAuthAuthentications":{"description":"The configurations of the authentication with OAuth.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceOAuthAuthentication"}},"SamlAuthentications":{"description":"The configurations of the authentication with SAML.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceSamlAuthentication"}}}},"EnvelopeActivityReplacePredefinedFieldElements":{"description":"Define the predefined fields which will be added and filled by the system.","type":"object","properties":{"TextFields":{"description":"The predefined text fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplacePredefinedText"}},"EmailFields":{"description":"The recipient's email fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceEmail"}},"InitialsFields":{"description":"The recipient's initials fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceInitials"}},"GivenNameFields":{"description":"The recipient's given name fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceGivenName"}},"SurnameFields":{"description":"The recipient's surname fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceSurname"}},"FullNameFields":{"description":"The recipient's full name fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceFullName"}},"DateFields":{"description":"The current date fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceDate"}}}},"EnvelopeActivityReplaceLinkConfiguration":{"description":"The configuration of the link elements.","type":"object","properties":{"HyperLinks":{"description":"The list of hyperlink elements.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceHyperLink"}}}},"EnvelopeActivityReplaceClientFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RedirectUri":{"description":"The redirect uri.","maxLength":8000,"minLength":0,"type":"string"}}},"EnvelopeActivityReplaceAppFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RemoveDocumentFromRecentDocumentList":{"description":"If true, the document will be removed from the recent document list.","type":"boolean"},"CallClientActionOnlyAfterSuccessfulSync":{"description":"If true, the client action will be called only after a successful sync.","type":"boolean"},"CloseApp":{"description":"If true, the app will be closed.","type":"boolean"},"RedirectUri":{"description":"The redirect uri.","maxLength":8000,"minLength":0,"type":"string"}}},"EnvelopeActivityReplaceKioskFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RedirectUri":{"description":"The redirect uri.","maxLength":8000,"minLength":0,"type":"string"}}},"EnvelopeActivityReplaceRemoteCertificateSignatureData":{"description":"The recipient configuration for signing with a remote certificate.","type":"object","properties":{"UserId":{"description":"The identifier of the user.","maxLength":500,"minLength":0,"type":"string"},"DeviceId":{"description":"The identifier of the device.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeActivityReplaceSwissComOnDemandSignatureData":{"description":"The recipient configuration for signing with a Swisscom On-Demand certificate.","type":"object","properties":{"PhoneNumber":{"description":"The phone number.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"},"CommonName":{"description":"The name of the certificate that is created or checked.","maxLength":500,"minLength":0,"type":"string"},"Country":{"description":"The country.","maxLength":500,"minLength":0,"type":"string"},"Locality":{"description":"The locality.","maxLength":500,"minLength":0,"type":"string"},"OrganizationUnits":{"description":"The organizational units.","maxItems":228,"type":"array","items":{"maxLength":500,"type":"string"}},"Organization":{"description":"The organization.","maxLength":500,"minLength":0,"type":"string"},"SerialNumber":{"description":"The serial number.","maxLength":500,"minLength":0,"type":"string"},"StateOrProvince":{"description":"The state or province.","maxLength":500,"minLength":0,"type":"string"},"Pseudonym":{"description":"A name or key that uniquely identifies the user.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeActivityReplaceSmsOneTimePasswordSignatureData":{"description":"The recipient configuration for signing with a one time password sent via SMS.","type":"object","properties":{"PhoneNumber":{"description":"The phone number to which the one time password will be sent.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"}}},"EnvelopeActivityReplaceATrustCertificateSignatureData":{"description":"The recipient configuration for signing with an A-Trust certificate.","type":"object","properties":{"PhoneNumber":{"description":"The phone number of the recipient.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"}}},"EnvelopeActivityReplaceSwedishBankIdSignatureData":{"description":"The recipient configuration for signing with Swedish BankID.","type":"object","properties":{"PersonalNumber":{"description":"The personal number for signing.","maxLength":500,"minLength":0,"type":"string"},"AllowAnyPersonalNumber":{"description":"If true, the personal number can be edited by the recipient.\r\nIf the personal number is empty and can be edited, a QR code for scanning is provided.","type":"boolean"}}},"EnvelopeActivityReplaceSignaturePluginSignatureData":{"description":"The recipient configuration for signing with a signature plugin.","type":"object","properties":{"PluginId":{"description":"The identifier of the signature plugin.","maxLength":500,"minLength":0,"type":"string"},"Fields":{"description":"The plugin parameters referred to as the GSP sender data fields.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceSignaturePluginParameter"}}}},"EnvelopeActivityReplacePosition":{"description":"The position of an element on the document.","required":["X","Y"],"type":"object","properties":{"PageNumber":{"format":"int32","description":"The number of the page where the element is located. It starts with 1.","type":"integer"},"X":{"format":"double","description":"The X coordinate in points. It starts from the left.","type":"number"},"Y":{"format":"double","description":"The Y coordinate in points. It starts from the bottom.","type":"number"}}},"EnvelopeActivityReplaceSize":{"description":"The definition of the size of an element.","required":["Width","Height"],"type":"object","properties":{"Width":{"format":"double","description":"The width of the element in points.","type":"number"},"Height":{"format":"double","description":"The height of the element in points.","type":"number"}}},"EnvelopeActivityReplaceAccessCodeAuthentication":{"description":"The configuration for authentication with a predefined access code.","type":"object","properties":{"Code":{"description":"The code for authenticating the recipient.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeActivityReplaceSmsOneTimePasswordAuthentication":{"description":"The configuration for authentication with a one time password sent over SMS.","type":"object","properties":{"PhoneNumber":{"description":"The phone number to which the one time password will be sent.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"}}},"EnvelopeActivityReplaceSwedishBankIdAuthentication":{"description":"The configuration for Swedish BankID authentication.","type":"object","properties":{"PersonalNumber":{"description":"The personal number for the authentication.","maxLength":500,"minLength":0,"type":"string"},"AllowAnyPersonalNumber":{"description":"If true, the personal number can be edited by the recipient.\r\nIf the personal number is empty and can be edited, a QR code for scanning is provided.","type":"boolean"}}},"EnvelopeActivityReplaceOAuthAuthentication":{"description":"The configuration for authentication with an OAuth provider.","type":"object","properties":{"ProviderName":{"description":"The name of the OAuth provider.","maxLength":500,"minLength":0,"type":"string"},"Validations":{"description":"The validation rules for the OAuth response.","maxItems":100,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceAuthenticationValidation"}}}},"EnvelopeActivityReplaceSamlAuthentication":{"description":"The configuration for authentication with a SAML provider.","type":"object","properties":{"ProviderName":{"description":"The name of the SAML provider.","maxLength":500,"minLength":0,"type":"string"},"Validations":{"description":"The validation rules for the SAML response.","maxItems":100,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceAuthenticationValidation"}}}},"EnvelopeActivityReplaceFieldValidation":{"description":"The configuration of the field validation rules.","type":"object","properties":{"Type":{"description":"The type of the value.","enum":["None","Date","Email","Number","Phone","Time"],"type":"string","x-ms-enum":{"name":"FieldValidationType","modelAsString":false}},"DateValidationConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceDateValidationConfiguration","description":"The validation rules for dates."},"NumberValidationConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceNumberValidationConfiguration","description":"The validation rules for numbers."},"PhoneValidationConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplacePhoneValidationConfiguration","description":"The validation rules for phone numbers."},"TimeValidationConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceTimeValidationConfiguration","description":"The validation rules for time values."}}},"EnvelopeActivityReplaceAllowedSignatureTypes":{"description":"The definition of the allowed signature types for the signature.","type":"object","properties":{"ClickToSign":{"$ref":"#/definitions/EnvelopeActivityReplaceClickToSignSignatureType","description":"Allow signing with \"click to sign\"."},"DrawToSign":{"$ref":"#/definitions/EnvelopeActivityReplaceDrawToSignSignatureType","description":"Allow signing with \"draw to sign\"."},"TypeToSign":{"$ref":"#/definitions/EnvelopeActivityReplaceTypeToSignSignatureType","description":"Allow signing with \"type to sign\"."},"LocalCertificate":{"$ref":"#/definitions/EnvelopeActivityReplaceLocalCertificateSignatureType","description":"Allow signing with a local certificate."},"DisposableCertificate":{"$ref":"#/definitions/EnvelopeActivityReplaceDisposableCertificateSignatureType","description":"Allow signing with a disposable certificate."},"SwissComOnDemand":{"$ref":"#/definitions/EnvelopeActivityReplaceSwissComOnDemandSignatureType","description":"Allow signing with a Swisscom On-Demand certificate."},"ATrustCertificate":{"$ref":"#/definitions/EnvelopeActivityReplaceATrustCertificateSignatureType","description":"Allow signing with an A-Trust certificate."},"Biometric":{"$ref":"#/definitions/EnvelopeActivityReplaceBiometricSignatureType","description":"Allow signing with a biometric signature."},"RemoteCertificate":{"$ref":"#/definitions/EnvelopeActivityReplaceRemoteCertificateSignatureType","description":"Allow signing with a remote certificate."},"OneTimePassword":{"$ref":"#/definitions/EnvelopeActivityReplaceOneTimePasswordSignatureType","description":"Allow signing with a one time password (SMS-OTP)."},"SwedishBankId":{"$ref":"#/definitions/EnvelopeActivityReplaceSwedishBankIdSignatureType","description":"Allow signing with Swedish BankID."},"SignaturePlugins":{"description":"Allow signing with signature plugins.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceSignaturePluginSignatureType"}}}},"EnvelopeActivityReplaceSignatureTaskConfiguration":{"description":"The configuration of the signature task.","type":"object","properties":{"StampImprintDateConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceStampImprintDateConfiguration","description":"The configuration of the stamp imprint date."},"BatchGroup":{"description":"The batch group.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeActivityReplaceAttachmentDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/EnvelopeActivityReplacePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeActivityReplaceSize","description":"The size of the element."}}},"EnvelopeActivityReplacePredefinedText":{"description":"The configuration of the element showing the predefined text.","required":["DocumentNumber"],"type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Value":{"description":"The value of the predefined text.","maxLength":1000,"minLength":0,"type":"string"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeActivityReplacePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeActivityReplaceEmail":{"description":"The configuration of the predefined element.","required":["DocumentNumber"],"type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeActivityReplacePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeActivityReplaceGivenName":{"description":"The configuration of the predefined element.","required":["DocumentNumber"],"type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeActivityReplacePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeActivityReplaceSurname":{"description":"The configuration of the predefined element.","required":["DocumentNumber"],"type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeActivityReplacePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeActivityReplaceFullName":{"description":"The configuration of the predefined element.","required":["DocumentNumber"],"type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeActivityReplacePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeActivityReplaceDate":{"description":"The configuration of the predefined element showing the date.","required":["DocumentNumber"],"type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DateFormat":{"description":"The format of the date.","maxLength":50,"minLength":0,"type":"string"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeActivityReplacePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeActivityReplaceHyperLink":{"description":"The definition of the hyperlink element.","required":["DocumentNumber"],"type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Uri":{"description":"The URI of the hyperlink.","maxLength":8000,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeActivityReplaceLinkDefinition","description":"The definition of the hyperlink element.\r\nIt must be specified when the hyperlink element is added.\r\nIt must not be specified when the hyperlink element already exists."}}},"EnvelopeActivityReplaceReadingAreaDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/EnvelopeActivityReplacePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeActivityReplaceSize","description":"The size of the element."}}},"EnvelopeActivityReplaceSignaturePluginParameter":{"description":"The definition of a signature plugin parameter.","type":"object","properties":{"Key":{"description":"The identifier of the parameter.","maxLength":500,"minLength":0,"type":"string"},"Value":{"description":"The value of the parameter.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeActivityReplaceAuthenticationValidation":{"description":"A validation rule for an authentication response.","type":"object","properties":{"FieldReferenceId":{"description":"The identifier of the field.","maxLength":500,"minLength":0,"type":"string"},"ExpectedValue":{"description":"The expected value of the field.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeActivityReplaceDateValidationConfiguration":{"description":"The validation rules for dates.","type":"object","properties":{"DateFormat":{"description":"The format of the dates.","maxLength":50,"minLength":0,"type":"string"},"Range":{"$ref":"#/definitions/EnvelopeActivityReplaceFieldValidationRange","description":"The range of the values."}}},"EnvelopeActivityReplaceTimeValidationConfiguration":{"description":"The validation rules for time values.","type":"object","properties":{"TimeFormat":{"description":"The format of the time values.","maxLength":50,"minLength":0,"type":"string"},"Range":{"$ref":"#/definitions/EnvelopeActivityReplaceFieldValidationRange","description":"The range of the values."}}},"EnvelopeActivityReplacePredefinedElementDefinition":{"description":"The configuration of the predefined element.","required":["Position","Size"],"type":"object","properties":{"TextFormat":{"$ref":"#/definitions/EnvelopeActivityReplaceTextFormat","description":"The configuration of the text format."},"Position":{"$ref":"#/definitions/EnvelopeActivityReplacePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeActivityReplaceSize","description":"The size of the element."}}},"EnvelopeActivityReplaceLinkDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/EnvelopeActivityReplacePosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeActivityReplaceSize","description":"The size of the element."}}},"EnvelopeActivityReplaceFieldValidationRange":{"description":"The validation rules for a value range.","type":"object","properties":{"From":{"description":"The lower boundary of the range.","maxLength":100,"minLength":0,"type":"string"},"To":{"description":"The upper boundary of the range.","maxLength":100,"minLength":0,"type":"string"}}},"EnvelopeActivityReplaceTextFormat":{"description":"The configuration of the text format.","type":"object","properties":{"TextColor":{"description":"The color of the text. The default color is black.\r\nSix digit hexadecimal color that starts with # in #RRGGBB format according to CSS Color Module Level 4, paragraph 5.2.","maxLength":7,"minLength":7,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"number"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"Bold":{"description":"If true, the bold font is used.","type":"boolean"},"Italic":{"description":"If true, the italic font is used.","type":"boolean"},"TextAlign":{"description":"The alignment of the text. The default alignment is left.","enum":["Left","Center","Right"],"type":"string"}}},"EnvelopeActivityReplacePluginStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeActivityReplaceSwedishBankIdStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayTransactionId":{"description":"If true, the transaction identifier is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeActivityReplaceOneTimePasswordStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayTransactionId":{"description":"If true, the transaction identifier is displayed.","type":"boolean"},"DisplayTransactionToken":{"description":"If true, the transaction token is displayed.","type":"boolean"},"DisplayPhoneNumber":{"description":"If true, the phone number of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeActivityReplaceRemoteCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeActivityReplaceSwissComOnDemandStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeActivityReplaceDisposableCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeActivityReplaceLocalCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeActivityReplaceTypeToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeActivityReplaceDrawToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeActivityReplaceClickToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeActivityReplaceStampImprintDateConfiguration":{"description":"The configuration of the stamp imprint date.","type":"object","properties":{"UseLocalTimezone":{"description":"If true, the local timezone is used.","type":"boolean"},"DateTimeFormat":{"description":"The format of the timestamp.","maxLength":50,"minLength":0,"type":"string"}}},"EnvelopeActivityReplaceSignaturePluginSignatureType":{"description":"The configuration of the signature plugin.","type":"object","properties":{"PluginId":{"description":"The identifier of the plugin.","maxLength":500,"minLength":0,"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplacePluginStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeActivityReplaceSwedishBankIdSignatureType":{"description":"The configuration of the signature.","type":"object","properties":{"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceSwedishBankIdStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeActivityReplaceOneTimePasswordSignatureType":{"description":"The configuration of the OneTimePassword signature.","type":"object","properties":{"ValidityInSeconds":{"description":"The validity of the password in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceOneTimePasswordStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeActivityReplaceRemoteCertificateSignatureType":{"description":"The configuration of the RemoteCertificate signature.","type":"object","properties":{"ValidityInSeconds":{"description":"The validity of the certificate in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceRemoteCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeActivityReplaceBiometricSignatureType":{"description":"The configuration of the Biometric signature.","type":"object","properties":{"BiometricVerification":{"description":"If true, a biometric verification is performed.","type":"boolean"},"AllowBiometricStoringOnly":{"description":"If true, the biometric signature might be stored without verification.","type":"boolean"},"StoreSignedResponseWithoutBioData":{"description":"If true, the signed response is stored without biometric data.","type":"boolean"},"BiometricServerUserId":{"description":"The identifier of the user on the biometric server.","maxLength":50,"minLength":0,"type":"string"},"SignaturePositioning":{"description":"The allowed positioning of the biometric signature.","enum":["WithinField","OnPage","IntersectsWithField"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"}}},"EnvelopeActivityReplaceATrustCertificateSignatureType":{"description":"The configuration of the A-Trust certificate signature.","type":"object","properties":{"TemplateId":{"description":"The identifier of the A-Trust template.","maxLength":500,"minLength":0,"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"}}},"EnvelopeActivityReplaceSwissComOnDemandSignatureType":{"description":"The configuration of the Swisscom On-Demand signature.","type":"object","properties":{"ValidityInSeconds":{"description":"The validity of the certificate in seconds.","type":"integer"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceSwissComOnDemandStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeActivityReplaceDisposableCertificateSignatureType":{"description":"The configuration of the DisposableCertificate signature.","type":"object","properties":{"IsLongLived":{"description":"If true, the disposable certificate is long lived.","type":"boolean"},"ValidityInSeconds":{"description":"The validity of the certificate in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceDisposableCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeActivityReplaceLocalCertificateSignatureType":{"description":"The configuration of the LocalCertificate signature.","type":"object","properties":{"EnforcePreferredHashAlgorithm":{"description":"If true, the usage of the preferred hash algorithm is enforced.","type":"boolean"},"PreferredHashAlgorithm":{"description":"The preferred hash algorithm.","enum":["Sha256","Sha512"],"type":"string"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceLocalCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeActivityReplaceTypeToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceTypeToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeActivityReplaceDrawToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceDrawToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeActivityReplaceClickToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceClickToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeActivityReplacePhoneValidationConfiguration":{"description":"The validation rules for phone numbers.","type":"object","properties":{"Type":{"description":"The format of the phone numbers.","enum":["International","InternationalLeadingZeros","InternationalLeadingPlus"],"type":"string"}}},"EnvelopeActivityReplaceNumberValidationConfiguration":{"description":"The validation rules for numbers.","type":"object","properties":{"DecimalDigits":{"description":"The expected amount of decimal digits.","type":"integer"},"Symbol":{"description":"The expected symbol.","maxLength":5,"minLength":0,"type":"string"},"SymbolLocation":{"description":"The defined symbol location.","enum":["Start","StartWithBlank","End","EndWithBlank"],"type":"string"},"GroupSeparator":{"description":"The expected thousands separator.","enum":["Comma","Point","Apostrophe","Blank","None"],"type":"string"},"DecimalSeparator":{"description":"The expected decimal separator.","enum":["Comma","Point","Apostrophe","None"],"type":"string","x-ms-enum":{"name":"DecimalSeparatorType","modelAsString":false}},"Range":{"$ref":"#/definitions/EnvelopeActivityReplaceFieldValidationRange","description":"The range of the values."}}},"EnvelopeActivityReplaceInitials":{"description":"The configuration of the predefined element showing the initials.","required":["DocumentNumber"],"type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"IncludeMiddleNameInitials":{"description":"If true, the initials from the middle names are included as well. \r\nThe initials are read from the given name. Additional names are expected to be separated by a space.","type":"boolean"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeActivityReplacePredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeActivityReplaceDisposableCertificateSignatureData":{"description":"The recipient configuration for signing with a disposable certificate.","type":"object","properties":{"DocumentIssuingCountry":{"description":"The issuing country of the document.\r\nWill be used as country of residence, if lean is disabled.","maxLength":500,"minLength":0,"type":"string"},"IdentificationIssuingCountry":{"description":"The issuing country of the identification.","maxLength":500,"minLength":0,"type":"string"},"IdentificationType":{"description":"The type of identification in use.","enum":["None","ForeignTaxCode","PersonalNumber","Passport","NationalIdentityCard","ItalianTaxCode","NoSerialNumber","DrivingLicense","ResidencePermit","TemporaryResidencePermit","EmbassyDocument","AML"],"type":"string","x-ms-enum":{"name":"DisposableCertificateIdentificationType","modelAsString":false}},"PhoneNumber":{"description":"The phone number registered for identification.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"},"DocumentType":{"description":"The type of document used for the identification.","enum":["IdentityCard","DriverLicense","Passport","ResidencePermit","NationalElectronicIdentityCard","TemporaryResidencePermit","EmbassyDocument"],"type":"string"},"DocumentIssuedBy":{"description":"The authority that issued the document.","maxLength":500,"minLength":0,"type":"string"},"DocumentIssuedOn":{"format":"date","description":"The date when the document has been issued.\r\nA date in the format RFC 3339, section 5.6, 'full-date' (e.g. 2017-07-21).","maxLength":10,"minLength":10,"type":"string"},"DocumentExpiryDate":{"format":"date","description":"The expiration date of the document.\r\nA date in the format RFC 3339, section 5.6, 'full-date' (e.g. 2017-07-21).","maxLength":10,"minLength":10,"type":"string"},"SerialNumber":{"description":"The serial number of the certificate.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"description":"The identifier of the document.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeActivityReplaceReadDocumentConfirmation":{"description":"The document which has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"}}},"EnvelopeActivityReplaceReadPagesConfirmation":{"description":"The page which has to be read.","required":["DocumentNumber"],"type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"PageNumber":{"format":"int32","description":"The number of the page that needs to be read. Starting with 1.","type":"integer"},"GuidingOrder":{"description":"The order of the element.","type":"integer"}}},"EnvelopeActivityReplaceReadAreaConfirmation":{"description":"The area that has to be read.","required":["DocumentNumber"],"type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"Definition":{"$ref":"#/definitions/EnvelopeActivityReplaceReadingAreaDefinition","description":"The definition of the area.\r\nWhen adding a new element, it has to be specified .\r\nWhen the field already exists, it must not be specified."}}},"EnvelopeActivityReplaceAttachment":{"description":"The configuration of the attachment element.","required":["DocumentNumber"],"type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"DisplayIconType":{"description":"The type of the displayed icon. If no icon is provided Paperclip will be used.","enum":["Paperclip","Graph","PushPin","Tag"],"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeActivityReplaceAttachmentDefinition","description":"The definition of the attachment element.\r\nIt must be specified when the attachment element is added.\r\nIt must not be specified when the attachment element already exists."}}},"EnvelopeActivityReplaceSignatureField":{"description":"The configuration of the signature field.","required":["ElementId","DocumentNumber"],"type":"object","properties":{"ElementId":{"description":"The identifier of the signature.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"FieldDescription":{"description":"The description of the signature.","maxLength":500,"minLength":0,"type":"string"},"UseExternalTimestampServer":{"description":"If true, a timestamp from an external server is embedded into the signature.","type":"boolean"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"AllowedSignatureTypes":{"$ref":"#/definitions/EnvelopeActivityReplaceAllowedSignatureTypes","description":"The allowed types for the signature."},"FieldDefinition":{"$ref":"#/definitions/EnvelopeActivityReplaceSignatureFieldDefinition","description":"The definition of the signature field.\r\nIt must be specified when the signature field is added.\r\nIt must not be specified when the signature field already exists."},"TaskConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceSignatureTaskConfiguration","description":"The configuration of the task."}}},"EnvelopeActivityReplaceListBox":{"description":"The configuration of the list box.","required":["ElementId","DocumentNumber"],"type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"PreSelectedItems":{"description":"The export values of the items which should be initially selected.","maxItems":50,"type":"array","items":{"maxLength":500,"type":"string"}},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"GuidingOrder":{"description":"The order of the element.","type":"integer"}}},"EnvelopeActivityReplaceRadioButtonGroup":{"description":"The configuration of the radio button group.","required":["SelectedItem","DocumentNumber"],"type":"object","properties":{"GroupName":{"description":"The name of the radio button group.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"SelectedItem":{"description":"The export value of the selected item of the radio button group.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"GuidingOrder":{"description":"The order of the element.","type":"integer"}}},"EnvelopeActivityReplaceComboBox":{"description":"The configuration of the combo box.","required":["ElementId","DocumentNumber"],"type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"Value":{"description":"The selected value of the combo box.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"GuidingOrder":{"description":"The order of the element.","type":"integer"}}},"EnvelopeActivityReplaceCheckBox":{"description":"The configuration of the check box.","required":["ElementId","DocumentNumber"],"type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"IsChecked":{"description":"If true, the check box is checked.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"GuidingOrder":{"description":"The order of the element.","type":"integer"}}},"EnvelopeActivityReplaceTextBox":{"description":"The configuration of the text box.","required":["ElementId","DocumentNumber"],"type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"Value":{"description":"The value of the text box.","maxLength":204800,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"Validation":{"$ref":"#/definitions/EnvelopeActivityReplaceFieldValidation","description":"The configuration of the validation rules for the text box value."}}},"EnvelopeActivityReplaceEmailAppLinks":{"description":"Configure if links for our apps should be included in the recipient document signing request email message.","type":"object","properties":{"Android":{"description":"If true, an Android app link is added to the email message.","type":"boolean"},"iOS":{"description":"If true, an iOS app link is added to the email message.","type":"boolean"},"Windows":{"description":"If true, a Windows app link is added to the email message.","type":"boolean"}}},"EnvelopeActivityReplaceContactInformation":{"description":"Define the contact information for the recipient.","required":["Email","GivenName","Surname"],"type":"object","properties":{"Email":{"description":"The email address of the recipient.","maxLength":250,"minLength":0,"pattern":"^[a-zA-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF0-9.!#$%&'*+\\-\\/=?^_`{|}~]+@(?=[a-z0-9A-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF])(?:[a-z0-9A-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF]|(?<![.-])\\.|(?<!\\.)-)*[a-z0-9A-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF]$","type":"string"},"GivenName":{"description":"The given name of the recipient.","maxLength":200,"minLength":0,"type":"string"},"Surname":{"description":"The surname of the recipient.","maxLength":200,"minLength":0,"type":"string"},"PhoneNumber":{"description":"The phone number of the recipient.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"},"LanguageCode":{"description":"The language of the recipient.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string"}}},"EnvelopeActivityReplaceGeneralPoliciesForP7MAction":{"description":"Define the general policies allowed for P7M action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"},"AllowAdhocPdfAttachments":{"description":"If true, the client is allowed to append adhoc documents.","type":"boolean"},"AllowRejectWorkstep":{"description":"If true, the client is allowed to reject the workstep.","type":"boolean"},"AllowUndoLastAction":{"description":"If true, the client is allowed to undo actions.","type":"boolean"},"AllowDownloadOfSignedP7MFiles":{"description":"If true, the client is allowed to download signed p7m files.","type":"boolean"}}},"EnvelopeActivityReplaceP7MSignatureMethods":{"description":"The recipient configuration for signing with P7M.","type":"object","properties":{"LocalCertificate":{"description":"If true, a local certificate can be used.","type":"boolean"},"DisposableCertificate":{"$ref":"#/definitions/EnvelopeActivityReplaceDisposableCertificateSignatureData","description":"The disposable certificate configuration for the action."},"RemoteCertificate":{"$ref":"#/definitions/EnvelopeActivityReplaceRemoteCertificateSignatureData","description":"The remote certificate configuration for the action."},"SignaturePluginData":{"description":"The signature plugin configurations for the action.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceSignaturePluginSignatureData"}}}},"EnvelopeActivityReplaceGeneralPoliciesForViewAction":{"description":"Define the general policies allowed for view action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"}}},"EnvelopeActivityReplaceRecipientConfiguration":{"description":"The configuration of the recipient.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/EnvelopeActivityReplaceContactInformation","description":"The contact information of the recipient."},"PersonalMessage":{"description":"The personal message for the recipient.","maxLength":204800,"minLength":0,"type":"string"},"AuthenticationConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceAuthenticationConfiguration","description":"The configuration for the authentication of the recipient."},"SendEmails":{"description":"If true, emails will be sent out for this recipient.","type":"boolean"},"AllowAccessAfterFinish":{"description":"If true, the recipient is allowed to access the action after it has been finished.\r\nIt is required that the organization has the AllowAccessFinishedWorkstep feature enabled.\r\nThe default value is taken from the OrganizationSettings.","type":"boolean"}}},"EnvelopeActivityReplaceGeneralPoliciesForSignAction":{"description":"Define the general policies allowed for sign action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"},"AllowAdhocPdfAttachments":{"description":"If true, the client is allowed to append adhoc documents.","type":"boolean"},"AllowRejectWorkstep":{"description":"If true, the client is allowed to reject the workstep.","type":"boolean"},"AllowUndoLastAction":{"description":"If true, the client is allowed to undo actions.","type":"boolean"}}},"EnvelopeActivityReplaceAdvancedRecipientConfiguration":{"description":"The advanced configuration for the recipient.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/EnvelopeActivityReplaceContactInformation","description":"The contact information of the recipient."},"PersonalMessage":{"description":"The personal message for the recipient.","maxLength":204800,"minLength":0,"type":"string"},"AuthenticationConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceAuthenticationConfiguration","description":"The configuration for the authentication of the recipient."},"SendEmails":{"description":"If true, emails will be sent out for this recipient.","type":"boolean"},"AllowAccessAfterFinish":{"description":"If true, the recipient is allowed to access the action after it has been finished.\r\nIt is required that the organization has the AllowAccessFinishedWorkstep feature enabled.\r\nThe default value is taken from the OrganizationSettings.","type":"boolean"},"IncludedEmailAppLinks":{"$ref":"#/definitions/EnvelopeActivityReplaceEmailAppLinks","description":"The configuration for mobile app links in email messages."},"AllowDelegation":{"description":"If true, the recipient may delegate this activity to another person.","type":"boolean"},"RequireViewContentBeforeFormFilling":{"description":"If true, the signer has to confirm the reading of all documents as first task.","type":"boolean"}}},"EnvelopeActivityReplaceVisibleSignature":{"description":"A signature with a visual appearance on the document.","required":["DocumentNumber"],"type":"object","properties":{"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"UseExternalTimestampServer":{"description":"If true, a timestamp from an external server is embedded into the signature.","type":"boolean"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeActivityReplaceSignatureFieldDefinition","description":"The definition of the signature field.\r\nIt must be specified when the signature field is added.\r\nIt must not be specified when the signature field already exists."}}},"EnvelopeActivityReplaceSign":{"description":"A sign action for the recipient.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"Elements":{"$ref":"#/definitions/EnvelopeActivityReplaceElements","description":"The elements in the document (e.g. form fields) assigned to the recipient."},"FinishActionConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceFinishAction","description":"Defines what happens in the signing clients, after an action has been finished."},"SignatureDataConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceSignatureDataConfiguration","description":"The configuration of recipient data for special signatures."},"BatchConfiguration":{"$ref":"#/definitions/EnvelopeActivityReplaceBatchConfiguration","description":"The configuration of a signing batch."},"SequenceMode":{"description":"The sequence mode.","enum":["NoSequenceEnforced","SequenceEnforced"],"type":"string"},"GeneralPoliciesOverrides":{"$ref":"#/definitions/EnvelopeActivityReplaceGeneralPoliciesForSignAction","description":"Viewer policy settings for override."}}},"EnvelopeActivityReplaceSignAutomatic":{"description":"An automatic signing action.","type":"object","properties":{"ProfileId":{"description":"The identifier of the profile for the automatic signatures.","maxLength":500,"minLength":0,"type":"string"},"RenderingLanguageCode":{"description":"The rendering language for the automatic signatures.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string"},"VisibleSignatures":{"description":"The visible signatures define the optional visual representations for automatic signatures.\r\nIf none are defined, the automatic signatures are applied to the documents without a visual element.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/EnvelopeActivityReplaceVisibleSignature"}}}},"EnvelopeBulkGetResponse":{"description":"The response model for requesting the bulk envelope overview.","type":"object","properties":{"BulkStatus":{"description":"The status of the BulkParent envelope.","enum":["Active","PartlyCompleted","Completed"],"type":"string","x-ms-enum":{"name":"BulkStatus","modelAsString":false}},"Children":{"description":"The children of the bulk envelope.","type":"array","items":{"$ref":"#/definitions/EnvelopeBulkGetChildEnvelope"}}}},"EnvelopeBulkGetChildEnvelope":{"description":"The child envelope of a BulkParent.","type":"object","properties":{"EnvelopeId":{"description":"The identifier of the child envelope.","type":"string"},"SentDate":{"format":"date","description":"Date when the envelope was sent.","type":"string"},"Status":{"description":"The status of the envelope.","enum":["Active","Completed","Canceled","Expired","Rejected"],"type":"string","x-ms-enum":{"name":"EnvelopeStatusExternal","modelAsString":false}},"Email":{"description":"The email address of the bulk recipient for which this child envelope was created.","type":"string"}}},"EnvelopeBulkFindRequest":{"description":"The request model for searching BulkParent envelopes.\r\nWe are searching for BulkChild but return only BulkParent information. \r\nNote: At this stage, there is no possibility to filter for specific status values.","type":"object","properties":{"SenderEmail":{"description":"If set, envelopes sent by the user with the given email address are matched.","maxLength":250,"minLength":0,"type":"string"},"CompletedByRecipientWithEmail":{"description":"If set, envelopes containing a completed activity, belonging to a recipient with the given email address, are matched.","maxLength":250,"minLength":0,"type":"string"},"WaitingForRecipientWithEmail":{"description":"If set, envelopes waiting for the recipient with the given email address are matched.","maxLength":250,"minLength":0,"type":"string"},"EnvelopeBulkChildId":{"description":"If set, it matches only the BulkParent which contains a child envelope with the given identifier.","maxLength":36,"minLength":36,"type":"string"},"StartDate":{"format":"date-time","description":"If set, filter for envelopes which were sent after the start date.\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","maxLength":30,"minLength":20,"type":"string"},"EndDate":{"format":"date-time","description":"If set, filter for envelopes which were sent before the end date.\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","maxLength":30,"minLength":20,"type":"string"},"SearchText":{"description":"If set, the given text is searched in following fields:\r\nenvelope name and description\r\nnotification subject and message \r\nsender email address, given name and surname  \r\nrecipient email address, given name and surname\r\nNote: Using this search option is very resource intensive! It might take very long.","maxLength":500,"minLength":0,"type":"string"},"RecipientEmail":{"description":"If set, envelopes containing a recipient with the given email address are matched.","maxLength":250,"minLength":0,"type":"string"}}},"EnvelopeBulkFindResponse":{"description":"The response model for found BulkParent envelopes.","type":"object","properties":{"BulkParentEnvelopes":{"description":"The BulkParent envelopes where the child envelopes match the search criteria.","type":"array","items":{"$ref":"#/definitions/EnvelopeBulkFindParentEnvelope"}}}},"EnvelopeBulkFindParentEnvelope":{"description":"The response model for found envelopes.","type":"object","properties":{"Id":{"description":"The identifier of the envelope.","type":"string"},"Name":{"description":"The name of the envelope.","type":"string"},"MetaData":{"description":"The metadata of the envelope.","type":"string"}}},"EnvelopeBulkSendDocument":{"description":"Define a document.","type":"object","properties":{"FileId":{"description":"The identifier of the file.","maxLength":36,"minLength":36,"type":"string"},"DocumentNumber":{"format":"int32","description":"The document number.\r\nIf the document number is 0 for all documents, the order of the documents is used as number.\r\nThe document number must not be duplicated.\r\nThe document number must be set for all documents or none.","type":"integer"}}},"EnvelopeBulkSendUnassignedElements":{"description":"The configurable elements of a document, which are also stored within the document.","type":"object","properties":{"TextBoxes":{"description":"The text boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendTextBox"}},"CheckBoxes":{"description":"The check boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendCheckBox"}},"ComboBoxes":{"description":"The combo boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendComboBox"}},"RadioButtons":{"description":"The radio buttons.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendRadioButtonGroup"}},"ListBoxes":{"description":"The list boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendListBox"}}}},"EnvelopeBulkSendActivity":{"description":"Define an activity with the possibility of bulk.","type":"object","properties":{"Action":{"$ref":"#/definitions/EnvelopeBulkSendAction","description":"The action assigned to the activity."},"VisibilityOptions":{"description":"The document visibility options for the activity.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendVisibilityOption"}}}},"EnvelopeBulkSendEmailConfiguration":{"description":"The configuration for notifications.","type":"object","properties":{"Subject":{"description":"The subject of the sign notifications.","maxLength":300,"minLength":0,"type":"string"},"Message":{"description":"The message of the sign notifications.","maxLength":204800,"minLength":0,"type":"string"},"SenderDisplayName":{"description":"The displayed name of the sender in the notifications.","maxLength":200,"minLength":0,"type":"string"}}},"EnvelopeBulkSendAgreementConfiguration":{"description":"The configuration of the agreement.","type":"object","properties":{"Translations":{"description":"The agreement and its translations to be used.\r\nIf no custom agreement is specified, the default organization agreement will be used.","maxItems":228,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendAgreementTranslation"}}}},"EnvelopeBulkSendSealingConfiguration":{"description":"The sealing configuration for the envelope","type":"object","properties":{"CertificateId":{"description":"Custom Sealing certificate identifier.","maxLength":36,"minLength":0,"type":"string"}}},"EnvelopeBulkSendAction":{"description":"The action of the activity with the possibility to define a bulk. Exactly one definition must be used!","type":"object","properties":{"SendCopy":{"$ref":"#/definitions/EnvelopeBulkSendSendCopy","description":"The definition of the copy action."},"SignAutomatic":{"$ref":"#/definitions/EnvelopeBulkSendSignAutomatic","description":"The definition of the automatic sign action."},"Sign":{"$ref":"#/definitions/EnvelopeBulkSendSign","description":"The definition of the sign action."},"View":{"$ref":"#/definitions/EnvelopeBulkSendView","description":"The definition of the view action."},"SignAsP7M":{"$ref":"#/definitions/EnvelopeBulkSendSignAsP7M","description":"The definition of the P7M sign action."},"SignBulk":{"$ref":"#/definitions/EnvelopeBulkSendSignBulk","description":"The definition of the bulk."}}},"EnvelopeBulkSendVisibilityOption":{"description":"The options defining the document visibility.","type":"object","properties":{"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"IsHidden":{"description":"If true, the referenced document is hidden for the activity.","type":"boolean"}}},"EnvelopeBulkSendActivityActionCallbackConfiguration":{"description":"The configuration of the callback for workstep events.","required":["Url"],"type":"object","properties":{"Url":{"description":"The callback URL triggered for the selected events.","maxLength":8000,"minLength":0,"type":"string"},"ActionCallbackSelection":{"$ref":"#/definitions/EnvelopeBulkSendActionCallbackSelection","description":"The selection of events which trigger the callback."}}},"EnvelopeBulkSendAgreementTranslation":{"description":"A translation for the agreement.","required":["LanguageCode","Text"],"type":"object","properties":{"LanguageCode":{"description":"The language of the translated agreement.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string","x-ms-enum":{"name":"LanguageCode","modelAsString":false}},"Text":{"description":"The translated agreement.","maxLength":204800,"minLength":0,"type":"string"},"Header":{"description":"The header for the translated agreement.","maxLength":1000,"minLength":0,"type":"string"},"IsDefault":{"description":"If true, this translation is used as default.","type":"boolean"}}},"EnvelopeBulkSendFieldValidation":{"description":"The configuration of the field validation rules.","type":"object","properties":{"Type":{"description":"The type of the value.","enum":["None","Date","Email","Number","Phone","Time"],"type":"string","x-ms-enum":{"name":"FieldValidationType","modelAsString":false}},"DateValidationConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendDateValidationConfiguration","description":"The validation rules for dates."},"NumberValidationConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendNumberValidationConfiguration","description":"The validation rules for numbers."},"PhoneValidationConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendPhoneValidationConfiguration","description":"The validation rules for phone numbers."},"TimeValidationConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendTimeValidationConfiguration","description":"The validation rules for time values."}}},"EnvelopeBulkSendSendCopy":{"description":"An action to send a copy of the documents to the recipient.","required":["RecipientConfiguration"],"type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendBasicRecipientConfiguration","description":"The configuration of the recipient."},"CopyingGroup":{"description":"The group for defining parallel copy actions.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeBulkSendView":{"description":"An action to view and acknowledge the documents.","required":["RecipientConfiguration"],"type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendRecipientConfiguration","description":"The configuration of the recipient."},"GeneralPoliciesOverrides":{"$ref":"#/definitions/EnvelopeBulkSendGeneralPoliciesForViewAction","description":"Viewer policy settings for override."}}},"EnvelopeBulkSendSignAsP7M":{"description":"An action to sign the documents with P7M.","required":["RecipientConfiguration","SignatureMethods"],"type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"SignatureMethods":{"$ref":"#/definitions/EnvelopeBulkSendP7MSignatureMethods","description":"The configuration of recipient data for P7M signatures."},"GeneralPoliciesOverrides":{"$ref":"#/definitions/EnvelopeBulkSendGeneralPoliciesForP7MAction","description":"Viewer policy settings for override."}}},"EnvelopeBulkSendDateValidationConfiguration":{"description":"The validation rules for dates.","type":"object","properties":{"DateFormat":{"description":"The format of the dates.","maxLength":50,"minLength":0,"type":"string"},"Range":{"$ref":"#/definitions/EnvelopeBulkSendFieldValidationRange","description":"The range of the values."}}},"EnvelopeBulkSendTimeValidationConfiguration":{"description":"The validation rules for time values.","type":"object","properties":{"TimeFormat":{"description":"The format of the time values.","maxLength":50,"minLength":0,"type":"string"},"Range":{"$ref":"#/definitions/EnvelopeBulkSendFieldValidationRange","description":"The range of the values."}}},"EnvelopeBulkSendPosition":{"description":"The position of an element on the document.","required":["X","Y"],"type":"object","properties":{"PageNumber":{"format":"int32","description":"The number of the page where the element is located. It starts with 1.","type":"integer"},"X":{"format":"double","description":"The X coordinate in points. It starts from the left.","type":"number"},"Y":{"format":"double","description":"The Y coordinate in points. It starts from the bottom.","type":"number"}}},"EnvelopeBulkSendSize":{"description":"The definition of the size of an element.","required":["Width","Height"],"type":"object","properties":{"Width":{"format":"double","description":"The width of the element in points.","type":"number"},"Height":{"format":"double","description":"The height of the element in points.","type":"number"}}},"EnvelopeBulkSendChoiceItem":{"description":"The configuration of the choice item.","required":["DisplayValue"],"type":"object","properties":{"ExportValue":{"description":"The value of the element when the choice item is selected.","maxLength":500,"minLength":0,"type":"string"},"DisplayValue":{"description":"The displayed value of the choice item.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeBulkSendBasicRecipientConfiguration":{"description":"The configuration of the recipient.","required":["ContactInformation"],"type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/EnvelopeBulkSendContactInformation","description":"The contact information of the recipient."},"PersonalMessage":{"description":"The personal message for the recipient.","maxLength":204800,"minLength":0,"type":"string"}}},"EnvelopeBulkSendElements":{"description":"The configurable elements of the documents.","type":"object","properties":{"TextBoxes":{"description":"The text boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendTextBox"}},"CheckBoxes":{"description":"The check boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendCheckBox"}},"ComboBoxes":{"description":"The combo boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendComboBox"}},"RadioButtons":{"description":"The radio buttons.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendRadioButtonGroup"}},"ListBoxes":{"description":"The list boxes.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendListBox"}},"Signatures":{"description":"The signatures.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendSignatureField"}},"Attachments":{"description":"The attachments.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendAttachment"}},"PredefinedFieldElements":{"$ref":"#/definitions/EnvelopeBulkSendPredefinedFieldElements","description":"The predefined field elements."},"LinkConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendLinkConfiguration","description":"The links in the documents."},"AreaReadConfirmations":{"description":"The areas which have to be read.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendReadAreaConfirmation"}},"PageReadConfirmations":{"description":"The pages which have to be read.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendReadPagesConfirmation"}},"DocumentReadConfirmations":{"description":"The documents which have to be read.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendReadDocumentConfirmation"}}}},"EnvelopeBulkSendFinishAction":{"description":"Define what happens in the signing clients, after an action has been finished.","type":"object","properties":{"SignAnyWhereViewer":{"$ref":"#/definitions/EnvelopeBulkSendClientFinishAction","description":"The actions for the SAW Viewer."},"SignificantClientSignatureCaptureForIos":{"$ref":"#/definitions/EnvelopeBulkSendAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for iOS."},"SignificantClientSignatureCaptureForAndroid":{"$ref":"#/definitions/EnvelopeBulkSendAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for Android."},"SignificantClientSignatureCaptureForWindows":{"$ref":"#/definitions/EnvelopeBulkSendAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for Windows."},"KioskSdk":{"$ref":"#/definitions/EnvelopeBulkSendKioskFinishAction","description":"The actions for the SIGNificant Kiosk SDK."}}},"EnvelopeBulkSendSignatureDataConfiguration":{"description":"The recipient configuration for signing.","type":"object","properties":{"DisposableCertificate":{"$ref":"#/definitions/EnvelopeBulkSendDisposableCertificateSignatureData","description":"The disposable certificate configuration for the action."},"RemoteCertificate":{"$ref":"#/definitions/EnvelopeBulkSendRemoteCertificateSignatureData","description":"The remote certificate configuration for the action."},"SwissComOnDemand":{"$ref":"#/definitions/EnvelopeBulkSendSwissComOnDemandSignatureData","description":"The Swisscom On-Demand certificate configuration for the action."},"SmsOneTimePassword":{"$ref":"#/definitions/EnvelopeBulkSendSmsOneTimePasswordSignatureData","description":"The one time password configuration for the action (SMS-OTP)."},"ATrustCertificate":{"$ref":"#/definitions/EnvelopeBulkSendATrustCertificateSignatureData","description":"The A-Trust certificate configuration for the action."},"SwedishBankId":{"$ref":"#/definitions/EnvelopeBulkSendSwedishBankIdSignatureData","description":"The Swedish BankID configuration for the action."},"SignaturePluginData":{"description":"The signature plugin configurations for the action.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendSignaturePluginSignatureData"}}}},"EnvelopeBulkSendBatchConfiguration":{"description":"The configuration of a signing batch.","type":"object","properties":{"Mode":{"description":"The mode, that will be used for batch signing.","enum":["Basic","OptIn","OptOut","OptOutWithRequiredAlwaysSelected","OptInWithRequiredAlwaysSelected"],"type":"string","x-ms-enum":{"name":"BatchMode","modelAsString":false}},"RequireScrollingOverAllSignaturesBeforeSigning":{"description":"If true, the user has to review all signatures in the batch signing dialog before signing.\r\nThis is only applicable when the <code>Mode<\/code> is set to <code>OptIn<\/code> or <code>OptOut<\/code>.","type":"boolean"}}},"EnvelopeBulkSendRecipient":{"description":"The definition of the recipient including the signature data.","required":["RecipientConfiguration"],"type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"SignatureDataConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendSignatureDataConfiguration","description":"The configuration of the signature data for the recipient."}}},"EnvelopeBulkSendFieldValidationRange":{"description":"The validation rules for a value range.","type":"object","properties":{"From":{"description":"The lower boundary of the range.","maxLength":100,"minLength":0,"type":"string"},"To":{"description":"The upper boundary of the range.","maxLength":100,"minLength":0,"type":"string"}}},"EnvelopeBulkSendSignatureFieldDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/EnvelopeBulkSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeBulkSendSize","description":"The size of the element."}}},"EnvelopeBulkSendAuthenticationConfiguration":{"description":"The definition of the authentications of the recipient.","type":"object","properties":{"AccessCode":{"$ref":"#/definitions/EnvelopeBulkSendAccessCodeAuthentication","description":"The configuration of the authentication with an access code."},"SmsOneTimePassword":{"$ref":"#/definitions/EnvelopeBulkSendSmsOneTimePasswordAuthentication","description":"The configuration of the authentication with one time password over SMS."},"SwedishBankId":{"$ref":"#/definitions/EnvelopeBulkSendSwedishBankIdAuthentication","description":"The configuration of the authentication with Swedish BankID."},"OAuthAuthentications":{"description":"The configurations of the authentication with OAuth.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendOAuthAuthentication"}},"SamlAuthentications":{"description":"The configurations of the authentication with SAML.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendSamlAuthentication"}}}},"EnvelopeBulkSendPredefinedFieldElements":{"description":"Define the predefined fields which will be added and filled by the system.","type":"object","properties":{"TextFields":{"description":"The predefined text fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendPredefinedText"}},"EmailFields":{"description":"The recipient's email fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendEmail"}},"InitialsFields":{"description":"The recipient's initials fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendInitials"}},"GivenNameFields":{"description":"The recipient's given name fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendGivenName"}},"SurnameFields":{"description":"The recipient's surname fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendSurname"}},"FullNameFields":{"description":"The recipient's full name fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendFullName"}},"DateFields":{"description":"The current date fields.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendDate"}}}},"EnvelopeBulkSendLinkConfiguration":{"description":"The configuration of the link elements.","type":"object","properties":{"HyperLinks":{"description":"The list of hyperlink elements.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendHyperLink"}}}},"EnvelopeBulkSendClientFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RedirectUri":{"description":"The redirect uri.","maxLength":8000,"minLength":0,"type":"string"}}},"EnvelopeBulkSendAppFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RemoveDocumentFromRecentDocumentList":{"description":"If true, the document will be removed from the recent document list.","type":"boolean"},"CallClientActionOnlyAfterSuccessfulSync":{"description":"If true, the client action will be called only after a successful sync.","type":"boolean"},"CloseApp":{"description":"If true, the app will be closed.","type":"boolean"},"RedirectUri":{"description":"The redirect uri.","maxLength":8000,"minLength":0,"type":"string"}}},"EnvelopeBulkSendKioskFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RedirectUri":{"description":"The redirect uri.","maxLength":8000,"minLength":0,"type":"string"}}},"EnvelopeBulkSendRemoteCertificateSignatureData":{"description":"The recipient configuration for signing with a remote certificate.","type":"object","properties":{"UserId":{"description":"The identifier of the user.","maxLength":500,"minLength":0,"type":"string"},"DeviceId":{"description":"The identifier of the device.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeBulkSendSwissComOnDemandSignatureData":{"description":"The recipient configuration for signing with a Swisscom On-Demand certificate.","type":"object","properties":{"PhoneNumber":{"description":"The phone number.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"},"CommonName":{"description":"The name of the certificate that is created or checked.","maxLength":500,"minLength":0,"type":"string"},"Country":{"description":"The country.","maxLength":500,"minLength":0,"type":"string"},"Locality":{"description":"The locality.","maxLength":500,"minLength":0,"type":"string"},"OrganizationUnits":{"description":"The organizational units.","maxItems":228,"type":"array","items":{"maxLength":500,"type":"string"}},"Organization":{"description":"The organization.","maxLength":500,"minLength":0,"type":"string"},"SerialNumber":{"description":"The serial number.","maxLength":500,"minLength":0,"type":"string"},"StateOrProvince":{"description":"The state or province.","maxLength":500,"minLength":0,"type":"string"},"Pseudonym":{"description":"A name or key that uniquely identifies the user.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeBulkSendSmsOneTimePasswordSignatureData":{"description":"The recipient configuration for signing with a one time password sent via SMS.","type":"object","properties":{"PhoneNumber":{"description":"The phone number to which the one time password will be sent.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"}}},"EnvelopeBulkSendATrustCertificateSignatureData":{"description":"The recipient configuration for signing with an A-Trust certificate.","type":"object","properties":{"PhoneNumber":{"description":"The phone number of the recipient.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"}}},"EnvelopeBulkSendSwedishBankIdSignatureData":{"description":"The recipient configuration for signing with Swedish BankID.","type":"object","properties":{"PersonalNumber":{"description":"The personal number for signing.","maxLength":500,"minLength":0,"type":"string"},"AllowAnyPersonalNumber":{"description":"If true, the personal number can be edited by the recipient.\r\nIf the personal number is empty and can be edited, a QR code for scanning is provided.","type":"boolean"}}},"EnvelopeBulkSendSignaturePluginSignatureData":{"description":"The recipient configuration for signing with a signature plugin.","type":"object","properties":{"PluginId":{"description":"The identifier of the signature plugin.","maxLength":500,"minLength":0,"type":"string"},"Fields":{"description":"The plugin parameters referred to as the GSP sender data fields.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendSignaturePluginParameter"}}}},"EnvelopeBulkSendAccessCodeAuthentication":{"description":"The configuration for authentication with a predefined access code.","type":"object","properties":{"Code":{"description":"The code for authenticating the recipient.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeBulkSendSmsOneTimePasswordAuthentication":{"description":"The configuration for authentication with a one time password sent over SMS.","type":"object","properties":{"PhoneNumber":{"description":"The phone number to which the one time password will be sent.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"}}},"EnvelopeBulkSendSwedishBankIdAuthentication":{"description":"The configuration for Swedish BankID authentication.","type":"object","properties":{"PersonalNumber":{"description":"The personal number for the authentication.","maxLength":500,"minLength":0,"type":"string"},"AllowAnyPersonalNumber":{"description":"If true, the personal number can be edited by the recipient.\r\nIf the personal number is empty and can be edited, a QR code for scanning is provided.","type":"boolean"}}},"EnvelopeBulkSendOAuthAuthentication":{"description":"The configuration for authentication with an OAuth provider.","type":"object","properties":{"ProviderName":{"description":"The name of the OAuth provider.","maxLength":500,"minLength":0,"type":"string"},"Validations":{"description":"The validation rules for the OAuth response.","maxItems":100,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendAuthenticationValidation"}}}},"EnvelopeBulkSendSamlAuthentication":{"description":"The configuration for authentication with a SAML provider.","type":"object","properties":{"ProviderName":{"description":"The name of the SAML provider.","maxLength":500,"minLength":0,"type":"string"},"Validations":{"description":"The validation rules for the SAML response.","maxItems":100,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendAuthenticationValidation"}}}},"EnvelopeBulkSendAllowedSignatureTypes":{"description":"The definition of the allowed signature types for the signature.","type":"object","properties":{"ClickToSign":{"$ref":"#/definitions/EnvelopeBulkSendClickToSignSignatureType","description":"Allow signing with \"click to sign\"."},"DrawToSign":{"$ref":"#/definitions/EnvelopeBulkSendDrawToSignSignatureType","description":"Allow signing with \"draw to sign\"."},"TypeToSign":{"$ref":"#/definitions/EnvelopeBulkSendTypeToSignSignatureType","description":"Allow signing with \"type to sign\"."},"LocalCertificate":{"$ref":"#/definitions/EnvelopeBulkSendLocalCertificateSignatureType","description":"Allow signing with a local certificate."},"DisposableCertificate":{"$ref":"#/definitions/EnvelopeBulkSendDisposableCertificateSignatureType","description":"Allow signing with a disposable certificate."},"SwissComOnDemand":{"$ref":"#/definitions/EnvelopeBulkSendSwissComOnDemandSignatureType","description":"Allow signing with a Swisscom On-Demand certificate."},"ATrustCertificate":{"$ref":"#/definitions/EnvelopeBulkSendATrustCertificateSignatureType","description":"Allow signing with an A-Trust certificate."},"Biometric":{"$ref":"#/definitions/EnvelopeBulkSendBiometricSignatureType","description":"Allow signing with a biometric signature."},"RemoteCertificate":{"$ref":"#/definitions/EnvelopeBulkSendRemoteCertificateSignatureType","description":"Allow signing with a remote certificate."},"OneTimePassword":{"$ref":"#/definitions/EnvelopeBulkSendOneTimePasswordSignatureType","description":"Allow signing with a one time password (SMS-OTP)."},"SwedishBankId":{"$ref":"#/definitions/EnvelopeBulkSendSwedishBankIdSignatureType","description":"Allow signing with Swedish BankID."},"SignaturePlugins":{"description":"Allow signing with signature plugins.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendSignaturePluginSignatureType"}}}},"EnvelopeBulkSendSignatureTaskConfiguration":{"description":"The configuration of the signature task.","type":"object","properties":{"StampImprintDateConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendStampImprintDateConfiguration","description":"The configuration of the stamp imprint date."},"BatchGroup":{"description":"The batch group.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeBulkSendAttachmentDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/EnvelopeBulkSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeBulkSendSize","description":"The size of the element."}}},"EnvelopeBulkSendPredefinedText":{"description":"The configuration of the element showing the predefined text.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Value":{"description":"The value of the predefined text.","maxLength":1000,"minLength":0,"type":"string"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeBulkSendPredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeBulkSendEmail":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeBulkSendPredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeBulkSendGivenName":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeBulkSendPredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeBulkSendSurname":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeBulkSendPredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeBulkSendFullName":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeBulkSendPredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeBulkSendDate":{"description":"The configuration of the predefined element showing the date.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DateFormat":{"description":"The format of the date.","maxLength":50,"minLength":0,"type":"string"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeBulkSendPredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeBulkSendHyperLink":{"description":"The definition of the hyperlink element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Uri":{"description":"The URI of the hyperlink.","maxLength":8000,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeBulkSendLinkDefinition","description":"The definition of the hyperlink element.\r\nIt must be specified when the hyperlink element is added.\r\nIt must not be specified when the hyperlink element already exists."}}},"EnvelopeBulkSendReadingAreaDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/EnvelopeBulkSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeBulkSendSize","description":"The size of the element."}}},"EnvelopeBulkSendSignaturePluginParameter":{"description":"The definition of a signature plugin parameter.","type":"object","properties":{"Key":{"description":"The identifier of the parameter.","maxLength":500,"minLength":0,"type":"string"},"Value":{"description":"The value of the parameter.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeBulkSendAuthenticationValidation":{"description":"A validation rule for an authentication response.","type":"object","properties":{"FieldReferenceId":{"description":"The identifier of the field.","maxLength":500,"minLength":0,"type":"string"},"ExpectedValue":{"description":"The expected value of the field.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeBulkSendPredefinedElementDefinition":{"description":"The configuration of the predefined element.","required":["Position","Size"],"type":"object","properties":{"TextFormat":{"$ref":"#/definitions/EnvelopeBulkSendTextFormat","description":"The configuration of the text format."},"Position":{"$ref":"#/definitions/EnvelopeBulkSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeBulkSendSize","description":"The size of the element."}}},"EnvelopeBulkSendLinkDefinition":{"description":"The settings of a positionable element.","required":["Position","Size"],"type":"object","properties":{"Position":{"$ref":"#/definitions/EnvelopeBulkSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeBulkSendSize","description":"The size of the element."}}},"EnvelopeBulkSendPluginStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeBulkSendSwedishBankIdStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayTransactionId":{"description":"If true, the transaction identifier is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeBulkSendOneTimePasswordStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayTransactionId":{"description":"If true, the transaction identifier is displayed.","type":"boolean"},"DisplayTransactionToken":{"description":"If true, the transaction token is displayed.","type":"boolean"},"DisplayPhoneNumber":{"description":"If true, the phone number of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeBulkSendRemoteCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeBulkSendSwissComOnDemandStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeBulkSendDisposableCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeBulkSendLocalCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeBulkSendTypeToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeBulkSendDrawToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeBulkSendClickToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"EnvelopeBulkSendStampImprintDateConfiguration":{"description":"The configuration of the stamp imprint date.","type":"object","properties":{"UseLocalTimezone":{"description":"If true, the local timezone is used.","type":"boolean"},"DateTimeFormat":{"description":"The format of the timestamp.","maxLength":50,"minLength":0,"type":"string"}}},"EnvelopeBulkSendSignaturePluginSignatureType":{"description":"The configuration of the signature plugin.","type":"object","properties":{"PluginId":{"description":"The identifier of the plugin.","maxLength":500,"minLength":0,"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendPluginStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeBulkSendSwedishBankIdSignatureType":{"description":"The configuration of the signature.","type":"object","properties":{"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendSwedishBankIdStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeBulkSendOneTimePasswordSignatureType":{"description":"The configuration of the OneTimePassword signature.","type":"object","properties":{"ValidityInSeconds":{"description":"The validity of the password in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendOneTimePasswordStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeBulkSendRemoteCertificateSignatureType":{"description":"The configuration of the RemoteCertificate signature.","type":"object","properties":{"ValidityInSeconds":{"description":"The validity of the certificate in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendRemoteCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeBulkSendBiometricSignatureType":{"description":"The configuration of the Biometric signature.","type":"object","properties":{"BiometricVerification":{"description":"If true, a biometric verification is performed.","type":"boolean"},"AllowBiometricStoringOnly":{"description":"If true, the biometric signature might be stored without verification.","type":"boolean"},"StoreSignedResponseWithoutBioData":{"description":"If true, the signed response is stored without biometric data.","type":"boolean"},"BiometricServerUserId":{"description":"The identifier of the user on the biometric server.","maxLength":50,"minLength":0,"type":"string"},"SignaturePositioning":{"description":"The allowed positioning of the biometric signature.","enum":["WithinField","OnPage","IntersectsWithField"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"}}},"EnvelopeBulkSendATrustCertificateSignatureType":{"description":"The configuration of the A-Trust certificate signature.","type":"object","properties":{"TemplateId":{"description":"The identifier of the A-Trust template.","maxLength":500,"minLength":0,"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"}}},"EnvelopeBulkSendSwissComOnDemandSignatureType":{"description":"The configuration of the Swisscom On-Demand signature.","type":"object","properties":{"ValidityInSeconds":{"description":"The validity of the certificate in seconds.","type":"integer"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendSwissComOnDemandStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeBulkSendDisposableCertificateSignatureType":{"description":"The configuration of the DisposableCertificate signature.","type":"object","properties":{"IsLongLived":{"description":"If true, the disposable certificate is long lived.","type":"boolean"},"ValidityInSeconds":{"description":"The validity of the certificate in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendDisposableCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeBulkSendLocalCertificateSignatureType":{"description":"The configuration of the LocalCertificate signature.","type":"object","properties":{"EnforcePreferredHashAlgorithm":{"description":"If true, the usage of the preferred hash algorithm is enforced.","type":"boolean"},"PreferredHashAlgorithm":{"description":"The preferred hash algorithm.","enum":["Sha256","Sha512"],"type":"string"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendLocalCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeBulkSendTypeToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendTypeToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeBulkSendDrawToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendDrawToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeBulkSendClickToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.\r\nOnly one signature type may be marked.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendClickToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"EnvelopeBulkSendInitials":{"description":"The configuration of the predefined element showing the initials.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"IncludeMiddleNameInitials":{"description":"If true, the initials from the middle names are included as well. \r\nThe initials are read from the given name. Additional names are expected to be separated by a space.","type":"boolean"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeBulkSendPredefinedElementDefinition","description":"The definition of the predefined element.\r\nIt must be specified when the predefined element is added.\r\nIt must not be specified when the predefined element already exists."}}},"EnvelopeBulkSendDisposableCertificateSignatureData":{"description":"The recipient configuration for signing with a disposable certificate.","type":"object","properties":{"DocumentIssuingCountry":{"description":"The issuing country of the document.\r\nWill be used as country of residence, if lean is disabled.","maxLength":500,"minLength":0,"type":"string"},"IdentificationIssuingCountry":{"description":"The issuing country of the identification.","maxLength":500,"minLength":0,"type":"string"},"IdentificationType":{"description":"The type of identification in use.","enum":["None","ForeignTaxCode","PersonalNumber","Passport","NationalIdentityCard","ItalianTaxCode","NoSerialNumber","DrivingLicense","ResidencePermit","TemporaryResidencePermit","EmbassyDocument","AML"],"type":"string","x-ms-enum":{"name":"DisposableCertificateIdentificationType","modelAsString":false}},"PhoneNumber":{"description":"The phone number registered for identification.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"},"DocumentType":{"description":"The type of document used for the identification.","enum":["IdentityCard","DriverLicense","Passport","ResidencePermit","NationalElectronicIdentityCard","TemporaryResidencePermit","EmbassyDocument"],"type":"string"},"DocumentIssuedBy":{"description":"The authority that issued the document.","maxLength":500,"minLength":0,"type":"string"},"DocumentIssuedOn":{"format":"date","description":"The date when the document has been issued.\r\nA date in the format RFC 3339, section 5.6, 'full-date' (e.g. 2017-07-21).","maxLength":10,"minLength":10,"type":"string"},"DocumentExpiryDate":{"format":"date","description":"The expiration date of the document.\r\nA date in the format RFC 3339, section 5.6, 'full-date' (e.g. 2017-07-21).","maxLength":10,"minLength":10,"type":"string"},"SerialNumber":{"description":"The serial number of the certificate.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"description":"The identifier of the document.","maxLength":500,"minLength":0,"type":"string"}}},"EnvelopeBulkSendReadDocumentConfirmation":{"description":"The document which has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"}}},"EnvelopeBulkSendReadPagesConfirmation":{"description":"The page which has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"PageNumber":{"format":"int32","description":"The number of the page that needs to be read. Starting with 1.","type":"integer"},"GuidingOrder":{"description":"The order of the element.","type":"integer"}}},"EnvelopeBulkSendReadAreaConfirmation":{"description":"The area that has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"Definition":{"$ref":"#/definitions/EnvelopeBulkSendReadingAreaDefinition","description":"The definition of the area.\r\nWhen adding a new element, it has to be specified .\r\nWhen the field already exists, it must not be specified."}}},"EnvelopeBulkSendAttachment":{"description":"The configuration of the attachment element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"DisplayIconType":{"description":"The type of the displayed icon. If no icon is provided Paperclip will be used.","enum":["Paperclip","Graph","PushPin","Tag"],"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeBulkSendAttachmentDefinition","description":"The definition of the attachment element.\r\nIt must be specified when the attachment element is added.\r\nIt must not be specified when the attachment element already exists."}}},"EnvelopeBulkSendSignatureField":{"description":"The configuration of the signature field.","required":["ElementId","AllowedSignatureTypes"],"type":"object","properties":{"ElementId":{"description":"The identifier of the signature.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","maxLength":500,"minLength":0,"type":"string"},"FieldDescription":{"description":"The description of the signature.","maxLength":500,"minLength":0,"type":"string"},"UseExternalTimestampServer":{"description":"If true, a timestamp from an external server is embedded into the signature.","type":"boolean"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"AllowedSignatureTypes":{"$ref":"#/definitions/EnvelopeBulkSendAllowedSignatureTypes","description":"The allowed types for the signature."},"FieldDefinition":{"$ref":"#/definitions/EnvelopeBulkSendSignatureFieldDefinition","description":"The definition of the signature field.\r\nIt must be specified when the signature field is added.\r\nIt must not be specified when the signature field already exists."},"TaskConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendSignatureTaskConfiguration","description":"The configuration of the task."}}},"EnvelopeBulkSendEmailAppLinks":{"description":"Configure if links for our apps should be included in the recipient document signing request email message.","type":"object","properties":{"Android":{"description":"If true, an Android app link is added to the email message.","type":"boolean"},"iOS":{"description":"If true, an iOS app link is added to the email message.","type":"boolean"},"Windows":{"description":"If true, a Windows app link is added to the email message.","type":"boolean"}}},"EnvelopeBulkSendContactInformation":{"description":"Define the contact information for the recipient.","required":["Email","GivenName","Surname"],"type":"object","properties":{"Email":{"description":"The email address of the recipient.","maxLength":250,"minLength":0,"pattern":"^[a-zA-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF0-9.!#$%&'*+\\-\\/=?^_`{|}~]+@(?=[a-z0-9A-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF])(?:[a-z0-9A-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF]|(?<![.-])\\.|(?<!\\.)-)*[a-z0-9A-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF]$","type":"string"},"GivenName":{"description":"The given name of the recipient.","maxLength":200,"minLength":0,"type":"string"},"Surname":{"description":"The surname of the recipient.","maxLength":200,"minLength":0,"type":"string"},"PhoneNumber":{"description":"The phone number of the recipient.","maxLength":250,"minLength":0,"pattern":"^(\\+|00){1}\\(?([0-9]{2,})\\)?([\\-. ]?([0-9]{2,})){1,}$","type":"string"},"LanguageCode":{"description":"The language of the recipient.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string"}}},"EnvelopeBulkSendGeneralPoliciesForP7MAction":{"description":"Define the general policies allowed for P7M action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"},"AllowAdhocPdfAttachments":{"description":"If true, the client is allowed to append adhoc documents.","type":"boolean"},"AllowRejectWorkstep":{"description":"If true, the client is allowed to reject the workstep.","type":"boolean"},"AllowUndoLastAction":{"description":"If true, the client is allowed to undo actions.","type":"boolean"},"AllowDownloadOfSignedP7MFiles":{"description":"If true, the client is allowed to download signed p7m files.","type":"boolean"}}},"EnvelopeBulkSendP7MSignatureMethods":{"description":"The recipient configuration for signing with P7M.","type":"object","properties":{"LocalCertificate":{"description":"If true, a local certificate can be used.","type":"boolean"},"DisposableCertificate":{"$ref":"#/definitions/EnvelopeBulkSendDisposableCertificateSignatureData","description":"The disposable certificate configuration for the action."},"RemoteCertificate":{"$ref":"#/definitions/EnvelopeBulkSendRemoteCertificateSignatureData","description":"The remote certificate configuration for the action."},"SignaturePluginData":{"description":"The signature plugin configurations for the action.","maxItems":20,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendSignaturePluginSignatureData"}}}},"EnvelopeBulkSendGeneralPoliciesForViewAction":{"description":"Define the general policies allowed for view action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"}}},"EnvelopeBulkSendRecipientConfiguration":{"description":"The configuration of the recipient.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/EnvelopeBulkSendContactInformation","description":"The contact information of the recipient."},"PersonalMessage":{"description":"The personal message for the recipient.","maxLength":204800,"minLength":0,"type":"string"},"AuthenticationConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendAuthenticationConfiguration","description":"The configuration for the authentication of the recipient."},"SendEmails":{"description":"If true, emails will be sent out for this recipient.","type":"boolean"},"AllowAccessAfterFinish":{"description":"If true, the recipient is allowed to access the action after it has been finished.\r\nIt is required that the organization has the AllowAccessFinishedWorkstep feature enabled.\r\nThe default value is taken from the OrganizationSettings.","type":"boolean"}}},"EnvelopeBulkSendGeneralPoliciesForSignAction":{"description":"Define the general policies allowed for sign action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"},"AllowAdhocPdfAttachments":{"description":"If true, the client is allowed to append adhoc documents.","type":"boolean"},"AllowRejectWorkstep":{"description":"If true, the client is allowed to reject the workstep.","type":"boolean"},"AllowUndoLastAction":{"description":"If true, the client is allowed to undo actions.","type":"boolean"}}},"EnvelopeBulkSendAdvancedRecipientConfiguration":{"description":"The advanced configuration for the recipient.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/EnvelopeBulkSendContactInformation","description":"The contact information of the recipient."},"PersonalMessage":{"description":"The personal message for the recipient.","maxLength":204800,"minLength":0,"type":"string"},"AuthenticationConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendAuthenticationConfiguration","description":"The configuration for the authentication of the recipient."},"SendEmails":{"description":"If true, emails will be sent out for this recipient.","type":"boolean"},"AllowAccessAfterFinish":{"description":"If true, the recipient is allowed to access the action after it has been finished.\r\nIt is required that the organization has the AllowAccessFinishedWorkstep feature enabled.\r\nThe default value is taken from the OrganizationSettings.","type":"boolean"},"IncludedEmailAppLinks":{"$ref":"#/definitions/EnvelopeBulkSendEmailAppLinks","description":"The configuration for mobile app links in email messages."},"AllowDelegation":{"description":"If true, the recipient may delegate this activity to another person.","type":"boolean"},"RequireViewContentBeforeFormFilling":{"description":"If true, the signer has to confirm the reading of all documents as first task.","type":"boolean"}}},"EnvelopeBulkSendVisibleSignature":{"description":"A signature with a visual appearance on the document.","required":["FieldDefinition"],"type":"object","properties":{"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"UseExternalTimestampServer":{"description":"If true, a timestamp from an external server is embedded into the signature.","type":"boolean"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeBulkSendSignatureFieldDefinition","description":"The definition of the signature field.\r\nIt must be specified when the signature field is added.\r\nIt must not be specified when the signature field already exists."}}},"EnvelopeBulkSendRadioButtonItemDefinition":{"description":"The configuration of the radio button.","required":["Position","Size"],"type":"object","properties":{"ExportValue":{"description":"The value of the element when the radio button is checked.","maxLength":500,"minLength":0,"type":"string"},"IsChecked":{"description":"If true, the radio button is checked by default.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/EnvelopeBulkSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeBulkSendSize","description":"The size of the element."}}},"EnvelopeBulkSendTextFormat":{"description":"The configuration of the text format.","required":["FontSizeInPt","FontName"],"type":"object","properties":{"TextColor":{"description":"The color of the text. The default color is black.\r\nSix digit hexadecimal color that starts with # in #RRGGBB format according to CSS Color Module Level 4, paragraph 5.2.","maxLength":7,"minLength":7,"type":"string"},"FontSizeInPt":{"description":"The size of the font in points.","type":"number"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","maxLength":500,"minLength":0,"type":"string"},"Bold":{"description":"If true, the bold font is used.","type":"boolean"},"Italic":{"description":"If true, the italic font is used.","type":"boolean"},"TextAlign":{"description":"The alignment of the text. The default alignment is left.","enum":["Left","Center","Right"],"type":"string"}}},"EnvelopeBulkSendPhoneValidationConfiguration":{"description":"The validation rules for phone numbers.","type":"object","properties":{"Type":{"description":"The format of the phone numbers.","enum":["International","InternationalLeadingZeros","InternationalLeadingPlus"],"type":"string"}}},"EnvelopeBulkSendNumberValidationConfiguration":{"description":"The validation rules for numbers.","type":"object","properties":{"DecimalDigits":{"description":"The expected amount of decimal digits.","type":"integer"},"Symbol":{"description":"The expected symbol.","maxLength":5,"minLength":0,"type":"string"},"SymbolLocation":{"description":"The defined symbol location.","enum":["Start","StartWithBlank","End","EndWithBlank"],"type":"string"},"GroupSeparator":{"description":"The expected thousands separator.","enum":["Comma","Point","Apostrophe","Blank","None"],"type":"string"},"DecimalSeparator":{"description":"The expected decimal separator.","enum":["Comma","Point","Apostrophe","None"],"type":"string","x-ms-enum":{"name":"DecimalSeparatorType","modelAsString":false}},"Range":{"$ref":"#/definitions/EnvelopeBulkSendFieldValidationRange","description":"The range of the values."}}},"EnvelopeBulkSendActionCallbackSelection":{"description":"The selection of events which trigger the callback.","type":"object","properties":{"ConfirmTransactionCode":{"description":"If true, the callback is triggered when a transaction code was sent. This is only used for legacy disposable certificates, after user accepted issuance of disposable certificate.","type":"boolean"},"AgreementAccepted":{"description":"If true, the callback is triggered when the user accepted the agreement.","type":"boolean"},"AgreementRejected":{"description":"If true, the callback is triggered when the user rejected the agreement.","type":"boolean"},"PrepareAuthenticationSuccess":{"description":"If true, the callback is triggered when the preparation of the authentication process succeeded.","type":"boolean"},"AuthenticationFailed":{"description":"If true, the callback is triggered when the user failed to authenticate.","type":"boolean"},"AuthenticationSuccess":{"description":"If true, the callback is triggered when the user succeeded to authenticate.","type":"boolean"},"AuditTrailRequested":{"description":"If true, the callback is triggered when the audit trail was requested.","type":"boolean"},"AuditTrailXmlRequested":{"description":"If true, the callback is triggered when the audit trail XML was requested.","type":"boolean"},"CalledPage":{"description":"If true, the callback is triggered when the SignAnyWhere Viewer was requested.","type":"boolean"},"DocumentDownloaded":{"description":"If true, the callback is triggered when the document download was requested.","type":"boolean"},"FlattenedDocumentDownloaded":{"description":"If true, the callback is triggered when the flattened document download was requested.","type":"boolean"},"AddedAnnotation":{"description":"If true, the callback is triggered when an annotation was added.","type":"boolean"},"AddedAttachment":{"description":"If true, the callback is triggered when an attachment was added.","type":"boolean"},"AppendedDocument":{"description":"If true, the callback is triggered when a document was appended.","type":"boolean"},"FormsFilled":{"description":"If true, the callback is triggered when a form field was filled.","type":"boolean"},"ConfirmReading":{"description":"If true, the callback is triggered when a reading task was completed.","type":"boolean"},"SendTransactionCode":{"description":"If true, the callback is triggered when a transaction code for a signature with type TransactionCode was sent using the TransactionCodeSenderPlugin.","type":"boolean"},"PrepareSignWorkstepDocument":{"description":"If true, the callback is triggered when a signature was prepared for signing.","type":"boolean"},"SignWorkstepDocument":{"description":"If true, the callback is triggered when a signature was applied.","type":"boolean"},"UndoAction":{"description":"If true, the callback is triggered when an action was undone.","type":"boolean"},"WorkstepCreated":{"description":"If true, the callback is triggered when a workstep was created.","type":"boolean"},"WorkstepFinished":{"description":"If true, the callback is triggered when a workstep was finished.","type":"boolean"},"WorkstepRejected":{"description":"If true, the callback is triggered when a workstep was rejected.","type":"boolean"},"DisablePolicyAndValidityChecks":{"description":"If true, the callback is triggered when policy and validity checks were disabled.","type":"boolean"},"EnablePolicyAndValidityChecks":{"description":"If true, the callback is triggered when policy and validity checks were enabled.","type":"boolean"},"AppendFileToWorkstep":{"description":"If true, the callback is triggered when a file was appended to the workstep.","type":"boolean"},"AppendTasksToWorkstep":{"description":"If true, the callback is triggered when a task was added to the workstep.","type":"boolean"},"SetOptionalDocumentState":{"description":"If true, the callback is triggered when an optional document became either active or inactive.","type":"boolean"},"PreparePayloadForBatch":{"description":"If true, the callback is triggered when the payload was prepared for batch signing.","type":"boolean"}}},"EnvelopeBulkSendSignBulk":{"description":"A sign action for multiple recipients.","required":["BulkRecipients"],"type":"object","properties":{"BulkRecipients":{"description":"The recipients that are part of the bulk.","maxItems":1000,"minItems":1,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendRecipient"}},"SequenceMode":{"description":"The sequence mode.","enum":["NoSequenceEnforced","SequenceEnforced"],"type":"string"},"Elements":{"$ref":"#/definitions/EnvelopeBulkSendElements","description":"The elements in the document (e.g. form fields) assigned to the recipient."},"FinishActionConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendFinishAction","description":"Defines what happens in the signing clients, after an action has been finished."},"BatchConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendBatchConfiguration","description":"The configuration of a signing batch."},"GeneralPoliciesOverrides":{"$ref":"#/definitions/EnvelopeBulkSendGeneralPoliciesForSignAction","description":"Viewer policy settings for override."}}},"EnvelopeBulkSendSign":{"description":"A sign action for the recipient.","required":["RecipientConfiguration"],"type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"SequenceMode":{"description":"The sequence mode.","enum":["NoSequenceEnforced","SequenceEnforced"],"type":"string"},"Elements":{"$ref":"#/definitions/EnvelopeBulkSendElements","description":"The elements in the document (e.g. form fields) assigned to the recipient."},"FinishActionConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendFinishAction","description":"Defines what happens in the signing clients, after an action has been finished."},"SignatureDataConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendSignatureDataConfiguration","description":"The configuration of recipient data for special signatures."},"BatchConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendBatchConfiguration","description":"The configuration of a signing batch."},"GeneralPoliciesOverrides":{"$ref":"#/definitions/EnvelopeBulkSendGeneralPoliciesForSignAction","description":"Viewer policy settings for override."}}},"EnvelopeBulkSendSignAutomatic":{"description":"An automatic signing action.","required":["ProfileId"],"type":"object","properties":{"ProfileId":{"description":"The identifier of the profile for the automatic signatures.","maxLength":500,"minLength":0,"type":"string"},"RenderingLanguageCode":{"description":"The rendering language for the automatic signatures.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string"},"VisibleSignatures":{"description":"The visible signatures define the optional visual representations for automatic signatures.\r\nIf none are defined, the automatic signatures are applied to the documents without a visual element.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendVisibleSignature"}}}},"EnvelopeBulkSendListBoxDefinition":{"description":"The configuration of the combo box.","required":["Items","Position","Size"],"type":"object","properties":{"TextFormat":{"$ref":"#/definitions/EnvelopeBulkSendTextFormat","description":"The configuration of the text format."},"Items":{"description":"A list of items that can be selected for the element.","maxItems":50,"minItems":1,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendChoiceItem"}},"IsMultiSelect":{"description":"If true, multiple values of the list box can be selected.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/EnvelopeBulkSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeBulkSendSize","description":"The size of the element."}}},"EnvelopeBulkSendRadioButtonGroupDefinition":{"description":"The configuration of the radio button group definition.","type":"object","properties":{"IsSelectUnison":{"description":"If true, radiobuttons with the same <code>ExportValue<\/code> are checked and unchecked together.","type":"boolean"},"Items":{"description":"The list of radio buttons that belong to the same group.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendRadioButtonItemDefinition"}}}},"EnvelopeBulkSendComboBoxDefinition":{"description":"The configuration of the combo box.","required":["Items","Position","Size"],"type":"object","properties":{"TextFormat":{"$ref":"#/definitions/EnvelopeBulkSendTextFormat","description":"The configuration of the text format."},"Items":{"description":"A list of items that can be selected for the element.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendChoiceItem"}},"IsEditable":{"description":"If true, the combo box is editable.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/EnvelopeBulkSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeBulkSendSize","description":"The size of the element."}}},"EnvelopeBulkSendCheckBoxDefinition":{"description":"The configuration of a check box.","required":["Position","Size"],"type":"object","properties":{"ExportValue":{"description":"The value of the check box when it is checked.","maxLength":500,"minLength":0,"type":"string"},"Position":{"$ref":"#/definitions/EnvelopeBulkSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeBulkSendSize","description":"The size of the element."},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"}}},"EnvelopeBulkSendTextBoxDefinition":{"description":"The configuration of the text box.","required":["Position","Size"],"type":"object","properties":{"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"MaxLength":{"description":"The maximum length of the text.","type":"integer"},"IsMultiline":{"description":"If true, the text box can have multiple lines.","type":"boolean"},"IsPassword":{"description":"If true, the text box behaves like a password input field and does not show the actually entered characters.","type":"boolean"},"TextFormat":{"$ref":"#/definitions/EnvelopeBulkSendTextFormat","description":"The configuration of the text format."},"Position":{"$ref":"#/definitions/EnvelopeBulkSendPosition","description":"The position of the element within the document."},"Size":{"$ref":"#/definitions/EnvelopeBulkSendSize","description":"The size of the element."}}},"EnvelopeBulkSendListBox":{"description":"The configuration of the list box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"PreSelectedItems":{"description":"The export values of the items which should be initially selected.","maxItems":50,"type":"array","items":{"maxLength":500,"type":"string"}},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeBulkSendListBoxDefinition","description":"The definition of the list box field.\r\nIt must be specified when the list box is added.\r\nIt must not be specified when the list box already exists."}}},"EnvelopeBulkSendRadioButtonGroup":{"description":"The configuration of the radio button group.","type":"object","properties":{"GroupName":{"description":"The name of the radio button group.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"SelectedItem":{"description":"The export value of the selected item of the radio button group.","maxLength":500,"minLength":0,"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeBulkSendRadioButtonGroupDefinition","description":"The definition of the radio button group.\r\nIt must be specified when the radio button group is added.\r\nIt must not be specified when the radio button group already exists."}}},"EnvelopeBulkSendComboBox":{"description":"The configuration of the combo box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"Value":{"description":"The selected value of the combo box.","maxLength":500,"minLength":0,"type":"string"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeBulkSendComboBoxDefinition","description":"The definition of the combo box.\r\nIt must be specified when the combo box is added.\r\nIt must not be specified when the combo box already exists."}}},"EnvelopeBulkSendCheckBox":{"description":"The configuration of the check box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"IsChecked":{"description":"If true, the check box is checked.","type":"boolean"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/EnvelopeBulkSendCheckBoxDefinition","description":"The definition of the check box.\r\nIt must be specified when the check box is added.\r\nIt must not be specified when the check box already exists."}}},"EnvelopeBulkSendTextBox":{"description":"The configuration of the text box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","maxLength":500,"minLength":0,"type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"Value":{"description":"The value of the text box.","maxLength":204800,"minLength":0,"type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"GuidingOrder":{"description":"The order of the element.","type":"integer"},"Validation":{"$ref":"#/definitions/EnvelopeBulkSendFieldValidation","description":"The configuration of the validation rules for the text box value."},"FieldDefinition":{"$ref":"#/definitions/EnvelopeBulkSendTextBoxDefinition","description":"The definition of the text box.\r\nIt must be specified when the check box is added.\r\nIt must not be specified when the check box already exists."}}},"EnvelopeBulkSendCallbackConfiguration":{"description":"The configuration of the callbacks for a custom integration.","type":"object","properties":{"CallbackUrl":{"description":"The callback URL triggered when the envelope has been finished.","maxLength":8000,"minLength":0,"type":"string"},"StatusUpdateCallbackUrl":{"description":"The callback URL triggered for status updates of an envelope.","maxLength":8000,"minLength":0,"type":"string"},"ActivityActionCallbackConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendActivityActionCallbackConfiguration","description":"The configuration of the callback for workstep events."}}},"EnvelopeBulkSendExpirationConfiguration":{"description":"The configuration of the expiration for the envelope.","type":"object","properties":{"ExpirationInSecondsAfterSending":{"description":"The relative expiration in seconds after sending the envelope.\r\nMust be a positive number between 600 and the maximum envelope validity located in the system configuration [Configuration key: maxEnvelopeValidityInDays, Default: 2419200 seconds (28 days)].\r\nMust not be defined when property <code>ExpirationDate<\/code> is specified.","type":"integer"},"ExpirationDate":{"format":"date-time","description":"The absolute expiration date of the envelope.\r\nMust not be in the past.\r\nMust not be defined when property <code>ExpirationInSecondsAfterSending<\/code> is specified.\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","maxLength":30,"minLength":20,"type":"string"}}},"EnvelopeBulkSendReminderConfiguration":{"description":"The configuration for reminders.","type":"object","properties":{"Enabled":{"description":"If true, reminders are sent.","type":"boolean"},"FirstReminderInDays":{"description":"The amount of days until a reminder is sent to a signer or a viewer after the initial notification.","type":"integer"},"ReminderResendIntervalInDays":{"description":"The amount of days until a reminder is sent again to a signer or a viewer.","type":"integer"},"BeforeExpirationInDays":{"description":"The amount of days before the envelope expires and a reminder should be sent.","type":"integer"}}},"EnvelopeBulkSendRequest":{"description":"The request model for sending an envelope bulk.","required":["Documents","Name","Activities"],"type":"object","properties":{"Documents":{"description":"The documents for the envelope.","maxItems":50,"minItems":1,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendDocument"}},"Name":{"description":"The name of the envelope.","maxLength":100,"minLength":0,"type":"string"},"MetaData":{"description":"The metadata of the envelope.","maxLength":204800,"minLength":0,"type":"string"},"AddDocumentTimestamp":{"description":"If true, a timestamp is added to all documents of the envelope at the end of each signing activity.","type":"boolean"},"ShareWithTeam":{"description":"If true, this envelope is shared with your teams.","type":"boolean"},"LockFormFieldsOnFinish":{"description":"If true, form fields are locked after the envelope is finished.","type":"boolean"},"UnassignedElements":{"$ref":"#/definitions/EnvelopeBulkSendUnassignedElements","description":"The elements which are not assigned to any action."},"Activities":{"description":"The steps for the envelope.","maxItems":50,"minItems":1,"type":"array","items":{"$ref":"#/definitions/EnvelopeBulkSendActivity"}},"EmailConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendEmailConfiguration","description":"The configuration for notifications."},"ReminderConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendReminderConfiguration","description":"The configuration for reminders."},"ExpirationConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendExpirationConfiguration","description":"The configuration of the expiration for the envelope."},"CallbackConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendCallbackConfiguration","description":"The configuration of the callbacks for a custom integration."},"AgreementConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendAgreementConfiguration","description":"The configuration of the agreement.\r\nRequires that the organization allows custom agreement settings."},"SealingConfiguration":{"$ref":"#/definitions/EnvelopeBulkSendSealingConfiguration","description":"The custom sealing configuration for the envelope."}}},"EnvelopeBulkCancelRequest":{"description":"The request model for canceling all active BulkChild envelope.","required":["EnvelopeBulkId"],"type":"object","properties":{"EnvelopeBulkId":{"description":"The identifier of the BulkParent envelope.","maxLength":36,"minLength":36,"type":"string"}}},"EnvelopeBulkDeleteRequest":{"description":"The request model for deleting an envelope bulk.","required":["EnvelopeBulkId"],"type":"object","properties":{"EnvelopeBulkId":{"description":"The identifier of the BulkParent envelope.","maxLength":36,"minLength":36,"type":"string"}}},"EnvelopeBulkRemindRequest":{"description":"The request model for sending reminder notifications for all active BulkChild envelope.","required":["EnvelopeBulkId"],"type":"object","properties":{"EnvelopeBulkId":{"description":"The identifier of the BulkParent envelope.","maxLength":36,"minLength":36,"type":"string"}}},"EnvelopeBulkRemindResponse":{"description":"The response model after sending reminder notifications.","type":"object","properties":{"TotalSentReminders":{"format":"int32","description":"The amount of reminder notifications which were sent out.","type":"integer"},"TotalBlockedByRateLimit":{"format":"int32","description":"The amount of skipped reminder notifications due to rate limit.","type":"integer"},"TotalBlockedByDisabledEmail":{"format":"int32","description":"The amount of skipped reminder notifications due to disabled notification sending for the recipient.","type":"integer"},"TotalBlockedByNotificationSetting":{"format":"int32","description":"The amount of skipped reminder notifications due to disabled notifications by the user.","type":"integer"}}},"EnvelopeBulkRestartExpiredRequest":{"description":"The request model for restarting all expired BulkChild envelopes.","required":["EnvelopeBulkId"],"type":"object","properties":{"EnvelopeBulkId":{"description":"The identifier of the BulkParent envelope.","maxLength":36,"minLength":36,"type":"string"},"ExpirationInSecondsAfterSending":{"description":"The relative expiration in seconds after sending the envelope.\r\nMust be a positive number between 600 and the maximum envelope validity located in the system configuration [Configuration key: maxEnvelopeValidityInDays, Default: 2419200 seconds (28 days)].\r\nMust not be defined when property <code>ExpirationDate<\/code> is specified.","type":"integer"},"ExpirationDate":{"format":"date-time","description":"The absolute expiration date of the envelope.\r\nMust not be in the past.\r\nMust not be defined when property <code>ExpirationInSecondsAfterSending<\/code> is specified.\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","maxLength":30,"minLength":20,"type":"string"}}},"FileDeleteRequest":{"description":"The request model to delete an uploaded file.","required":["FileId"],"type":"object","properties":{"FileId":{"description":"The identifier of the file.","maxLength":36,"minLength":36,"type":"string"}}},"FileUploadResponse":{"description":"The response model after a file was successfully uploaded.","type":"object","properties":{"FileId":{"description":"The identifier of the file.","type":"string"}}},"FilePrepareRequest":{"description":"The request model for parsing documents.","required":["FileIds"],"type":"object","properties":{"FileIds":{"description":"The identifiers of the uploaded files.","maxItems":50,"minItems":1,"type":"array","items":{"maxLength":36,"minLength":36,"type":"string"}},"ClearAdvancedDocumentTags":{"description":"If true, the parsed advanced document tags are deleted from the document.","type":"boolean"},"SigStringConfigurations":{"description":"The configurations for the parsing of SigString. The default [`sig`] is always added.","maxItems":50,"type":"array","items":{"$ref":"#/definitions/FilePrepareSigStringConfiguration"}}}},"FilePrepareSigStringConfiguration":{"description":"The configuration for parsing of a SigString.","required":["StartPattern"],"type":"object","properties":{"StartPattern":{"description":"Define the start pattern.","maxLength":500,"minLength":0,"type":"string"},"EndPattern":{"description":"Define the end pattern.","maxLength":500,"minLength":0,"type":"string"},"ClearSigString":{"description":"If true, the parsed SigString is deleted from the document","type":"boolean"},"SearchEntireWordOnly":{"description":"If true, the patterns are only matched as a whole word.","type":"boolean"}}},"FilePrepareResponse":{"description":"The response model after parsing the pdf file.","type":"object","properties":{"UnassignedElements":{"$ref":"#/definitions/FilePrepareElements","description":"The elements which are not assigned to any action."},"Activities":{"description":"The steps for the envelope.\r\nOne activity may contain elements from multiple documents assigned to the same recipient.\r\nThe activities will only be generated for advanced document tags.","type":"array","items":{"$ref":"#/definitions/FilePrepareActivity"}}}},"FilePrepareElements":{"description":"The configurable elements of the documents.","type":"object","properties":{"TextBoxes":{"description":"The text boxes.","type":"array","items":{"$ref":"#/definitions/FilePrepareTextBox"}},"CheckBoxes":{"description":"The check boxes.","type":"array","items":{"$ref":"#/definitions/FilePrepareCheckBox"}},"ComboBoxes":{"description":"The combo boxes.","type":"array","items":{"$ref":"#/definitions/FilePrepareComboBox"}},"RadioButtons":{"description":"The radio buttons.","type":"array","items":{"$ref":"#/definitions/FilePrepareRadioButtonGroup"}},"ListBoxes":{"description":"The list boxes.","type":"array","items":{"$ref":"#/definitions/FilePrepareListBox"}},"Signatures":{"description":"The signatures.","type":"array","items":{"$ref":"#/definitions/FilePrepareSignatureField"}},"Attachments":{"description":"The attachments.","type":"array","items":{"$ref":"#/definitions/FilePrepareAttachment"}},"LinkConfiguration":{"$ref":"#/definitions/FilePrepareLinkConfiguration","description":"The links in the documents."}}},"FilePrepareActivity":{"description":"Defines an activity in the process.","type":"object","properties":{"Action":{"$ref":"#/definitions/FilePrepareAction","description":"The action assigned to the activity."}}},"FilePrepareTextBox":{"description":"The configuration of the text box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"Value":{"description":"The value of the text box.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"Validation":{"$ref":"#/definitions/FilePrepareFieldValidation","description":"The configuration of the validation rules for the text box value."},"FieldDefinition":{"$ref":"#/definitions/FilePrepareTextBoxDefinition","description":"The definition of the text box."}}},"FilePrepareCheckBox":{"description":"The configuration of the check box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"IsChecked":{"description":"If true, the check box is checked.","type":"boolean"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/FilePrepareCheckBoxDefinition","description":"The definition of the check box."}}},"FilePrepareComboBox":{"description":"The configuration of the combo box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"Value":{"description":"The selected value of the combo box.","type":"string"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/FilePrepareComboBoxDefinition","description":"The definition of the combo box."}}},"FilePrepareRadioButtonGroup":{"description":"The configuration of the radio button group.","type":"object","properties":{"GroupName":{"description":"The name of the radio button group.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"SelectedItem":{"description":"The export value of the selected item of the radio button group.","type":"string"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/FilePrepareRadioButtonDefinition","description":"The definition of the radio button group."}}},"FilePrepareListBox":{"description":"The configuration of the list box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"PreSelectedItems":{"description":"The export values of the items which should be initially selected.","type":"array","items":{"type":"string"}},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/FilePrepareListBoxDefinition","description":"The definition of the list box field."}}},"FilePrepareSignatureField":{"description":"The configuration of the signature field.","type":"object","properties":{"ElementId":{"description":"The identifier of the signature.","type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","type":"string"},"FieldDescription":{"description":"The description of the signature.","type":"string"},"UseExternalTimestampServer":{"description":"If true, an timestamp from an external server is embedded into the signature.","type":"boolean"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"AllowedSignatureTypes":{"$ref":"#/definitions/FilePrepareAllowedSignatureTypes","description":"The allowed types for the signature."},"FieldDefinition":{"$ref":"#/definitions/FilePrepareSignatureFieldDefinition","description":"The definition of the signature field."},"TaskConfiguration":{"$ref":"#/definitions/FilePrepareSignatureTaskConfiguration","description":"The configuration of the task."}}},"FilePrepareAttachment":{"description":"The configuration of the attachment element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DisplayName":{"description":"The displayed name.","type":"string"},"DisplayIconType":{"description":"The type of the displayed icon.","enum":["Paperclip","Graph","PushPin","Tag"],"type":"string"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/FilePrepareAttachmentDefinition","description":"The definition of the attachment element."}}},"FilePrepareLinkConfiguration":{"description":"The configuration of the link elements.","type":"object","properties":{"HyperLinks":{"description":"The list of hyperlink elements.","type":"array","items":{"$ref":"#/definitions/FilePrepareHyperLink"}}}},"FilePrepareAction":{"description":"The action of the activity.","type":"object","properties":{"SignAutomatic":{"$ref":"#/definitions/FilePrepareSignAutomatic","description":"The definition of the automatic sign action."},"Sign":{"$ref":"#/definitions/FilePrepareSign","description":"The definition of the sign action."}}},"FilePrepareFieldValidation":{"description":"The configuration of the field validation rules.","type":"object","properties":{"Type":{"description":"The type of the value.","enum":["None","Date","Email","Number","Phone","Time"],"type":"string","x-ms-enum":{"name":"FieldValidationType","modelAsString":false}},"DateValidationConfiguration":{"$ref":"#/definitions/FilePrepareDateValidationConfiguration","description":"The validation rules for dates."},"NumberValidationConfiguration":{"$ref":"#/definitions/FilePrepareNumberValidationConfiguration","description":"The validation rules for numbers."},"PhoneValidationConfiguration":{"$ref":"#/definitions/FilePreparePhoneValidationConfiguration","description":"The validation rules for phone numbers."},"TimeValidationConfiguration":{"$ref":"#/definitions/FilePrepareTimeValidationConfiguration","description":"The validation rules for time values."}}},"FilePrepareTextBoxDefinition":{"description":"The configuration of the text box.","type":"object","properties":{"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"MaxLength":{"format":"int32","description":"The maximum length of the text.","type":"integer"},"IsMultiline":{"description":"If true, the text box can have multiple lines.","type":"boolean"},"IsPassword":{"description":"If true, the text box behaves like a password input field and does not show the actually entered characters.","type":"boolean"},"TextFormat":{"$ref":"#/definitions/FilePrepareTextFormat","description":"The configuration of the text format."},"Position":{"$ref":"#/definitions/FilePreparePosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/FilePrepareSize","description":"The size of the form field."}}},"FilePrepareCheckBoxDefinition":{"description":"The configuration of a check box.","type":"object","properties":{"ExportValue":{"description":"The value of the check box when it is checked.","type":"string"},"Position":{"$ref":"#/definitions/FilePreparePosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/FilePrepareSize","description":"The size of the form field."},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"}}},"FilePrepareComboBoxDefinition":{"description":"The configuration of the combo box.","type":"object","properties":{"TextFormat":{"$ref":"#/definitions/FilePrepareTextFormat","description":"The configuration of the text format."},"Items":{"description":"A list of items that can be selected for the element.","type":"array","items":{"$ref":"#/definitions/FilePrepareChoiceItem"}},"IsEditable":{"description":"If true, the combo box is editable.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/FilePreparePosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/FilePrepareSize","description":"The size of the form field."}}},"FilePrepareRadioButtonDefinition":{"description":"The configuration of the radio button group definition.","type":"object","properties":{"IsSelectUnison":{"description":"If true, radio buttons with the same <code>ExportValue<\/code> are checked and unchecked together.","type":"boolean"},"Items":{"description":"The list of radiobuttons that belong to the same group.","type":"array","items":{"$ref":"#/definitions/FilePrepareRadioButtonItemDefinition"}}}},"FilePrepareListBoxDefinition":{"description":"The configuration of the combo box.","type":"object","properties":{"TextFormat":{"$ref":"#/definitions/FilePrepareTextFormat","description":"The configuration of the text format."},"Items":{"description":"A list of items that can be selected for the element.","type":"array","items":{"$ref":"#/definitions/FilePrepareChoiceItem"}},"IsMultiSelect":{"description":"If true, multiple values of the list box can be selected.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/FilePreparePosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/FilePrepareSize","description":"The size of the form field."}}},"FilePrepareAllowedSignatureTypes":{"description":"The definition of the allowed signature types for the signature.","type":"object","properties":{"ClickToSign":{"$ref":"#/definitions/FilePrepareClickToSignSignatureType","description":"Allow signing with \"click to sign\"."},"DrawToSign":{"$ref":"#/definitions/FilePrepareDrawToSignSignatureType","description":"Allow signing with \"draw to sign\"."},"TypeToSign":{"$ref":"#/definitions/FilePrepareTypeToSignSignatureType","description":"Allow signing with \"type to sign\"."},"LocalCertificate":{"$ref":"#/definitions/FilePrepareLocalCertificateSignatureType","description":"Allow signing with a local certificate."},"DisposableCertificate":{"$ref":"#/definitions/FilePrepareDisposableCertificateSignatureType","description":"Allow signing with a disposable certificate."},"SwissComOnDemand":{"$ref":"#/definitions/FilePrepareSwissComOnDemandSignatureType","description":"Allow signing with a Swisscom On-Demand certificate."},"ATrustCertificate":{"$ref":"#/definitions/FilePrepareATrustCertificateSignatureType","description":"Allow signing with an A-Trust certificate."},"Biometric":{"$ref":"#/definitions/FilePrepareBiometricSignatureType","description":"Allow signing with a biometric signature."},"RemoteCertificate":{"$ref":"#/definitions/FilePrepareRemoteCertificateSignatureType","description":"Allow signing with a remote certificate."},"OneTimePassword":{"$ref":"#/definitions/FilePrepareOneTimePasswordSignatureType","description":"Allow signing with a one time password (SMS-OTP)."},"SwedishBankId":{"$ref":"#/definitions/FilePrepareSwedishBankIdSignatureType","description":"Allow signing with Swedish BankID."},"SignaturePlugins":{"description":"Allow signing with signature plugins.","type":"array","items":{"$ref":"#/definitions/FilePrepareSignaturePluginSignatureType"}}}},"FilePrepareSignatureFieldDefinition":{"description":"The settings of a positionable element.","type":"object","properties":{"Position":{"$ref":"#/definitions/FilePreparePosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/FilePrepareSize","description":"The size of the form field."}}},"FilePrepareSignatureTaskConfiguration":{"description":"The configuration of the signature task.","type":"object","properties":{"StampImprintDateConfiguration":{"$ref":"#/definitions/FilePrepareStampImprintDateConfiguration","description":"The configuration of the stamp imprint date."},"BatchGroup":{"description":"The batch group.","type":"string"}}},"FilePrepareAttachmentDefinition":{"description":"The settings of a positionable element.","type":"object","properties":{"Position":{"$ref":"#/definitions/FilePreparePosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/FilePrepareSize","description":"The size of the form field."}}},"FilePrepareHyperLink":{"description":"The definition of the hyperlink element.","type":"object","properties":{"Id":{"description":"The identifier of the hyperlink.","type":"string"},"Uri":{"description":"The URI of the hyperlink.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/FilePrepareLinkDefinition","description":"The definition of the hyperlink element."}}},"FilePrepareSignAutomatic":{"description":"An automatic signing action.","type":"object","properties":{"VisibleSignatures":{"description":"The visible signatures define the optional visual representations for automatic signatures.\r\nIf none are defined, the automatic signatures are applied to the documents without a visual element.","type":"array","items":{"$ref":"#/definitions/FilePrepareVisibleSignature"}}}},"FilePrepareSign":{"description":"The elements, which are assigned to actions.","type":"object","properties":{"Elements":{"$ref":"#/definitions/FilePrepareElements","description":"The definition of the assigned elements."}}},"FilePrepareDateValidationConfiguration":{"description":"The validation rules for dates.","type":"object","properties":{"DateFormat":{"description":"The format of the dates.","type":"string"},"Range":{"$ref":"#/definitions/FilePrepareFieldValidationRange","description":"The range of the values."}}},"FilePrepareNumberValidationConfiguration":{"description":"The validation rules for numbers.","type":"object","properties":{"DecimalDigits":{"format":"int32","description":"The expected amount of decimal digits.","type":"integer"},"Symbol":{"description":"The expected symbol.","type":"string"},"SymbolLocation":{"description":"The defined symbol location.","enum":["Start","StartWithBlank","End","EndWithBlank"],"type":"string","x-ms-enum":{"name":"SymbolLocationType","modelAsString":false}},"GroupSeparator":{"description":"The expected thousands separator.","enum":["Comma","Point","Apostrophe","Blank","None"],"type":"string"},"DecimalSeparator":{"description":"The expected decimal separator.","enum":["Comma","Point","Apostrophe","None"],"type":"string","x-ms-enum":{"name":"DecimalSeparatorType","modelAsString":false}},"Range":{"$ref":"#/definitions/FilePrepareFieldValidationRange","description":"The range of the values."}}},"FilePreparePhoneValidationConfiguration":{"description":"The validation rules for phone numbers.","type":"object","properties":{"Type":{"description":"The format of the phone numbers.","enum":["International","InternationalLeadingZeros","InternationalLeadingPlus"],"type":"string","x-ms-enum":{"name":"PhoneType","modelAsString":false}}}},"FilePrepareTimeValidationConfiguration":{"description":"The validation rules for time values.","type":"object","properties":{"TimeFormat":{"description":"The format of the time values.","type":"string"},"Range":{"$ref":"#/definitions/FilePrepareFieldValidationRange","description":"The range of the values."}}},"FilePrepareTextFormat":{"description":"The configuration of the text format.","type":"object","properties":{"TextColor":{"description":"The color of the text.\r\nSix digit hexadecimal color starting with # in #RRGGBB format according to CSS Color Module Level 4, paragraph 5.2.","type":"string"},"FontSizeInPt":{"format":"double","description":"The size of the font in points.","type":"number"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"Bold":{"description":"If true, the bold font is used.","type":"boolean"},"Italic":{"description":"If true, the italic font is used.","type":"boolean"},"TextAlign":{"description":"The alignment of the text. The default alignment is left.","enum":["Left","Center","Right"],"type":"string","x-ms-enum":{"name":"TextAlignment","modelAsString":false}}}},"FilePreparePosition":{"description":"The position of an element on the document.","type":"object","properties":{"PageNumber":{"format":"int32","description":"The number of the page where the element is located. It starts with 1.","type":"integer"},"X":{"format":"double","description":"The X coordinate in points. It starts from the left.","type":"number"},"Y":{"format":"double","description":"The Y coordinate in points. It starts from the bottom.","type":"number"}}},"FilePrepareSize":{"description":"The definition of the size of an element.","type":"object","properties":{"Width":{"format":"double","description":"The width of the element in points.","type":"number"},"Height":{"format":"double","description":"The height of the element in points.","type":"number"}}},"FilePrepareChoiceItem":{"description":"The configuration of the choice item.","type":"object","properties":{"ExportValue":{"description":"The value of the element when the choice item is selected.","type":"string"},"DisplayValue":{"description":"The displayed value of the choice item.","type":"string"}}},"FilePrepareRadioButtonItemDefinition":{"description":"The configuration of the radio button.","type":"object","properties":{"ExportValue":{"description":"The value of the element when the radio button is checked.","type":"string"},"IsChecked":{"description":"If true, the radio button is checked by default.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/FilePreparePosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/FilePrepareSize","description":"The size of the form field."}}},"FilePrepareClickToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/FilePrepareClickToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"FilePrepareDrawToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/FilePrepareDrawToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"FilePrepareTypeToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/FilePrepareTypeToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"FilePrepareLocalCertificateSignatureType":{"description":"The configuration of the LocalCertificate signature.","type":"object","properties":{"EnforcePreferredHashAlgorithm":{"description":"If true, the usage of the preferred hash algorithm is enforced.","type":"boolean"},"PreferredHashAlgorithm":{"description":"The preferred hash algorithm.","enum":["Sha256","Sha512"],"type":"string"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/FilePrepareLocalCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"FilePrepareDisposableCertificateSignatureType":{"description":"The configuration of the DisposableCertificate signature.","type":"object","properties":{"IsLongLived":{"description":"If true, the disposable certificate is long lived.","type":"boolean"},"ValidityInSeconds":{"format":"int32","description":"The validity of the certificate in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/FilePrepareDisposableCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"FilePrepareSwissComOnDemandSignatureType":{"description":"The configuration of the Swisscom On-Demand signature.","type":"object","properties":{"ValidityInSeconds":{"format":"int32","description":"The certificate validity in seconds.","type":"integer"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/FilePrepareSwissComOnDemandStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"FilePrepareATrustCertificateSignatureType":{"description":"The configuration of the A-Trust certificate signature.","type":"object","properties":{"TemplateId":{"description":"The identifier of the A-Trust template.","type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"}}},"FilePrepareBiometricSignatureType":{"description":"The configuration of the Biometric signature.","type":"object","properties":{"BiometricVerification":{"description":"If true, a biometric verification is performed.","type":"boolean"},"AllowBiometricStoringOnly":{"description":"If true, the biometric signature might be stored without verification.","type":"boolean"},"StoreSignedResponseWithoutBioData":{"description":"If true, the signed response is stored without biometric data.","type":"boolean"},"BiometricServerUserId":{"description":"The identifier of the user on the biometric server.","type":"string"},"SignaturePositioning":{"description":"The allowed positioning of the biometric signature.","enum":["WithinField","OnPage","IntersectsWithField"],"type":"string","x-ms-enum":{"name":"BiometricSignaturePositioning","modelAsString":false}},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"}}},"FilePrepareRemoteCertificateSignatureType":{"description":"The configuration of the RemoteCertificate signature.","type":"object","properties":{"ValidityInSeconds":{"format":"int32","description":"The validity of the certificate in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/FilePrepareRemoteCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"FilePrepareOneTimePasswordSignatureType":{"description":"The configuration of the OneTimePassword signature.","type":"object","properties":{"ValidityInSeconds":{"format":"int32","description":"The validity of the password in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/FilePrepareOneTimePasswordStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"FilePrepareSwedishBankIdSignatureType":{"description":"The configuration of the signature.","type":"object","properties":{"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/FilePrepareSwedishBankIdStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"FilePrepareSignaturePluginSignatureType":{"description":"The configuration of the signature plugin.","type":"object","properties":{"PluginId":{"description":"The identifier of the plugin.","type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/FilePreparePluginStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"FilePrepareStampImprintDateConfiguration":{"description":"The configuration of the stamp imprint date","type":"object","properties":{"UseLocalTimezone":{"description":"If true, the local timezone is used.","type":"boolean"},"DateTimeFormat":{"description":"The format of the timestamp.","type":"string"}}},"FilePrepareLinkDefinition":{"description":"The settings of a positionable element.","type":"object","properties":{"Position":{"$ref":"#/definitions/FilePreparePosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/FilePrepareSize","description":"The size of the form field."}}},"FilePrepareVisibleSignature":{"description":"An automatic signature with a visual appearance on the document.","type":"object","properties":{"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Id":{"description":"The identifier of the signature field.","type":"string"},"UseExternalTimestampServer":{"description":"If true, a timestamp from an external server is embedded into the signature.","type":"boolean"},"FieldDefinition":{"$ref":"#/definitions/FilePrepareSignatureFieldDefinition","description":"The definition of the signature field."}}},"FilePrepareFieldValidationRange":{"description":"The validation rules for a value range.","type":"object","properties":{"From":{"description":"The lower boundary of the range.","type":"string"},"To":{"description":"The upper boundary of the range.","type":"string"}}},"FilePrepareClickToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"FilePrepareDrawToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"FilePrepareTypeToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"FilePrepareLocalCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"FilePrepareDisposableCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"FilePrepareSwissComOnDemandStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"FilePrepareRemoteCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"FilePrepareOneTimePasswordStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayTransactionId":{"description":"If true, the transaction identifier is displayed.","type":"boolean"},"DisplayTransactionToken":{"description":"If true, the transaction token is displayed.","type":"boolean"},"DisplayPhoneNumber":{"description":"If true, the phone number of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"FilePrepareSwedishBankIdStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayTransactionId":{"description":"If true, the transaction identifier is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"FilePreparePluginStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"LicenseGetResponse":{"description":"The response model for retrieving the current license status.","type":"object","properties":{"Type":{"description":"The type of the license.","type":"string"},"ExpirationDate":{"format":"date-time","description":"The expiration date of the license.\r\nThe value null indicates that it does not expire.\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","type":"string"},"Envelopes":{"$ref":"#/definitions/LicenseGetAmount","description":"The license status for the number of envelopes."},"EnvelopeSenderUsers":{"$ref":"#/definitions/LicenseGetAmount","description":"The license status for the number of senders.\r\nIf the license type is <code>Trial<\/code>, <code>EnvelopeSenderUsers<\/code> and <code>EnvelopeViewerUsers<\/code> have a combined limit."},"EnvelopeViewerUsers":{"$ref":"#/definitions/LicenseGetAmount","description":"The license status for the number of users which are only able to access their received envelopes.\r\nIf the license type is <code>Trial<\/code>, <code>EnvelopeSenderUsers<\/code> and <code>EnvelopeViewerUsers<\/code> have a combined limit."}}},"LicenseGetAmount":{"description":"The current state of the license.","type":"object","properties":{"Limit":{"format":"int32","description":"The maximum number of licensable objects.\r\nThe value -1 means unlimited.","type":"integer"},"Count":{"format":"int32","description":"The amount of licensable objects in use.","type":"integer"}}},"SealingCertificateGetAllResponse":{"description":"Information about all available sealing configurations.","type":"object","properties":{"SealingCertificates":{"description":"Sealing certificates.","type":"array","items":{"$ref":"#/definitions/SealingCertificateGetAllEntry"}}}},"SealingCertificateGetAllEntry":{"description":"Sealing certificate information.","type":"object","properties":{"Id":{"description":"Identifier used to reference the certificate for an envelope.","type":"string"},"CommonName":{"description":"Common name of the certificate.","type":"string"},"ExpirationDate":{"format":"date","description":"Expiration date of the certificate.","type":"string"},"Thumbprint":{"description":"Thumbprint of the certificate.","type":"string"},"IsDefault":{"description":"Is the certificate the default for all envelopes.","type":"boolean"}}},"TeamGetAllResponse":{"description":"The response model for retrieving the team hierarchy.","type":"object","properties":{"Teams":{"description":"The teams of the organization.","type":"array","items":{"$ref":"#/definitions/TeamGetAllTeam"}}}},"TeamGetAllTeam":{"description":"A team within the organization.","type":"object","properties":{"Name":{"description":"The name of the team.","type":"string"},"ShareEnvelopes":{"description":"If true, envelopes are shared with team members.","type":"boolean"},"ShareTemplates":{"description":"If true, templates are shared with team members.","type":"boolean"},"Head":{"$ref":"#/definitions/TeamGetAllTeamMember","description":"The leader of the team."}}},"TeamGetAllTeamMember":{"description":"A member of the team.","type":"object","properties":{"Email":{"description":"The email address of the team member.\r\nThis references a user email address.","type":"string"},"Members":{"description":"The members of the subteam.","type":"array","items":{"$ref":"#/definitions/TeamGetAllTeamMember"}}}},"TeamReplaceRequest":{"description":"The request model for replacing the teams.","required":["Teams"],"type":"object","properties":{"Teams":{"description":"The teams which will replace all the existing teams.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/TeamReplaceTeam"}}},"example":{"Teams":[{"Name":"Example Team","ShareEnvelopes":false,"ShareTemplates":false,"Head":{"Email":"teamlead@team.com","Members":[{"Email":"member@team.com"},{"Email":"teamleader@subteam.com","Members":[{"Email":"member@subteam.com"}]}]}}]}},"TeamReplaceTeam":{"description":"A team within the organization.","required":["Name"],"type":"object","properties":{"Name":{"description":"The name of the team.","maxLength":500,"minLength":0,"type":"string"},"ShareEnvelopes":{"description":"If true, envelopes are shared with team members.","type":"boolean"},"ShareTemplates":{"description":"If true, templates are shared with team members.","type":"boolean"},"Head":{"$ref":"#/definitions/TeamReplaceTeamMember","description":"The leader of the team."}}},"TeamReplaceTeamMember":{"description":"A member of the team.","type":"object","properties":{"Email":{"description":"The email address of the team member.\r\nThis references a user email address.","maxLength":250,"minLength":0,"pattern":"^[a-zA-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF0-9.!#$%&'*+\\-\\/=?^_`{|}~]+@(?=[a-z0-9A-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF])(?:[a-z0-9A-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF]|(?<![.-])\\.|(?<!\\.)-)*[a-z0-9A-Z\\u00A0-\\uD7FF\\uE000-\\uFFFF]$","type":"string"},"Members":{"description":"The members of the subteam.","maxItems":1000,"type":"array","items":{"$ref":"#/definitions/TeamReplaceTeamMember"}}}},"TemplateGetResponse":{"description":"The response model for requesting the template overview.","type":"object","properties":{"Id":{"description":"The identifier of the template.","type":"string"},"Name":{"description":"The name of the template.","type":"string"},"CreationDate":{"format":"date","description":"Date of creation","type":"string"},"Activities":{"description":"The activities of the template.","type":"array","items":{"$ref":"#/definitions/TemplateGetActivity"}}}},"TemplateGetActivity":{"description":"An activity of a template.","type":"object","properties":{"Id":{"description":"The identifier of the activity.","type":"string"},"Action":{"$ref":"#/definitions/TemplateGetAction","description":"The action assigned to the activity."}}},"TemplateGetAction":{"description":"The action of the activity with the possibility of a defined bulk.","type":"object","properties":{"SendCopy":{"$ref":"#/definitions/TemplateGetSendCopy","description":"The definition of the copy action."},"SignBulk":{"$ref":"#/definitions/TemplateGetSignBulk","description":"The definition of the bulk."},"SignAutomatic":{"$ref":"#/definitions/TemplateGetSignAutomatic","description":"The definition of the automatic sign action."},"Sign":{"$ref":"#/definitions/TemplateGetSign","description":"The definition of the sign action."},"View":{"$ref":"#/definitions/TemplateGetView","description":"The definition of the view action."},"SignAsP7M":{"$ref":"#/definitions/TemplateGetSignAsP7M","description":"The definition of the P7M sign action."},"SignPlaceholder":{"$ref":"#/definitions/TemplateGetSignPlaceholder","description":"The definition of the signer placeholder."}}},"TemplateGetSendCopy":{"description":"An action to send a copy of the documents to the recipient.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/TemplateGetContactInformation","description":"The contact information of the recipient."},"CopyingGroup":{"format":"int32","description":"The parallel group for copy actions.","type":"integer"}}},"TemplateGetSignBulk":{"description":"An action for signing for multiple recipients.","type":"object","properties":{"RecipientConfigurations":{"description":"The contact information of the recipients.","type":"array","items":{"$ref":"#/definitions/TemplateGetAdvancedRecipientConfiguration"}}}},"TemplateGetSignAutomatic":{"description":"An automatic signing action.","type":"object","properties":{"ProfileId":{"description":"The identifier of the profile for the automatic signatures.","type":"string"},"RenderingLanguageCode":{"description":"The rendering language for the automatic signatures.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string"}}},"TemplateGetSign":{"description":"An action to sign documents.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/TemplateGetContactInformation","description":"The contact information of the recipient."},"SigningGroup":{"format":"int32","description":"The parallel group for sign actions.","type":"integer"}}},"TemplateGetView":{"description":"An action to view and acknowledge the documents.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/TemplateGetContactInformation","description":"The contact information of the recipient."},"ViewingGroup":{"format":"int32","description":"The parallel group for view actions.","type":"integer"}}},"TemplateGetSignAsP7M":{"description":"An action to sign documents with P7M.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/TemplateGetContactInformation","description":"The contact information of the recipient."},"SignAsP7MGroup":{"format":"int32","description":"The parallel group for P7M actions.","type":"integer"}}},"TemplateGetSignPlaceholder":{"description":"A signing action for a placeholder.","type":"object","properties":{"SigningGroup":{"format":"int32","description":"The parallel group for sign actions.","type":"integer"},"PlaceholderLabel":{"description":"The label of the placeholder.","type":"string"}}},"TemplateGetContactInformation":{"description":"Defines the contact information for the recipient.","type":"object","properties":{"Email":{"description":"The email address of the recipient.","type":"string"},"GivenName":{"description":"The given name of the recipient.","type":"string"},"Surname":{"description":"The surname of the recipient.","type":"string"},"PhoneNumber":{"description":"The phone number of the recipient.","type":"string"},"LanguageCode":{"description":"The language of the recipient.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string","x-ms-enum":{"name":"LanguageCode","modelAsString":false}}}},"TemplateGetAdvancedRecipientConfiguration":{"description":"An action with contact information for the recipient.","type":"object","properties":{"ContactInformation":{"$ref":"#/definitions/TemplateGetContactInformation","description":"The contact information of the recipient."}}},"TemplateGetFilesResponse":{"description":"The response model for requesting files of a template.","type":"object","properties":{"Documents":{"description":"The documents.","type":"array","items":{"$ref":"#/definitions/TemplateGetFilesDocument"}}}},"TemplateGetFilesDocument":{"description":"The basic information about a document.","type":"object","properties":{"FileName":{"description":"The name of the file.","type":"string"},"PageCount":{"format":"int32","description":"The number of pages.","type":"integer"},"Pages":{"description":"The pages of the document.","type":"array","items":{"$ref":"#/definitions/TemplateGetFilesPage"}},"DocumentNumber":{"format":"int32","description":"The reference number of the document. It starts with 1.","type":"integer"}}},"TemplateGetFilesPage":{"description":"The information about a page of a document.","type":"object","properties":{"PageNumber":{"format":"int32","description":"The number of the page. It starts with 1.","type":"integer"},"Width":{"format":"double","description":"The width of the page in points.","type":"number"},"Height":{"format":"double","description":"The height of the page in points.","type":"number"}}},"TemplateGetElementsResponse":{"description":"The response model for requesting document elements of a draft or template.","type":"object","properties":{"UnassignedElements":{"$ref":"#/definitions/TemplateGetElementsElements","description":"The elements which are not assigned to any action."},"Activities":{"description":"The steps for the envelope.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsActivity"}}}},"TemplateGetElementsElements":{"description":"The configurable elements of the documents.","type":"object","properties":{"TextBoxes":{"description":"The text boxes.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsTextBox"}},"CheckBoxes":{"description":"The check boxes.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsCheckBox"}},"ComboBoxes":{"description":"The combo boxes.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsComboBox"}},"RadioButtons":{"description":"The radio buttons.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsRadioButtonGroup"}},"ListBoxes":{"description":"The list boxes.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsListBox"}},"Signatures":{"description":"The signatures.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsSignatureField"}},"Attachments":{"description":"The attachments.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsAttachment"}},"PredefinedFieldElements":{"$ref":"#/definitions/TemplateGetElementsPredefinedFieldElements","description":"The predefined field elements."},"LinkConfiguration":{"$ref":"#/definitions/TemplateGetElementsLinkConfiguration","description":"The links in the documents."},"AreaReadConfirmations":{"description":"The areas which have to be read.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsReadAreaConfirmation"}},"PageReadConfirmations":{"description":"The pages which have to be read.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsReadPagesConfirmation"}},"DocumentReadConfirmations":{"description":"The documents which have to be read.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsReadDocumentConfirmation"}}}},"TemplateGetElementsActivity":{"description":"Defines an activity in the process.","type":"object","properties":{"Id":{"description":"The identifier of the activity.","type":"string"},"Action":{"$ref":"#/definitions/TemplateGetElementsAction","description":"The action assigned to the activity."}}},"TemplateGetElementsTextBox":{"description":"The configuration of the text box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"Value":{"description":"The value of the text box.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"Validation":{"$ref":"#/definitions/TemplateGetElementsFieldValidation","description":"The configuration of the validation rules for the text box value."},"FieldDefinition":{"$ref":"#/definitions/TemplateGetElementsTextBoxDefinition","description":"The definition of the text box."}}},"TemplateGetElementsCheckBox":{"description":"The configuration of the check box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"IsChecked":{"description":"If true, the check box is checked.","type":"boolean"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/TemplateGetElementsCheckBoxDefinition","description":"The definition of the check box."}}},"TemplateGetElementsComboBox":{"description":"The configuration of the combo box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"Value":{"description":"The selected value of the combo box.","type":"string"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/TemplateGetElementsComboBoxDefinition","description":"The definition of the combo box."}}},"TemplateGetElementsRadioButtonGroup":{"description":"The configuration of the radio button group.","type":"object","properties":{"GroupName":{"description":"The name of the radio button group.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"SelectedItem":{"description":"The export value of the selected item of the radio button group.","type":"string"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/TemplateGetElementsRadioButtonDefinition","description":"The definition of the radio button group."}}},"TemplateGetElementsListBox":{"description":"The configuration of the list box.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"PreSelectedItems":{"description":"The export values of the items which should be initially selected.","type":"array","items":{"type":"string"}},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/TemplateGetElementsListBoxDefinition","description":"The definition of the list box field."}}},"TemplateGetElementsSignatureField":{"description":"The configuration of the signature field.","type":"object","properties":{"ElementId":{"description":"The identifier of the signature.","type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","type":"string"},"FieldDescription":{"description":"The description of the signature.","type":"string"},"UseExternalTimestampServer":{"description":"If true, an timestamp from an external server is embedded into the signature.","type":"boolean"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"AllowedSignatureTypes":{"$ref":"#/definitions/TemplateGetElementsAllowedSignatureTypes","description":"The allowed types for the signature."},"FieldDefinition":{"$ref":"#/definitions/TemplateGetElementsSignatureFieldDefinition","description":"The definition of the signature field."},"TaskConfiguration":{"$ref":"#/definitions/TemplateGetElementsSignatureTaskConfiguration","description":"The configuration of the task."}}},"TemplateGetElementsAttachment":{"description":"The configuration of the attachment element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DisplayName":{"description":"The displayed name.","type":"string"},"DisplayIconType":{"description":"The type of the displayed icon.","enum":["Paperclip","Graph","PushPin","Tag"],"type":"string"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/TemplateGetElementsAttachmentDefinition","description":"The definition of the attachment element."}}},"TemplateGetElementsPredefinedFieldElements":{"description":"Defines the predefined fields which will be added and filled by the system.","type":"object","properties":{"TextFields":{"description":"The predefined text fields.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsPredefinedText"}},"EmailFields":{"description":"The recipient's email fields.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsEmail"}},"InitialsFields":{"description":"The recipient's initials fields.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsInitials"}},"GivenNameFields":{"description":"The recipient's given name fields.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsGivenName"}},"SurnameFields":{"description":"The recipient's surname fields.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsSurname"}},"FullNameFields":{"description":"The recipient's full name fields.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsFullName"}},"DateFields":{"description":"The current date fields.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsDate"}}}},"TemplateGetElementsLinkConfiguration":{"description":"The configuration of the link elements.","type":"object","properties":{"HyperLinks":{"description":"The list of hyperlink elements.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsHyperLink"}}}},"TemplateGetElementsReadAreaConfirmation":{"description":"The area that has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The document reference number of the element (starting with 1).","type":"integer"},"DisplayName":{"description":"The displayed name.","type":"string"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"},"Definition":{"$ref":"#/definitions/TemplateGetElementsReadingAreaDefinition","description":"The definition of the area."}}},"TemplateGetElementsReadPagesConfirmation":{"description":"Define which page has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","type":"string"},"PageNumber":{"format":"int32","description":"The number of the page that needs to be read.","type":"integer"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"}}},"TemplateGetElementsReadDocumentConfirmation":{"description":"Define which document has to be read.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"Required":{"description":"If true, the element is required.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DisplayName":{"description":"The displayed name.","type":"string"},"GuidingOrder":{"format":"int32","description":"The order of the element.","type":"integer"}}},"TemplateGetElementsAction":{"description":"The action of the activity.","type":"object","properties":{"SignAutomatic":{"$ref":"#/definitions/TemplateGetElementsSignAutomatic","description":"The definition of the automatic sign action."},"Sign":{"$ref":"#/definitions/TemplateGetElementsSign","description":"The definition of the sign action."},"SignBulk":{"$ref":"#/definitions/TemplateGetElementsSignBulk","description":"The definition of the bulk."}}},"TemplateGetElementsFieldValidation":{"description":"The configuration of the field validation rules.","type":"object","properties":{"Type":{"description":"The type of the value.","enum":["None","Date","Email","Number","Phone","Time"],"type":"string","x-ms-enum":{"name":"FieldValidationType","modelAsString":false}},"DateValidationConfiguration":{"$ref":"#/definitions/TemplateGetElementsDateValidationConfiguration","description":"The validation rules for dates."},"NumberValidationConfiguration":{"$ref":"#/definitions/TemplateGetElementsNumberValidationConfiguration","description":"The validation rules for numbers."},"PhoneValidationConfiguration":{"$ref":"#/definitions/TemplateGetElementsPhoneValidationConfiguration","description":"The validation rules for phone numbers."},"TimeValidationConfiguration":{"$ref":"#/definitions/TemplateGetElementsTimeValidationConfiguration","description":"The validation rules for time values."}}},"TemplateGetElementsTextBoxDefinition":{"description":"The configuration of the text box.","type":"object","properties":{"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"MaxLength":{"format":"int32","description":"The maximum length of the text.","type":"integer"},"IsMultiline":{"description":"If true, the text box can have multiple lines.","type":"boolean"},"IsPassword":{"description":"If true, the text box behaves like a password input field and does not show the actually entered characters.","type":"boolean"},"TextFormat":{"$ref":"#/definitions/TemplateGetElementsTextFormat","description":"The configuration of the text format."},"Position":{"$ref":"#/definitions/TemplateGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/TemplateGetElementsSize","description":"The size of the form field."}}},"TemplateGetElementsCheckBoxDefinition":{"description":"The configuration of a check box.","type":"object","properties":{"ExportValue":{"description":"The value of the check box when it is checked.","type":"string"},"Position":{"$ref":"#/definitions/TemplateGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/TemplateGetElementsSize","description":"The size of the form field."},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"}}},"TemplateGetElementsComboBoxDefinition":{"description":"The configuration of the combo box.","type":"object","properties":{"TextFormat":{"$ref":"#/definitions/TemplateGetElementsTextFormat","description":"The configuration of the text format."},"Items":{"description":"A list of items that can be selected for the element.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsChoiceItem"}},"IsEditable":{"description":"If true, the combo box is editable.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/TemplateGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/TemplateGetElementsSize","description":"The size of the form field."}}},"TemplateGetElementsRadioButtonDefinition":{"description":"The configuration of the radio button group definition.","type":"object","properties":{"IsSelectUnison":{"description":"If true, radio buttons with the same <code>ExportValue<\/code> are checked and unchecked together.","type":"boolean"},"Items":{"description":"The list of radiobuttons that belong to the same group.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsRadioButtonItemDefinition"}}}},"TemplateGetElementsListBoxDefinition":{"description":"The configuration of the list box.","type":"object","properties":{"TextFormat":{"$ref":"#/definitions/TemplateGetElementsTextFormat","description":"The configuration of the text format."},"Items":{"description":"A list of items that can be selected for the element.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsChoiceItem"}},"IsMultiSelect":{"description":"If true, multiple values of the list box can be selected.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/TemplateGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/TemplateGetElementsSize","description":"The size of the form field."}}},"TemplateGetElementsAllowedSignatureTypes":{"description":"The definition of the allowed signature types for the signature.","type":"object","properties":{"ClickToSign":{"$ref":"#/definitions/TemplateGetElementsClickToSignSignatureType","description":"Allow signing with \"click to sign\"."},"DrawToSign":{"$ref":"#/definitions/TemplateGetElementsDrawToSignSignatureType","description":"Allow signing with \"draw to sign\"."},"TypeToSign":{"$ref":"#/definitions/TemplateGetElementsTypeToSignSignatureType","description":"Allow signing with \"type to sign\"."},"LocalCertificate":{"$ref":"#/definitions/TemplateGetElementsLocalCertificateSignatureType","description":"Allow signing with a local certificate."},"DisposableCertificate":{"$ref":"#/definitions/TemplateGetElementsDisposableCertificateSignatureType","description":"Allow signing with a disposable certificate."},"SwissComOnDemand":{"$ref":"#/definitions/TemplateGetElementsSwissComOnDemandSignatureType","description":"Allow signing with a Swisscom On-Demand certificate."},"ATrustCertificate":{"$ref":"#/definitions/TemplateGetElementsATrustCertificateSignatureType","description":"Allow signing with an A-Trust certificate."},"Biometric":{"$ref":"#/definitions/TemplateGetElementsBiometricSignatureType","description":"Allow signing with a biometric signature."},"RemoteCertificate":{"$ref":"#/definitions/TemplateGetElementsRemoteCertificateSignatureType","description":"Allow signing with a remote certificate."},"OneTimePassword":{"$ref":"#/definitions/TemplateGetElementsOneTimePasswordSignatureType","description":"Allow signing with a one time password (SMS-OTP)."},"SwedishBankId":{"$ref":"#/definitions/TemplateGetElementsSwedishBankIdSignatureType","description":"Allow signing with Swedish BankID."},"SignaturePlugins":{"description":"Allow signing with signature plugins.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsSignaturePluginSignatureType"}}}},"TemplateGetElementsSignatureFieldDefinition":{"description":"The settings of a positionable element.","type":"object","properties":{"Position":{"$ref":"#/definitions/TemplateGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/TemplateGetElementsSize","description":"The size of the form field."}}},"TemplateGetElementsSignatureTaskConfiguration":{"description":"The configuration of the signature task.","type":"object","properties":{"StampImprintDateConfiguration":{"$ref":"#/definitions/TemplateGetElementsStampImprintDateConfiguration","description":"The configuration of the stamp imprint date."},"BatchGroup":{"description":"The batch group.","type":"string"}}},"TemplateGetElementsAttachmentDefinition":{"description":"The settings of a positionable element.","type":"object","properties":{"Position":{"$ref":"#/definitions/TemplateGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/TemplateGetElementsSize","description":"The size of the form field."}}},"TemplateGetElementsPredefinedText":{"description":"The configuration of the element showing the predefined text.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"Value":{"description":"The value of the predefined text.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/TemplateGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"TemplateGetElementsEmail":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/TemplateGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"TemplateGetElementsInitials":{"description":"The configuration of the predefined element showing the initials.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"IncludeMiddleNameInitials":{"description":"If true, the initials from the middle names are included as well. \r\nThe initials are read from the given name. Additional names are expected to be separated by a space.","type":"boolean"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/TemplateGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"TemplateGetElementsGivenName":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/TemplateGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"TemplateGetElementsSurname":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/TemplateGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"TemplateGetElementsFullName":{"description":"The configuration of the predefined element.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/TemplateGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"TemplateGetElementsDate":{"description":"The configuration of the predefined element showing the date.","type":"object","properties":{"ElementId":{"description":"The identifier of the element.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"DateFormat":{"description":"The format of the date.","type":"string"},"FieldDefinition":{"$ref":"#/definitions/TemplateGetElementsPredefinedElementDefinition","description":"The definition of the predefined element."}}},"TemplateGetElementsHyperLink":{"description":"The definition of the hyperlink element.","type":"object","properties":{"Id":{"description":"The identifier of the hyperlink.","type":"string"},"Uri":{"description":"The URI of the hyperlink.","type":"string"},"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"FieldDefinition":{"$ref":"#/definitions/TemplateGetElementsLinkDefinition","description":"The definition of the hyperlink element."}}},"TemplateGetElementsReadingAreaDefinition":{"description":"The settings of a positionable element.","type":"object","properties":{"Position":{"$ref":"#/definitions/TemplateGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/TemplateGetElementsSize","description":"The size of the form field."}}},"TemplateGetElementsSignAutomatic":{"description":"An automatic signing action.","type":"object","properties":{"VisibleSignatures":{"description":"The visible signatures define the optional visual representations for automatic signatures.\r\nIf none are defined, the automatic signatures are applied to the documents without a visual element.","type":"array","items":{"$ref":"#/definitions/TemplateGetElementsVisibleSignature"}}}},"TemplateGetElementsSign":{"description":"The elements, which are assigned to actions.","type":"object","properties":{"SequenceMode":{"description":"The sequence mode.","enum":["NoSequenceEnforced","SequenceEnforced"],"type":"string","x-ms-enum":{"name":"ElementSequenceMode","modelAsString":false}},"Elements":{"$ref":"#/definitions/TemplateGetElementsElements","description":"The definition of the assigned elements."}}},"TemplateGetElementsSignBulk":{"description":"The elements, which are assigned to actions.","type":"object","properties":{"SequenceMode":{"description":"The sequence mode.","enum":["NoSequenceEnforced","SequenceEnforced"],"type":"string","x-ms-enum":{"name":"ElementSequenceMode","modelAsString":false}},"Elements":{"$ref":"#/definitions/TemplateGetElementsElements","description":"The definition of the assigned elements."}}},"TemplateGetElementsDateValidationConfiguration":{"description":"The validation rules for dates.","type":"object","properties":{"DateFormat":{"description":"The format of the dates.","type":"string"},"Range":{"$ref":"#/definitions/TemplateGetElementsFieldValidationRange","description":"The range of the values."}}},"TemplateGetElementsNumberValidationConfiguration":{"description":"The validation rules for numbers.","type":"object","properties":{"DecimalDigits":{"format":"int32","description":"The expected amount of decimal digits.","type":"integer"},"Symbol":{"description":"The expected symbol.","type":"string"},"SymbolLocation":{"description":"The defined symbol location.","enum":["Start","StartWithBlank","End","EndWithBlank"],"type":"string","x-ms-enum":{"name":"SymbolLocationType","modelAsString":false}},"GroupSeparator":{"description":"The expected thousands separator.","enum":["Comma","Point","Apostrophe","Blank","None"],"type":"string"},"DecimalSeparator":{"description":"The expected decimal separator.","enum":["Comma","Point","Apostrophe","None"],"type":"string","x-ms-enum":{"name":"DecimalSeparatorType","modelAsString":false}},"Range":{"$ref":"#/definitions/TemplateGetElementsFieldValidationRange","description":"The range of the values."}}},"TemplateGetElementsPhoneValidationConfiguration":{"description":"The validation rules for phone numbers.","type":"object","properties":{"Type":{"description":"The format of the phone numbers.","enum":["International","InternationalLeadingZeros","InternationalLeadingPlus"],"type":"string","x-ms-enum":{"name":"PhoneType","modelAsString":false}}}},"TemplateGetElementsTimeValidationConfiguration":{"description":"The validation rules for time values.","type":"object","properties":{"TimeFormat":{"description":"The format of the time values.","type":"string"},"Range":{"$ref":"#/definitions/TemplateGetElementsFieldValidationRange","description":"The range of the values."}}},"TemplateGetElementsTextFormat":{"description":"The configuration of the text format.","type":"object","properties":{"TextColor":{"description":"The color of the text.\r\nSix digit hexadecimal color starting with # in #RRGGBB format according to CSS Color Module Level 4, paragraph 5.2.","type":"string"},"FontSizeInPt":{"format":"double","description":"The size of the font in points.","type":"number"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"Bold":{"description":"If true, the bold font is used.","type":"boolean"},"Italic":{"description":"If true, the italic font is used.","type":"boolean"},"TextAlign":{"description":"The alignment of the text. The default alignment is left.","enum":["Left","Center","Right"],"type":"string","x-ms-enum":{"name":"TextAlignment","modelAsString":false}}}},"TemplateGetElementsPosition":{"description":"The position of an element on the document.","type":"object","properties":{"PageNumber":{"format":"int32","description":"The number of the page where the element is located. It starts with 1.","type":"integer"},"X":{"format":"double","description":"The X coordinate in points. It starts from the left.","type":"number"},"Y":{"format":"double","description":"The Y coordinate in points. It starts from the bottom.","type":"number"}}},"TemplateGetElementsSize":{"description":"The definition of the size of an element.","type":"object","properties":{"Width":{"format":"double","description":"The width of the element in points.","type":"number"},"Height":{"format":"double","description":"The height of the element in points.","type":"number"}}},"TemplateGetElementsChoiceItem":{"description":"The configuration of the choice item.","type":"object","properties":{"ExportValue":{"description":"The value of the element when the choice item is selected.","type":"string"},"DisplayValue":{"description":"The displayed value of the choice item.","type":"string"}}},"TemplateGetElementsRadioButtonItemDefinition":{"description":"The configuration of the radio button.","type":"object","properties":{"ExportValue":{"description":"The value of the element when the radio button is checked.","type":"string"},"IsChecked":{"description":"If true, the radio button is checked by default.","type":"boolean"},"ReadOnly":{"description":"If true, the element is readonly.","type":"boolean"},"Position":{"$ref":"#/definitions/TemplateGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/TemplateGetElementsSize","description":"The size of the form field."}}},"TemplateGetElementsClickToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/TemplateGetElementsClickToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"TemplateGetElementsDrawToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/TemplateGetElementsDrawToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"TemplateGetElementsTypeToSignSignatureType":{"description":"The configuration of the signature image.","type":"object","properties":{"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/TemplateGetElementsTypeToSignStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"TemplateGetElementsLocalCertificateSignatureType":{"description":"The configuration of the LocalCertificate signature.","type":"object","properties":{"EnforcePreferredHashAlgorithm":{"description":"If true, the usage of the preferred hash algorithm is enforced.","type":"boolean"},"PreferredHashAlgorithm":{"description":"The preferred hash algorithm.","enum":["Sha256","Sha512"],"type":"string"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/TemplateGetElementsLocalCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"TemplateGetElementsDisposableCertificateSignatureType":{"description":"The configuration of the DisposableCertificate signature.","type":"object","properties":{"IsLongLived":{"description":"If true, the disposable certificate is long lived.","type":"boolean"},"ValidityInSeconds":{"format":"int32","description":"The validity of the certificate in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/TemplateGetElementsDisposableCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"TemplateGetElementsSwissComOnDemandSignatureType":{"description":"The configuration of the Swisscom On-Demand signature.","type":"object","properties":{"ValidityInSeconds":{"format":"int32","description":"The certificate validity in seconds.","type":"integer"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/TemplateGetElementsSwissComOnDemandStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"TemplateGetElementsATrustCertificateSignatureType":{"description":"The configuration of the A-Trust certificate signature.","type":"object","properties":{"TemplateId":{"description":"The identifier of the A-Trust template.","type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"}}},"TemplateGetElementsBiometricSignatureType":{"description":"The configuration of the Biometric signature.","type":"object","properties":{"BiometricVerification":{"description":"If true, a biometric verification is performed.","type":"boolean"},"AllowBiometricStoringOnly":{"description":"If true, the biometric signature might be stored without verification.","type":"boolean"},"StoreSignedResponseWithoutBioData":{"description":"If true, the signed response is stored without biometric data.","type":"boolean"},"BiometricServerUserId":{"description":"The identifier of the user on the biometric server.","type":"string"},"SignaturePositioning":{"description":"The allowed positioning of the biometric signature.","enum":["WithinField","OnPage","IntersectsWithField"],"type":"string","x-ms-enum":{"name":"BiometricSignaturePositioning","modelAsString":false}},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"}}},"TemplateGetElementsRemoteCertificateSignatureType":{"description":"The configuration of the RemoteCertificate signature.","type":"object","properties":{"ValidityInSeconds":{"format":"int32","description":"The validity of the certificate in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/TemplateGetElementsRemoteCertificateStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"TemplateGetElementsOneTimePasswordSignatureType":{"description":"The configuration of the OneTimePassword signature.","type":"object","properties":{"ValidityInSeconds":{"format":"int32","description":"The validity of the password in seconds.","type":"integer"},"UseExternalSignatureImage":{"description":"The external signature image mode.","enum":["Optional","Required","Disabled"],"type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/TemplateGetElementsOneTimePasswordStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"TemplateGetElementsSwedishBankIdSignatureType":{"description":"The configuration of the signature.","type":"object","properties":{"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/TemplateGetElementsSwedishBankIdStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"TemplateGetElementsSignaturePluginSignatureType":{"description":"The configuration of the signature plugin.","type":"object","properties":{"PluginId":{"description":"The identifier of the plugin.","type":"string"},"Preferred":{"description":"If true, the signature type is set as preferred.","type":"boolean"},"StampImprintConfiguration":{"$ref":"#/definitions/TemplateGetElementsPluginStampImprint","description":"The configuration of the stamp imprint of the signature."}}},"TemplateGetElementsStampImprintDateConfiguration":{"description":"The configuration of the stamp imprint date","type":"object","properties":{"UseLocalTimezone":{"description":"If true, the local timezone is used.","type":"boolean"},"DateTimeFormat":{"description":"The format of the timestamp.","type":"string"}}},"TemplateGetElementsPredefinedElementDefinition":{"description":"The configuration of the predefined element.","type":"object","properties":{"TextFormat":{"$ref":"#/definitions/TemplateGetElementsTextFormat","description":"The configuration of the text format."},"Position":{"$ref":"#/definitions/TemplateGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/TemplateGetElementsSize","description":"The size of the form field."}}},"TemplateGetElementsLinkDefinition":{"description":"The settings of a positionable element.","type":"object","properties":{"Position":{"$ref":"#/definitions/TemplateGetElementsPosition","description":"The position of the  within the document."},"Size":{"$ref":"#/definitions/TemplateGetElementsSize","description":"The size of the form field."}}},"TemplateGetElementsVisibleSignature":{"description":"An automatic signature with a visual appearance on the document.","type":"object","properties":{"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"Id":{"description":"The identifier of the signature field.","type":"string"},"UseExternalTimestampServer":{"description":"If true, a timestamp from an external server is embedded into the signature.","type":"boolean"},"FieldDefinition":{"$ref":"#/definitions/TemplateGetElementsSignatureFieldDefinition","description":"The definition of the signature field."}}},"TemplateGetElementsFieldValidationRange":{"description":"The validation rules for a value range.","type":"object","properties":{"From":{"description":"The lower boundary of the range.","type":"string"},"To":{"description":"The upper boundary of the range.","type":"string"}}},"TemplateGetElementsClickToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"TemplateGetElementsDrawToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"TemplateGetElementsTypeToSignStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"TemplateGetElementsLocalCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"TemplateGetElementsDisposableCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"TemplateGetElementsSwissComOnDemandStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"TemplateGetElementsRemoteCertificateStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"TemplateGetElementsOneTimePasswordStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayTransactionId":{"description":"If true, the transaction identifier is displayed.","type":"boolean"},"DisplayTransactionToken":{"description":"If true, the transaction token is displayed.","type":"boolean"},"DisplayPhoneNumber":{"description":"If true, the phone number of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"TemplateGetElementsSwedishBankIdStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayTransactionId":{"description":"If true, the transaction identifier is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"TemplateGetElementsPluginStampImprint":{"description":"The configuration of the stamp imprint used by multiple signature types.","type":"object","properties":{"DisplayExtraInformation":{"description":"If true, the extra information is displayed.","type":"boolean"},"FontName":{"description":"The name of the font. The font needs to be installed on the server. \r\nIf it is not available on the server, a fallback font is used.","type":"string"},"FontSizeInPt":{"format":"int32","description":"The size of the font in points.","type":"integer"},"DisplayEmail":{"description":"If true, the email address of the signer is displayed.","type":"boolean"},"DisplayIp":{"description":"If true, the IP address of the signer is displayed.","type":"boolean"},"DisplayName":{"description":"If true, the name of the signer is displayed.","type":"boolean"},"DisplaySignatureDate":{"description":"If true, the timestamp of signing is displayed.","type":"boolean"}}},"TemplateGetConfigurationResponse":{"description":"Configuration shared by all models.","type":"object","properties":{"MetaData":{"description":"The metadata of the envelope.","type":"string"},"AddDocumentTimestamp":{"description":"If true, a timestamp is added to all documents of the envelope at the end of each signing activity.","type":"boolean"},"ShareWithTeam":{"description":"If true, this envelope is shared with your teams.","type":"boolean"},"LockFormFieldsOnFinish":{"description":"If true, form fields are locked after envelope is finished.","type":"boolean"},"SendFinishedDocumentsToAllSignersAndMustView":{"description":"If true, every signer and viewer will receive a copy of the finished documents.","type":"boolean"},"Activities":{"description":"The steps for the envelope.","type":"array","items":{"$ref":"#/definitions/TemplateGetConfigurationActivity"}},"EmailConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationEmailConfiguration","description":"The configuration for notifications."},"ReminderConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationReminderConfiguration","description":"The configuration for reminders."},"ExpirationConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationExpirationConfiguration","description":"The configuration of the expiration for the envelope."},"CallbackConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationCallbackConfiguration","description":"The configuration of the callbacks for a custom integration."},"AgreementConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationAgreementConfiguration","description":"The configuration of the agreement."},"AgentRedirectConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationAgentRedirectConfiguration","description":"The configuration of the redirects for the agent mode."},"RedirectConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationRedirectConfiguration","description":"The configuration of the redirects for the agent mode."},"DefaultSignatureTypeConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationDefaultSignatureTypeConfiguration","description":"Draft default signature type configuration."},"SealingConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationSealingConfiguration","description":"The configuration for sealing."}}},"TemplateGetConfigurationActivity":{"description":"Defines an activity with the possibility of bulk.","type":"object","properties":{"Id":{"description":"The identifier of the activity.","type":"string"},"Action":{"$ref":"#/definitions/TemplateGetConfigurationAction","description":"The action assigned to the activity."},"VisibilityOptions":{"description":"The document visibility options for the activity.","type":"array","items":{"$ref":"#/definitions/TemplateGetConfigurationVisibilityOption"}}}},"TemplateGetConfigurationEmailConfiguration":{"description":"The configuration for notifications.","type":"object","properties":{"Subject":{"description":"The subject of the sign notifications.","type":"string"},"Message":{"description":"The message of the sign notifications.","type":"string"},"SenderDisplayName":{"description":"The displayed name of the sender in the notifications.","type":"string"}}},"TemplateGetConfigurationReminderConfiguration":{"description":"The configuration for reminders.","type":"object","properties":{"Enabled":{"description":"If true, reminders are sent.","type":"boolean"},"FirstReminderInDays":{"format":"int32","description":"The amount of days until a reminder is sent to a signer or a viewer after the initial notification.","type":"integer"},"ReminderResendIntervalInDays":{"format":"int32","description":"The amount of days until a reminder is sent again to a signer or a viewer.","type":"integer"},"BeforeExpirationInDays":{"format":"int32","description":"The amount of days before the envelope expires and a reminder should be sent.","type":"integer"}}},"TemplateGetConfigurationExpirationConfiguration":{"description":"The configuration of the expiration for the envelope.","type":"object","properties":{"ExpirationInSeconds":{"format":"int64","description":"The relative expiration in seconds after sending the envelope.","type":"integer"},"ExpirationDate":{"format":"date-time","description":"The absolute expiration date of the envelope.\r\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).","type":"string"}}},"TemplateGetConfigurationCallbackConfiguration":{"description":"The configuration of the callbacks for a custom integration.","type":"object","properties":{"CallbackUrl":{"description":"The callback URL triggered when the envelope has been finished.","type":"string"},"StatusUpdateCallbackUrl":{"description":"The callback URL triggered for status updates of an envelope.","type":"string"},"AfterSendCallbackUrl":{"description":"The callback URL triggered after sending the draft.","type":"string"},"ActivityActionCallbackConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationActivityActionCallbackConfiguration","description":"The configuration of the callback for workstep events."}}},"TemplateGetConfigurationAgreementConfiguration":{"description":"The configuration of the agreement.","type":"object","properties":{"Translations":{"description":"The agreement and its translations to be used.\r\nIf no custom agreement is specified, the default organization agreement will be used.","type":"array","items":{"$ref":"#/definitions/TemplateGetConfigurationAgreementTranslation"}}}},"TemplateGetConfigurationAgentRedirectConfiguration":{"description":"The configuration of the redirects for the agent mode.","type":"object","properties":{"Policy":{"description":"Defines the redirect target page which should be opened when the agent mode is active.","enum":["Workflow","FormEditor","Summary"],"type":"string","x-ms-enum":{"name":"RedirectPolicyEnum","modelAsString":false}},"Allow":{"description":"If true, the agent mode can be used.","type":"boolean"},"IFrameAllowList":{"description":"The URLs where the designer interface of eSignAnyWhere may be embedded.","type":"array","items":{"type":"string"}}}},"TemplateGetConfigurationRedirectConfiguration":{"description":"The configuration of the draft redirect URLs.","type":"object","properties":{"AfterSendRedirectUrl":{"description":"The URL to redirect to after the envelope was sent successfully.\r\nThis is only applicable when using the eSAW UI.","type":"string"},"BeforeSendRedirectUrl":{"description":"The URL to redirect to before the envelope is sent.\r\nThis is only applicable when using the eSAW UI.","type":"string"}}},"TemplateGetConfigurationDefaultSignatureTypeConfiguration":{"description":"The configuration of the default signature type for a draft.","type":"object","properties":{"None":{"$ref":"#/definitions/TemplateGetConfigurationDefaultSignature","description":"\"None\" SignatureType."},"ClickToSign":{"$ref":"#/definitions/TemplateGetConfigurationDefaultSignature","description":"\"click to sign\" SignatureType."},"DrawToSign":{"$ref":"#/definitions/TemplateGetConfigurationDefaultSignature","description":"\"draw to sign\" SignatureType."},"TypeToSign":{"$ref":"#/definitions/TemplateGetConfigurationDefaultSignature","description":"\"type to sign\" SignatureType."},"LocalCertificate":{"$ref":"#/definitions/TemplateGetConfigurationDefaultSignature","description":"\"local certificate\" SignatureType."},"DisposableCertificate":{"$ref":"#/definitions/TemplateGetConfigurationDefaultSignature","description":"\"disposable certificate\" SignatureType."},"Biometric":{"$ref":"#/definitions/TemplateGetConfigurationDefaultSignature","description":"\"biometric signature\" SignatureType."},"RemoteCertificate":{"$ref":"#/definitions/TemplateGetConfigurationDefaultSignature","description":"\"remote certificate\" SignatureType."},"OneTimePassword":{"$ref":"#/definitions/TemplateGetConfigurationDefaultSignature","description":"\"one time password (SMS-OTP)\" SignatureType."}}},"TemplateGetConfigurationSealingConfiguration":{"description":"The configuration for sealing.","type":"object","properties":{"CertificateId":{"description":"Sealing certificate used.","type":"string"}}},"TemplateGetConfigurationAction":{"description":"The action of the activity.","type":"object","properties":{"SendCopy":{"$ref":"#/definitions/TemplateGetConfigurationSendCopy","description":"The configuration of the copy action."},"Sign":{"$ref":"#/definitions/TemplateGetConfigurationSign","description":"The configuration of the sign action."},"View":{"$ref":"#/definitions/TemplateGetConfigurationView","description":"The configuration of the view action."},"SignAsP7M":{"$ref":"#/definitions/TemplateGetConfigurationSignAsP7M","description":"The configuration of the P7M sign action."},"SignBulk":{"$ref":"#/definitions/TemplateGetConfigurationSignBulk","description":"The definition of the bulk."}}},"TemplateGetConfigurationVisibilityOption":{"description":"The options defining the document visibility.","type":"object","properties":{"DocumentNumber":{"format":"int32","description":"The reference number of the containing document. It starts with 1.","type":"integer"},"IsHidden":{"description":"If true, the referenced document is hidden for the activity.","type":"boolean"}}},"TemplateGetConfigurationActivityActionCallbackConfiguration":{"description":"The configuration of the callback for workstep events.","type":"object","properties":{"Url":{"description":"The callback URL triggered for the selected events.","type":"string"},"ActionCallbackSelection":{"$ref":"#/definitions/TemplateGetConfigurationActionCallbackSelection","description":"The selection of events which trigger the callback."}}},"TemplateGetConfigurationAgreementTranslation":{"description":"A translation for the agreement.","type":"object","properties":{"LanguageCode":{"description":"The language of the translated agreement.","enum":["AF","AF_ZA","AR","AR_AE","AR_BH","AR_DZ","AR_EG","AR_IQ","AR_JO","AR_KW","AR_LB","AR_LY","AR_MA","AR_OM","AR_QA","AR_SA","AR_SY","AR_TN","AR_YE","AZ","AZ_AZ","BE","BE_BY","BG","BG_BG","BS_BA","CA","CA_ES","CS","CS_CZ","CY","CY_GB","DA","DA_DK","DE","DE_AT","DE_CH","DE_DE","DE_LI","DE_LU","DV","DV_MV","EL","EL_GR","EN","EN_AU","EN_BZ","EN_CA","EN_CB","EN_GB","EN_IE","EN_JM","EN_NZ","EN_PH","EN_TT","EN_US","EN_ZA","EN_ZW","EO","ES","ES_AR","ES_BO","ES_CL","ES_CO","ES_CR","ES_DO","ES_EC","ES_ES","ES_GT","ES_HN","ES_MX","ES_NI","ES_PA","ES_PE","ES_PR","ES_PY","ES_SV","ES_UY","ES_VE","ET","ET_EE","EU","EU_ES","FA","FA_IR","FI","FI_FI","FO","FO_FO","FR","FR_BE","FR_CA","FR_CH","FR_FR","FR_LU","FR_MC","GL","GL_ES","GU","GU_IN","HE","HE_IL","HI","HI_IN","HR","HR_BA","HR_HR","HU","HU_HU","HY","HY_AM","ID","ID_ID","IS","IS_IS","IT","IT_CH","IT_IT","JA","JA_JP","KA","KA_GE","KK","KK_KZ","KN","KN_IN","KO","KO_KR","KOK","KOK_IN","KY","KY_KG","LT","LT_LT","LV","LV_LV","MI","MI_NZ","MK","MK_MK","MN","MN_MN","MR","MR_IN","MS","MS_BN","MS_MY","MT","MT_MT","NB","NB_NO","NL","NL_BE","NL_NL","NN_NO","NS","NS_ZA","PA","PA_IN","PL","PL_PL","PS","PS_AR","PT","PT_BR","PT_PT","QU","QU_BO","QU_EC","QU_PE","RO","RO_RO","RU","RU_RU","SA","SA_IN","SE","SE_FI","SE_NO","SE_SE","SK","SK_SK","SL","SL_SI","SQ","SQ_AL","SR_BA","SR_SP","SV","SV_FI","SV_SE","SW","SW_KE","SYR","SYR_SY","TA","TA_IN","TE","TE_IN","TH","TH_TH","TL","TL_PH","TN","TN_ZA","TR","TR_TR","TT","TT_RU","TS","UK","UK_UA","UR","UR_PK","UZ","UZ_UZ","VI","VI_VN","XH","XH_ZA","ZH","ZH_CN","ZH_HK","ZH_MO","ZH_SG","ZH_TW","ZU","ZU_ZA"],"type":"string","x-ms-enum":{"name":"LanguageCode","modelAsString":false}},"Text":{"description":"The translated agreement.","type":"string"},"Header":{"description":"The header for the translated agreement.","type":"string"},"IsDefault":{"description":"If true, this translation is used as default.","type":"boolean"}}},"TemplateGetConfigurationDefaultSignature":{"description":"The configuration of the default signature type for a draft.","type":"object","properties":{"IsDefault":{"description":"Indicates if the signature type is the default signature type for draft.","type":"boolean"}}},"TemplateGetConfigurationSendCopy":{"description":"The configuration of an action to send a copy of the documents to the recipient.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationBasicRecipientConfiguration","description":"The configuration of the recipient."},"CopyingGroup":{"format":"int32","description":"The parallel group for copy actions.","type":"integer"}}},"TemplateGetConfigurationSign":{"description":"The configuration of the sign action for the recipient.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"FinishActionConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationFinishAction","description":"Defines what happens in the signing clients, after an action has been finished."},"SignatureDataConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationSignatureDataConfiguration","description":"The configuration of recipient data for special signatures."},"BatchConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationBatchConfiguration","description":"The configuration of a signing batch."},"SigningGroup":{"format":"int32","description":"The parallel group for sign actions.","type":"integer"},"GeneralPoliciesOverrides":{"$ref":"#/definitions/TemplateGetConfigurationGeneralPoliciesForSignAction","description":"Viewer policy settings for override."}}},"TemplateGetConfigurationView":{"description":"The configuration of the action to view and acknowledge the documents.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationRecipientConfiguration","description":"The configuration of the recipient."},"ViewingGroup":{"format":"int32","description":"The parallel group for view actions.","type":"integer"},"GeneralPoliciesOverrides":{"$ref":"#/definitions/TemplateGetConfigurationGeneralPoliciesForViewAction","description":"Viewer policy settings for override."}}},"TemplateGetConfigurationSignAsP7M":{"description":"The configuration of an action to sign documents with P7M.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"SignatureMethods":{"$ref":"#/definitions/TemplateGetConfigurationP7MSignatureMethods","description":"The configuration of recipient data for P7M signatures."},"SignAsP7MGroup":{"format":"int32","description":"The parallel group for P7M actions.","type":"integer"},"GeneralPoliciesOverrides":{"$ref":"#/definitions/TemplateGetConfigurationGeneralPoliciesForP7MAction","description":"Viewer policy settings for override."}}},"TemplateGetConfigurationSignBulk":{"description":"The configuration of a sign action for multiple recipients.","type":"object","properties":{"RecipientConfigurations":{"description":"The configurations of the recipients that are part of the bulk.","type":"array","items":{"$ref":"#/definitions/TemplateGetConfigurationBulkRecipient"}},"FinishActionConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationFinishAction","description":"Defined actions for different clients that will trigger after an action has been finished."},"BatchConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationBatchConfiguration","description":"The configuration of a signing batch."},"GeneralPoliciesOverrides":{"$ref":"#/definitions/TemplateGetConfigurationGeneralPoliciesForSignAction","description":"Viewer policy settings for override."}}},"TemplateGetConfigurationActionCallbackSelection":{"description":"The selection of events which trigger the callback.","type":"object","properties":{"ConfirmTransactionCode":{"description":"If true, the callback is triggered when a transaction code was sent. This is only used for legacy disposable certificates, after user accepted issuance of disposable certificate.","type":"boolean"},"AgreementAccepted":{"description":"If true, the callback is triggered when the user accepted the agreement.","type":"boolean"},"AgreementRejected":{"description":"If true, the callback is triggered when the user rejected the agreement.","type":"boolean"},"PrepareAuthenticationSuccess":{"description":"If true, the callback is triggered when the preparation of the authentication process succeeded.","type":"boolean"},"AuthenticationFailed":{"description":"If true, the callback is triggered when the user failed to authenticate.","type":"boolean"},"AuthenticationSuccess":{"description":"If true, the callback is triggered when the user succeeded to authenticate.","type":"boolean"},"AuditTrailRequested":{"description":"If true, the callback is triggered when the audit trail was requested.","type":"boolean"},"AuditTrailXmlRequested":{"description":"If true, the callback is triggered when the audit trail XML was requested.","type":"boolean"},"CalledPage":{"description":"If true, the callback is triggered when the SignAnyWhere Viewer was requested.","type":"boolean"},"DocumentDownloaded":{"description":"If true, the callback is triggered when the document download was requested.","type":"boolean"},"FlattenedDocumentDownloaded":{"description":"If true, the callback is triggered when the flattened document download was requested.","type":"boolean"},"AddedAnnotation":{"description":"If true, the callback is triggered when an annotation was added.","type":"boolean"},"AddedAttachment":{"description":"If true, the callback is triggered when an attachment was added.","type":"boolean"},"AppendedDocument":{"description":"If true, the callback is triggered when a document was appended.","type":"boolean"},"FormsFilled":{"description":"If true, the callback is triggered when a form field was filled.","type":"boolean"},"ConfirmReading":{"description":"If true, the callback is triggered when a reading task was completed.","type":"boolean"},"SendTransactionCode":{"description":"If true, the callback is triggered when a transaction code for a signature with type TransactionCode was sent using the TransactionCodeSenderPlugin.","type":"boolean"},"PrepareSignWorkstepDocument":{"description":"If true, the callback is triggered when a signature was prepared for signing.","type":"boolean"},"SignWorkstepDocument":{"description":"If true, the callback is triggered when a signature was applied.","type":"boolean"},"UndoAction":{"description":"If true, the callback is triggered when an action was undone.","type":"boolean"},"WorkstepCreated":{"description":"If true, the callback is triggered when a workstep was created.","type":"boolean"},"WorkstepFinished":{"description":"If true, the callback is triggered when a workstep was finished.","type":"boolean"},"WorkstepRejected":{"description":"If true, the callback is triggered when a workstep was rejected.","type":"boolean"},"DisablePolicyAndValidityChecks":{"description":"If true, the callback is triggered when policy and validity checks were disabled.","type":"boolean"},"EnablePolicyAndValidityChecks":{"description":"If true, the callback is triggered when policy and validity checks were enabled.","type":"boolean"},"AppendFileToWorkstep":{"description":"If true, the callback is triggered when a file was appended to the workstep.","type":"boolean"},"AppendTasksToWorkstep":{"description":"If true, the callback is triggered when a task was added to the workstep.","type":"boolean"},"SetOptionalDocumentState":{"description":"If true, the callback is triggered when an optional document became either active or inactive.","type":"boolean"},"PreparePayloadForBatch":{"description":"If true, the callback is triggered when the payload was prepared for batch signing.","type":"boolean"}}},"TemplateGetConfigurationBasicRecipientConfiguration":{"description":"The configuration of the recipient.","type":"object","properties":{"PersonalMessage":{"description":"The personal message for the recipient.","type":"string"}}},"TemplateGetConfigurationAdvancedRecipientConfiguration":{"description":"The advanced configuration for the recipient.","type":"object","properties":{"PersonalMessage":{"description":"The personal message for the recipient.","type":"string"},"AuthenticationConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationAuthenticationConfiguration","description":"The configuration for the authentication of the recipient."},"SendEmails":{"description":"If true, emails will be sent out for this recipient.","type":"boolean"},"AllowAccessAfterFinish":{"description":"If true, the recipient is allowed to access the action after it has been finished.","type":"boolean"},"IncludedEmailAppLinks":{"$ref":"#/definitions/TemplateGetConfigurationEmailAppLinks","description":"The configuration for mobile app links in email messages."},"AllowDelegation":{"description":"If true, the recipient may delegate this activity.","type":"boolean"},"RequireViewContentBeforeFormFilling":{"description":"If true, the signer has to confirm the reading of all documents as first task.","type":"boolean"}}},"TemplateGetConfigurationFinishAction":{"description":"Defines what happens in the signing clients, after an action has been finished.","type":"object","properties":{"SignAnyWhereViewer":{"$ref":"#/definitions/TemplateGetConfigurationWebFinishAction","description":"The actions for the SAW Viewer."},"SignificantClientSignatureCaptureForIos":{"$ref":"#/definitions/TemplateGetConfigurationAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for iOS."},"SignificantClientSignatureCaptureForAndroid":{"$ref":"#/definitions/TemplateGetConfigurationAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for Android."},"SignificantClientSignatureCaptureForWindows":{"$ref":"#/definitions/TemplateGetConfigurationAppFinishAction","description":"The actions for the SIGNificant Client Signature Capture App for Windows."},"KioskSdk":{"$ref":"#/definitions/TemplateGetConfigurationKioskFinishAction","description":"The actions for the SIGNificant Kiosk SDK."}}},"TemplateGetConfigurationSignatureDataConfiguration":{"description":"The recipient configuration for signing.","type":"object","properties":{"DisposableCertificate":{"$ref":"#/definitions/TemplateGetConfigurationDisposableCertificateSignatureData","description":"The disposable certificate configuration for the action."},"RemoteCertificate":{"$ref":"#/definitions/TemplateGetConfigurationRemoteCertificateSignatureData","description":"The remote certificate configuration for the action."},"SwissComOnDemand":{"$ref":"#/definitions/TemplateGetConfigurationSwissComOnDemandSignatureData","description":"The Swisscom On-Demand certificate configuration for the action."},"SmsOneTimePassword":{"$ref":"#/definitions/TemplateGetConfigurationSmsOneTimePasswordSignatureData","description":"The one time password configuration for the action (SMS-OTP)."},"ATrustCertificate":{"$ref":"#/definitions/TemplateGetConfigurationATrustCertificateSignatureData","description":"The A-Trust certificate configuration for the action."},"SwedishBankId":{"$ref":"#/definitions/TemplateGetConfigurationSwedishBankIdSignatureData","description":"The Swedish BankID configuration for the action."},"SignaturePluginData":{"description":"The signature plugin configurations for the action.","type":"array","items":{"$ref":"#/definitions/TemplateGetConfigurationSignaturePluginSignatureData"}}}},"TemplateGetConfigurationBatchConfiguration":{"description":"The configuration of a signing batch.","type":"object","properties":{"Mode":{"description":"The mode, that will be used for batch signing.","enum":["Basic","OptIn","OptOut","OptOutWithRequiredAlwaysSelected","OptInWithRequiredAlwaysSelected"],"type":"string","x-ms-enum":{"name":"BatchMode","modelAsString":false}},"RequireScrollingOverAllSignaturesBeforeSigning":{"description":"If true, the user has to review all signatures in the batch signing dialog before signing.\r\nThis is only applicable when the <code>Mode<\/code> is set to <code>OptIn<\/code> or <code>OptOut<\/code>.","type":"boolean"}}},"TemplateGetConfigurationGeneralPoliciesForSignAction":{"description":"Define the general policies allowed for sign action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"},"AllowAdhocPdfAttachments":{"description":"If true, the client is allowed to append adhoc documents.","type":"boolean"},"AllowRejectWorkstep":{"description":"If true, the client is allowed to reject the workstep.","type":"boolean"},"AllowUndoLastAction":{"description":"If true, the client is allowed to undo actions.","type":"boolean"}}},"TemplateGetConfigurationRecipientConfiguration":{"description":"The configuration of the recipient.","type":"object","properties":{"PersonalMessage":{"description":"The personal message for the recipient.","type":"string"},"AuthenticationConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationAuthenticationConfiguration","description":"The configuration for the authentication of the recipient."},"SendEmails":{"description":"If true, emails will be sent out for this recipient.","type":"boolean"},"AllowAccessAfterFinish":{"description":"If true, the recipient is allowed to access the action after it has been finished.","type":"boolean"}}},"TemplateGetConfigurationGeneralPoliciesForViewAction":{"description":"Define the general policies allowed for view action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"}}},"TemplateGetConfigurationP7MSignatureMethods":{"description":"The recipient configuration for signing with P7M.","type":"object","properties":{"LocalCertificate":{"description":"If true, a local certificate can be used.","type":"boolean"},"DisposableCertificate":{"$ref":"#/definitions/TemplateGetConfigurationDisposableCertificateSignatureData","description":"The disposable certificate configuration for the action."},"RemoteCertificate":{"$ref":"#/definitions/TemplateGetConfigurationRemoteCertificateSignatureData","description":"The remote certificate configuration for the action."},"SignaturePluginData":{"description":"The signature plugin configurations for the action.","type":"array","items":{"$ref":"#/definitions/TemplateGetConfigurationSignaturePluginSignatureData"}}}},"TemplateGetConfigurationGeneralPoliciesForP7MAction":{"description":"Define the general policies allowed for P7M action.","type":"object","properties":{"AllowSaveDocument":{"description":"If true, the client is allowed to save the workstep document.","type":"boolean"},"AllowSaveAuditTrail":{"description":"If true, the client is allowed to save the audittrail document.","type":"boolean"},"AllowPrintDocument":{"description":"If true, the client is allowed to print the workstep document.","type":"boolean"},"AllowAdhocPdfAttachments":{"description":"If true, the client is allowed to append adhoc documents.","type":"boolean"},"AllowRejectWorkstep":{"description":"If true, the client is allowed to reject the workstep.","type":"boolean"},"AllowUndoLastAction":{"description":"If true, the client is allowed to undo actions.","type":"boolean"},"AllowDownloadOfSignedP7MFiles":{"description":"If true, the client is allowed to download signed p7m files.","type":"boolean"}}},"TemplateGetConfigurationBulkRecipient":{"description":"The definition of the recipient including the signature data.","type":"object","properties":{"RecipientConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationAdvancedRecipientConfiguration","description":"The configuration of the recipient."},"SignatureDataConfiguration":{"$ref":"#/definitions/TemplateGetConfigurationSignatureDataConfiguration","description":"The configuration of the signature data for the recipient."}}},"TemplateGetConfigurationAuthenticationConfiguration":{"description":"The definition of the authentications of the recipient.","type":"object","properties":{"AccessCode":{"$ref":"#/definitions/TemplateGetConfigurationAccessCodeAuthentication","description":"The configuration of the authentication with an access code."},"SmsOneTimePassword":{"$ref":"#/definitions/TemplateGetConfigurationSmsOneTimePasswordAuthentication","description":"The configuration of the authentication with one time password over SMS."},"SwedishBankId":{"$ref":"#/definitions/TemplateGetConfigurationSwedishBankIdAuthentication","description":"The configuration of the authentication with Swedish BankID."},"OAuthAuthentications":{"description":"The configurations of the authentication with OAuth.","type":"array","items":{"$ref":"#/definitions/TemplateGetConfigurationOAuthAuthentication"}},"SamlAuthentications":{"description":"The configurations of the authentication with SAML.","type":"array","items":{"$ref":"#/definitions/TemplateGetConfigurationSamlAuthentication"}}}},"TemplateGetConfigurationEmailAppLinks":{"description":"Configure if links for our Apps should be included in the document signing request email message.","type":"object","properties":{"Android":{"description":"If true, an Android app link is added to the email message.","type":"boolean"},"iOS":{"description":"If true, an iOS app link is added to the email message.","type":"boolean"},"Windows":{"description":"If true, a Windows app link is added to the email message.","type":"boolean"}}},"TemplateGetConfigurationWebFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RedirectUri":{"description":"The redirect uri.","type":"string"}}},"TemplateGetConfigurationAppFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RemoveDocumentFromRecentDocumentList":{"description":"If true, the document will be removed from the recent document list.","type":"boolean"},"CallClientActionOnlyAfterSuccessfulSync":{"description":"If true, the client action will be called only after a successful sync.","type":"boolean"},"CloseApp":{"description":"If true, the app will be closed.","type":"boolean"},"RedirectUri":{"description":"The redirect uri.","type":"string"}}},"TemplateGetConfigurationKioskFinishAction":{"description":"Define actions for different clients that will trigger after an action has been finished.","type":"object","properties":{"RedirectUri":{"description":"The redirect uri.","type":"string"}}},"TemplateGetConfigurationDisposableCertificateSignatureData":{"description":"The recipient configuration for signing with a disposable certificate.","type":"object","properties":{"DocumentIssuingCountry":{"description":"The issuing country of the document.\r\nWill be used as country of residence, if lean is disabled.","type":"string"},"IdentificationIssuingCountry":{"description":"The issuing country of the identification.","type":"string"},"IdentificationType":{"description":"The type of identification in use.","enum":["None","ForeignTaxCode","PersonalNumber","Passport","NationalIdentityCard","ItalianTaxCode","NoSerialNumber","DrivingLicense","ResidencePermit","TemporaryResidencePermit","EmbassyDocument","AML"],"type":"string","x-ms-enum":{"name":"DisposableCertificateIdentificationType","modelAsString":false}},"PhoneNumber":{"description":"The phone number registered for identification.","type":"string"},"DocumentType":{"description":"The type of document used for the identification.","enum":["IdentityCard","DriverLicense","Passport","ResidencePermit","NationalElectronicIdentityCard","TemporaryResidencePermit","EmbassyDocument"],"type":"string","x-ms-enum":{"name":"DisposableCertificateDocumentType","modelAsString":false}},"DocumentIssuedBy":{"description":"The authority that issued the document.","type":"string"},"DocumentIssuedOn":{"format":"date","description":"The date when the document has been issued.\r\nA date in the format RFC 3339, section 5.6, 'full-date' (e.g. 2017-07-21).","type":"string"},"DocumentExpiryDate":{"format":"date","description":"The expiration date of the document.\r\nA date in the format RFC 3339, section 5.6, 'full-date' (e.g. 2017-07-21).","type":"string"},"SerialNumber":{"description":"The serial number of the certificate.","type":"string"},"DocumentNumber":{"description":"The identifier of the document.","type":"string"}}},"TemplateGetConfigurationRemoteCertificateSignatureData":{"description":"The recipient configuration for signing with a remote certificate.","type":"object","properties":{"UserId":{"description":"The identifier of the user.","type":"string"},"DeviceId":{"description":"The identifier of the device.","type":"string"}}},"TemplateGetConfigurationSwissComOnDemandSignatureData":{"description":"The recipient configuration for signing with a Swisscom On-Demand certificate.","type":"object","properties":{"PhoneNumber":{"description":"The phone number.","type":"string"},"CommonName":{"description":"The name of the certificate that is created or checked.","type":"string"},"Country":{"description":"The country.","type":"string"},"Locality":{"description":"The locality.","type":"string"},"OrganizationUnit":{"description":"The organizational unit.","type":"string"},"Organization":{"description":"The organization.","type":"string"},"SerialNumber":{"description":"The serial number.","type":"string"},"StateOrProvince":{"description":"The state or province.","type":"string"},"Pseudonym":{"description":"A name or key that uniquely identifies the user.","type":"string"}}},"TemplateGetConfigurationSmsOneTimePasswordSignatureData":{"description":"The recipient configuration for signing with a one time password sent via SMS.","type":"object","properties":{"PhoneNumber":{"description":"The phone number to which the one time password will be sent.","type":"string"}}},"TemplateGetConfigurationATrustCertificateSignatureData":{"description":"The recipient configuration for signing with an A-Trust certificate.","type":"object","properties":{"PhoneNumber":{"description":"The phone number of the recipient.","type":"string"}}},"TemplateGetConfigurationSwedishBankIdSignatureData":{"description":"The recipient configuration for signing with Swedish BankID.","type":"object","properties":{"PersonalNumber":{"description":"The personal number for signing.","type":"string"},"AllowAnyPersonalNumber":{"description":"If true, the personal number can be edited by the recipient.\r\nIf the personal number is empty and can be edited, a QR code for scanning is provided.","type":"boolean"}}},"TemplateGetConfigurationSignaturePluginSignatureData":{"description":"The recipient configuration for signing with a signature plugin.","type":"object","properties":{"PluginId":{"description":"The identifier of the signature plugin.","type":"string"},"Fields":{"description":"The plugin parameters referred to as the GSP sender data fields.","type":"array","items":{"$ref":"#/definitions/TemplateGetConfigurationSignaturePluginParameter"}}}},"TemplateGetConfigurationAccessCodeAuthentication":{"description":"The configuration for authentication with a predefined access code.","type":"object","properties":{"Code":{"description":"The code for authenticating the recipient.","type":"string"}}},"TemplateGetConfigurationSmsOneTimePasswordAuthentication":{"description":"The configuration for authentication with a one time password sent over SMS.","type":"object","properties":{"PhoneNumber":{"description":"The phone number to which the one time password will be sent.","type":"string"}}},"TemplateGetConfigurationSwedishBankIdAuthentication":{"description":"The configuration for Swedish BankID authentication.","type":"object","properties":{"PersonalNumber":{"description":"The personal number for the authentication.","type":"string"},"AllowAnyPersonalNumber":{"description":"If true, the personal number can be edited by the recipient.\r\nIf the personal number is empty and can be edited, a QR code for scanning is provided.","type":"boolean"}}},"TemplateGetConfigurationOAuthAuthentication":{"description":"The configuration for authentication with an OAuth provider.","type":"object","properties":{"ProviderName":{"description":"The name of the OAuth provider.","type":"string"},"Validations":{"description":"The validation rules for the OAuth response.","type":"array","items":{"$ref":"#/definitions/TemplateGetConfigurationAuthenticationValidation"}}}},"TemplateGetConfigurationSamlAuthentication":{"description":"The configuration for authentication with a SAML provider.","type":"object","properties":{"ProviderName":{"description":"The name of the SAML provider.","type":"string"},"Validations":{"description":"The validation rules for the SAML response.","type":"array","items":{"$ref":"#/definitions/TemplateGetConfigurationAuthenticationValidation"}}}},"TemplateGetConfigurationSignaturePluginParameter":{"description":"The definition of a signature plugin parameter.","type":"object","properties":{"Key":{"description":"The identifier of the parameter.","type":"string"},"Value":{"description":"The value of the parameter.","type":"string"}}},"TemplateGetConfigurationAuthenticationValidation":{"description":"A validation rule for an authentication response.","type":"object","properties":{"FieldReferenceId":{"description":"The identifier of the field.","type":"string"},"ExpectedValue":{"description":"The expected value of the field.","type":"string"}}},"TemplateFindRequest":{"description":"The request model for searching templates.","type":"object","properties":{"SearchText":{"description":"If set, the given text is searched in following fields:\r\nenvelope name and description\r\nnotification subject and message \r\nsender email address, given name and surname  \r\nrecipient email address, given name and surname\r\nNote: Using this search option is very resource intensive! It might take very long.","maxLength":500,"minLength":0,"type":"string"},"RecipientEmail":{"description":"If set, envelopes containing a recipient with the given email address are matched.","maxLength":250,"minLength":0,"type":"string"}}},"TemplateFindResponse":{"description":"The response model for the found templates.","type":"object","properties":{"Templates":{"description":"The templates matching the search criteria.","type":"array","items":{"$ref":"#/definitions/TemplateFindTemplate"}}}},"TemplateFindTemplate":{"description":"The response model for found envelopes.","type":"object","properties":{"Id":{"description":"The identifier of the envelope.","type":"string"},"Name":{"description":"The name of the envelope.","type":"string"},"MetaData":{"description":"The metadata of the envelope.","type":"string"}}},"TemplateCreateDraftRequest":{"description":"The request model for creating a draft from a template.","required":["TemplateId"],"type":"object","properties":{"TemplateId":{"description":"The identifier of the template.","maxLength":36,"minLength":36,"type":"string"}}},"TemplateCreateDraftResponse":{"description":"The response model after creating the draft from a template successfully.","type":"object","properties":{"DraftId":{"description":"The identifier of the draft.","type":"string"}}}},"securityDefinitions":{"apiToken":{"type":"apiKey","description":"API Key Authentication","name":"apiToken","in":"header"}}}