{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/boldsign/main/json-schema/boldsign-schemas.json", "title": "BoldSign API Schemas", "description": "JSON Schema definitions for all BoldSign eSignature API components", "definitions": { "AccessCodeDetail": { "title": "AccessCodeDetail", "required": [ "authenticationType" ], "type": "object", "properties": { "emailId": { "title": "String", "type": "string", "nullable": true }, "order": { "title": "Nullable`1", "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "accessCode": { "title": "String", "type": "string", "nullable": true }, "authenticationType": { "title": "Nullable`1", "enum": [ "None", "EmailOTP", "AccessCode", "SMSOTP", "IdVerification" ], "type": "string" }, "onBehalfOf": { "title": "String", "type": "string", "nullable": true }, "phoneNumber": { "$ref": "#/components/schemas/PhoneNumber" }, "identityVerificationSettings": { "$ref": "#/components/schemas/IdentityVerificationSettings" }, "authenticationRetryCount": { "title": "Nullable`1", "maximum": 10, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "authenticationSettings": { "$ref": "#/components/schemas/AuthenticationSettings" } }, "additionalProperties": false }, "AccessCodeDetails": { "title": "AccessCodeDetails", "required": [ "accessCode" ], "type": "object", "properties": { "accessCode": { "title": "String", "minLength": 1, "type": "string" }, "phoneNumber": { "$ref": "#/components/schemas/PhoneNumber" }, "onBehalfOf": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "Added": { "title": "Added", "type": "object", "properties": { "signerName": { "title": "String", "type": "string", "nullable": true }, "signerEmail": { "title": "String", "type": "string", "nullable": true }, "signerPhoneNumber": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "Address": { "title": "Address", "type": "object", "properties": { "city": { "title": "String", "type": "string", "nullable": true }, "country": { "title": "String", "type": "string", "nullable": true }, "line1": { "title": "String", "type": "string", "nullable": true }, "line2": { "title": "String", "type": "string", "nullable": true }, "postalCode": { "title": "String", "type": "string", "nullable": true }, "state": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "AttachmentInfo": { "title": "AttachmentInfo", "required": [ "acceptedFileTypes", "title" ], "type": "object", "properties": { "title": { "title": "String", "type": "string", "nullable": true }, "description": { "title": "String", "type": "string", "nullable": true }, "allowedFileTypes": { "title": "String", "type": "string", "nullable": true, "deprecated": true }, "acceptedFileTypes": { "title": "String[]", "type": "array", "items": { "title": "String", "type": "string" }, "nullable": true } }, "additionalProperties": false }, "AuditTrail": { "title": "AuditTrail", "type": "object", "properties": { "id": { "title": "String", "type": "string", "nullable": true }, "name": { "title": "String", "type": "string", "nullable": true }, "email": { "title": "String", "type": "string", "nullable": true }, "fromName": { "title": "String", "type": "string", "nullable": true }, "fromEmail": { "title": "String", "type": "string", "nullable": true }, "fromPhoneNumber": { "title": "String", "type": "string", "nullable": true }, "toName": { "title": "String", "type": "string", "nullable": true }, "toEmail": { "title": "String", "type": "string", "nullable": true }, "toPhoneNumber": { "title": "String", "type": "string", "nullable": true }, "ipaddress": { "title": "String", "type": "string", "nullable": true }, "action": { "title": "DocumentAuditAction", "enum": [ "Sent", "Viewed", "Signed", "Completed", "Downloaded", "Reassigned", "Declined", "Recalled", "Created", "AuthenticationFailed", "Reminder", "AccessCodeChanged", "AccessCodeViewed", "DownloadedForPrintSign", "FormCreated", "EmailOTP", "AuthenticationRemoved", "DownloadedAuditTrail", "Cloned", "ClonedWithFieldValues", "Deleted", "MovedToTrash", "Restored", "AutoReminder", "Resend", "Reviewed", "InitiatePrintSign", "CancelPrintSign", "CompletePrintSign", "GeneratedEmbeddedSignLink", "EmbeddedSigned", "EmbeddedReviewed", "ExpiryDateExtended", "Attachment", "EditRecipient", "AuthenticationAdded", "AutoReminderON", "AutoReminderOFF", "SMSOTP", "PhoneNumberChanged", "UnlockedSMSOTP", "SMSAuthenticationAdded", "SMSAuthenticationRemoved", "SMSOTPVerified", "SMSAuthenticationFailed", "UnlockEmailOTP", "EmailAuthenticationAdded", "EmailAuthenticationRemoved", "EmailOtpVerify", "EmailAuthenticationFailed", "SMSOTPResend", "EmailOTPResend", "ResumeDocumentSigning", "EmailOTPAuthenticationAdded", "EmailOTPAuthenticationRemoved", "EmailOTPAuthenticationFailed", "EmailOTPVerified", "IdentityVerificationInitiated", "IdentityVerificationRemoved", "IdentityVerificationCompleted", "IdentityVerificationFailed", "DownloadedVerificationData", "ManualIdentityVerificationCompleted", "IdentityVerificationReset", "CreateEmbeddedVerificationLink", "SensitiveDataDownloaded", "IdVerificationRemoved", "IdVerificationAdded", "ManualIdentityVerificationInitiated", "GeneratedSigningLink", "EditingInitiated", "EditingCancelled", "EditingCompleted", "QESVerificationInitiated", "QESVerified", "QESRejected", "QESExpired", "QESWithdrawn", "ResentForApproval", "DocumentFieldMarkup" ], "type": "string" }, "timestamp": { "title": "Int64", "type": "integer", "format": "int64" }, "recipientChangeLog": { "$ref": "#/components/schemas/RecipientChangeLog" }, "documentChangeLog": { "$ref": "#/components/schemas/ModificationDetails" }, "fieldChangeLog": { "$ref": "#/components/schemas/ModificationDetails" } }, "additionalProperties": false }, "AuthenticationSettings": { "title": "AuthenticationSettings", "type": "object", "properties": { "authenticationFrequency": { "title": "Nullable`1", "enum": [ "None", "EveryAccess", "UntilSignCompleted", "OncePerDocument" ], "type": "string", "nullable": true } }, "additionalProperties": false }, "Base64File": { "title": "Base64File", "required": [ "base64" ], "type": "object", "properties": { "base64": { "title": "String", "minLength": 1, "type": "string" }, "fileName": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "BehalfDocument": { "title": "BehalfDocument", "type": "object", "properties": { "behalfOf": { "$ref": "#/components/schemas/BehalfOf" }, "documentId": { "title": "String", "type": "string", "nullable": true }, "senderDetail": { "$ref": "#/components/schemas/DocumentSenderDetail" }, "ccDetails": { "title": "DocumentCcDetails[]", "type": "array", "items": { "$ref": "#/components/schemas/DocumentCcDetails" }, "nullable": true }, "createdDate": { "title": "Int64", "type": "integer", "format": "int64" }, "activityDate": { "title": "Int64", "type": "integer", "format": "int64" }, "activityBy": { "title": "String", "type": "string", "nullable": true }, "messageTitle": { "title": "String", "type": "string", "nullable": true }, "status": { "title": "DocumentStatus", "enum": [ "InProgress", "Completed", "Declined", "Expired", "Revoked", "Draft", "Scheduled" ], "type": "string" }, "signerDetails": { "title": "DocumentSignerDetails[]", "type": "array", "items": { "$ref": "#/components/schemas/DocumentSignerDetails" }, "nullable": true }, "expiryDate": { "title": "Int64", "type": "integer", "format": "int64" }, "enableSigningOrder": { "title": "Boolean", "type": "boolean" }, "isDeleted": { "title": "Boolean", "type": "boolean" }, "labels": { "title": "List`1", "type": "array", "items": { "title": "String", "type": "string" }, "nullable": true }, "cursor": { "title": "Int64", "type": "integer", "format": "int64" }, "brandId": { "title": "String", "type": "string", "nullable": true }, "scheduledSendTime": { "title": "Nullable`1", "type": "integer", "format": "int64", "nullable": true }, "inEditingMode": { "title": "Boolean", "type": "boolean" }, "displayStatus": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "BehalfDocumentRecords": { "title": "BehalfDocumentRecords", "type": "object", "properties": { "pageDetails": { "$ref": "#/components/schemas/PageDetails" }, "result": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/BehalfDocument" }, "nullable": true } }, "additionalProperties": false }, "BehalfOf": { "title": "BehalfOf", "type": "object", "properties": { "name": { "title": "String", "type": "string", "nullable": true }, "emailAddress": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "BehalfOfWebhookModel": { "title": "BehalfOfWebhookModel", "type": "object", "properties": { "id": { "title": "String", "type": "string", "nullable": true }, "email": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "BillingViewModel": { "title": "BillingViewModel", "type": "object", "properties": { "BalanceCredits": { "title": "Double", "type": "number", "format": "double" } }, "additionalProperties": false }, "BrandCreated": { "title": "BrandCreated", "type": "object", "properties": { "brandId": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "BrandCustomFieldDetails": { "title": "BrandCustomFieldDetails", "type": "object", "properties": { "fieldName": { "title": "String", "type": "string", "nullable": true }, "fieldDescription": { "title": "String", "type": "string", "nullable": true }, "fieldOrder": { "title": "Int32", "type": "integer", "format": "int32", "default": 1 }, "brandId": { "title": "String", "type": "string", "nullable": true }, "sharedField": { "title": "Boolean", "type": "boolean" }, "formField": { "$ref": "#/components/schemas/CustomFormField" } }, "additionalProperties": false }, "BrandingMessage": { "title": "BrandingMessage", "type": "object", "properties": { "message": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "BrandingRecords": { "title": "BrandingRecords", "type": "object", "properties": { "result": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/ViewBrandDetails" }, "nullable": true } }, "additionalProperties": false }, "ChangeRecipient": { "title": "ChangeRecipient", "required": [ "newSignerName", "reason" ], "type": "object", "properties": { "newSignerName": { "title": "String", "minLength": 1, "type": "string" }, "reason": { "title": "String", "minLength": 1, "type": "string" }, "order": { "title": "Nullable`1", "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "newSignerEmail": { "title": "String", "type": "string", "format": "email", "nullable": true }, "oldSignerEmail": { "title": "String", "type": "string", "format": "email", "nullable": true }, "onBehalfOf": { "title": "String", "type": "string", "nullable": true }, "phoneNumber": { "$ref": "#/components/schemas/PhoneNumber" }, "oldPhoneNumber": { "$ref": "#/components/schemas/PhoneNumber" } }, "additionalProperties": false }, "ChangeTeamRequest": { "title": "ChangeTeamRequest", "required": [ "toTeamId" ], "type": "object", "properties": { "toTeamId": { "title": "String", "minLength": 1, "type": "string" }, "transferDocumentsToUserId": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "CollaborationSettings": { "title": "CollaborationSettings", "type": "object", "properties": { "isRequired": { "title": "Nullable`1", "type": "boolean", "nullable": true }, "requireSignerApproval": { "title": "Nullable`1", "type": "boolean", "nullable": true }, "requireInitial": { "title": "Nullable`1", "type": "boolean", "nullable": true }, "allowedSigners": { "title": "List`1", "type": "array", "items": { "title": "String", "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ConditionalRule": { "title": "ConditionalRule", "type": "object", "properties": { "fieldId": { "title": "String", "type": "string", "nullable": true }, "isChecked": { "title": "Boolean", "type": "boolean" }, "value": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "ContactCreated": { "title": "ContactCreated", "type": "object", "properties": { "id": { "title": "String", "type": "string", "nullable": true }, "email": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "ContactDetails": { "title": "ContactDetails", "required": [ "email", "name" ], "type": "object", "properties": { "email": { "title": "String", "minLength": 1, "type": "string" }, "name": { "title": "String", "minLength": 1, "type": "string" }, "phoneNumber": { "$ref": "#/components/schemas/PhoneNumber" }, "jobTitle": { "title": "String", "type": "string", "nullable": true }, "companyName": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "ContactPageDetails": { "title": "ContactPageDetails", "type": "object", "properties": { "pageSize": { "title": "Int32", "type": "integer", "format": "int32" }, "page": { "title": "Int32", "type": "integer", "format": "int32" }, "totalRecordsCount": { "title": "Int32", "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ContactsDetails": { "title": "ContactsDetails", "type": "object", "properties": { "id": { "title": "String", "type": "string", "nullable": true }, "name": { "title": "String", "type": "string", "nullable": true }, "email": { "title": "String", "type": "string", "nullable": true }, "companyName": { "title": "String", "type": "string", "nullable": true }, "jobTitle": { "title": "String", "type": "string", "nullable": true }, "phoneNumber": { "$ref": "#/components/schemas/PhoneNumber" } }, "additionalProperties": false }, "ContactsList": { "title": "ContactsList", "type": "object", "properties": { "pageDetails": { "$ref": "#/components/schemas/ContactPageDetails" }, "result": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/ContactsDetails" }, "nullable": true } }, "additionalProperties": false }, "CreateContactResponse": { "title": "CreateContactResponse", "type": "object", "properties": { "createdContacts": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/ContactCreated" }, "nullable": true } }, "additionalProperties": false }, "CreateGroupContactResponse": { "title": "CreateGroupContactResponse", "type": "object", "properties": { "groupId": { "title": "String", "type": "string", "nullable": true }, "groupName": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateSenderIdentityRequest": { "title": "CreateSenderIdentityRequest", "required": [ "email" ], "type": "object", "properties": { "name": { "title": "String", "maxLength": 80, "minLength": 0, "type": "string", "nullable": true }, "email": { "title": "String", "maxLength": 250, "minLength": 0, "type": "string" }, "notificationSettings": { "$ref": "#/components/schemas/NotificationSettings" }, "brandId": { "title": "String", "type": "string", "nullable": true }, "redirectUrl": { "title": "Uri", "type": "string", "format": "uri", "nullable": true }, "metaData": { "title": "Dictionary`2", "maxLength": 50, "type": "object", "additionalProperties": { "title": "String", "type": "string", "nullable": true }, "nullable": true }, "locale": { "title": "Locales", "enum": [ "EN", "NO", "FR", "DE", "ES", "BG", "CS", "DA", "IT", "NL", "PL", "PT", "RO", "RU", "SV", "Default", "JA", "TH", "ZH_CN", "ZH_TW", "KO" ], "type": "string" } }, "additionalProperties": false }, "CreateTeamRequest": { "title": "CreateTeamRequest", "required": [ "teamName" ], "type": "object", "properties": { "teamName": { "title": "String", "maxLength": 255, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "CreateTemplateRequest": { "title": "CreateTemplateRequest", "required": [ "title" ], "type": "object", "properties": { "title": { "title": "String", "maxLength": 256, "minLength": 0, "type": "string" }, "description": { "title": "String", "maxLength": 5000, "minLength": 0, "type": "string", "nullable": true }, "documentTitle": { "title": "String", "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "documentMessage": { "title": "String", "maxLength": 5000, "minLength": 0, "type": "string", "nullable": true }, "files": { "title": "List`1", "type": "array", "items": { "title": "IFormFile", "type": "string", "format": "binary" }, "nullable": true }, "fileUrls": { "title": "Uri[]", "type": "array", "items": { "title": "Uri", "type": "string", "format": "uri" }, "nullable": true }, "roles": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/TemplateRole" }, "nullable": true }, "allowModifyFiles": { "title": "Boolean", "type": "boolean", "default": true }, "cc": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/DocumentCC" }, "nullable": true }, "brandId": { "title": "String", "type": "string", "nullable": true }, "allowMessageEditing": { "title": "Boolean", "type": "boolean", "default": true }, "allowNewRoles": { "title": "Boolean", "type": "boolean", "default": true }, "allowNewFiles": { "title": "Boolean", "type": "boolean", "default": true }, "enableReassign": { "title": "Boolean", "type": "boolean", "default": true }, "enablePrintAndSign": { "title": "Boolean", "type": "boolean", "default": false }, "enableSigningOrder": { "title": "Boolean", "type": "boolean", "default": false }, "documentInfo": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/DocumentInfo" }, "nullable": true }, "useTextTags": { "title": "Boolean", "type": "boolean", "default": false }, "textTagDefinitions": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/TextTagDefinition" }, "nullable": true }, "autoDetectFields": { "title": "Boolean", "type": "boolean", "default": false }, "onBehalfOf": { "title": "String", "type": "string", "nullable": true }, "labels": { "title": "IEnumerable`1", "type": "array", "items": { "title": "String", "type": "string" }, "nullable": true }, "templateLabels": { "title": "IEnumerable`1", "type": "array", "items": { "title": "String", "type": "string" }, "nullable": true }, "formGroups": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/FormGroup" }, "nullable": true }, "recipientNotificationSettings": { "$ref": "#/components/schemas/RecipientNotificationSettings" }, "allowedSignatureTypes": { "title": "List`1", "type": "array", "items": { "title": "SignatureType", "enum": [ "Text", "Draw", "Image" ], "type": "string" }, "nullable": true }, "formFieldPermission": { "$ref": "#/components/schemas/FormFieldPermission" }, "groupSignerSettings": { "$ref": "#/components/schemas/GroupSignerSettings" }, "enableAllowSignEverywhere": { "title": "Nullable`1", "type": "boolean", "nullable": true }, "documentTimeZone": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateUser": { "title": "CreateUser", "required": [ "emailId" ], "type": "object", "properties": { "emailId": { "title": "String", "minLength": 1, "type": "string" }, "teamId": { "title": "String", "type": "string", "nullable": true }, "userRole": { "title": "UserRoleType", "enum": [ "Admin", "TeamAdmin", "Member" ], "type": "string" }, "metaData": { "title": "Dictionary`2", "maxLength": 50, "type": "object", "additionalProperties": { "title": "String", "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Creators": { "title": "Creators", "type": "object", "properties": { "userId": { "title": "String", "type": "string", "nullable": true }, "createdBy": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomDomainSettings": { "title": "CustomDomainSettings", "type": "object", "properties": { "domainName": { "title": "String", "type": "string", "nullable": true }, "fromName": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomFieldCollection": { "title": "CustomFieldCollection", "type": "object", "properties": { "result": { "title": "List`1", "type": "array", "items": { "$ref": "#/components/schemas/ViewCustomFieldDetails" }, "nullable": true } }, "additionalProperties": false }, "CustomFieldMessage": { "title": "CustomFieldMessage", "type": "object", "properties": { "customFieldId": { "title": "String", "type": "string", "nullable": true }, "message": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomFormField": { "title": "CustomFormField", "required": [ "fieldType" ], "type": "object", "properties": { "fieldType": { "title": "FieldType", "enum": [ "Signature", "Initial", "CheckBox", "TextBox", "Label", "DateSigned", "RadioButton", "Image", "Attachment", "EditableDate", "Hyperlink", "Dropdown", "Title", "Company", "Formula", "Drawing" ], "type": "string" }, "width": { "title": "Single", "type": "number", "format": "float" }, "height": { "title": "Single", "type": "number", "format": "float" }, "isRequired": { "title": "Boolean", "type": "boolean" }, "isReadOnly": { "title": "Boolean", "type": "boolean" }, "value": { "title": "String", "type": "string", "nullable": true }, "fontSize": { "title": "Single", "minimum": 0, "type": "number", "format": "float", "default": 13 }, "font": { "title": "FontFamily", "enum": [ "Helvetica", "Courier", "TimesRoman", "NotoSans", "Carlito" ], "type": "string" }, "fontHexColor": { "title": "String", "type": "string", "nullable": true }, "isBoldFont": { "title": "Boolean", "type": "boolean" }, "isItalicFont": { "title": "Boolean", "type": "boolean" }, "isUnderLineFont": { "title": "Boolean", "type": "boolean" }, "lineHeight": { "title": "Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 15 }, "characterLimit": { "title": "Int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 }, "placeHolder": { "title": "String", "type": "string", "nullable": true }, "validationType": { "title": "ValidationType", "enum": [ "None", "NumbersOnly", "EmailAddress", "Currency", "CustomRegex" ], "type": "string" }, "validationCustomRegex": { "title": "String", "type": "string", "nullable": true }, "validationCustomRegexMessage": { "title": "String", "type": "string", "nullable": true }, "dateFormat": { "title": "String", "type": "string", "nullable": true }, "timeFormat": { "title": "String", "type": "string", "nullable": true }, "imageInfo": { "$ref": "#/components/schemas/ImageInfo" }, "attachmentInfo": { "$ref": "#/components/schemas/AttachmentInfo" }, "editableDateFieldSettings": { "$ref": "#/components/schemas/EditableDateFieldSettings" }, "hyperlinkText": { "title": "String", "type": "string", "nullable": true }, "dataSyncTag": { "title": "String", "type": "string", "nullable": true }, "dropdownOptions": { "title": "String[]", "type": "array", "items": { "title": "String", "type": "string" }, "nullable": true }, "textAlign": { "title": "TextAlign", "enum": [ "Left", "Center", "Right" ], "type": "string" }, "textDirection": { "title": "TextDirection", "enum": [ "LTR", "RTL" ], "type": "string" }, "characterSpacing": { "title": "Single", "type": "number", "format": "float" }, "idPrefix": { "title": "String", "type": "string", "nullable": true }, "restrictIdPrefixChange": { "title": "Boolean", "type": "boolean", "default": false }, "backgroundHexColor": { "title": "String", "type": "string", "nullable": true }, "resizeOption": { "title": "Nullable`1", "enum": [ "GrowVertically", "GrowHorizontally", "GrowBoth", "Fixed", "AutoResizeFont" ], "type": "string", "nullable": true }, "isMasked": { "title": "Nullable`1", "type": "boolean", "default": false, "nullable": true } }, "additionalProperties": false }, "Date": { "title": "Date", "type": "object", "properties": { "day": { "title": "Nullable`1", "type": "integer", "format": "int64", "nullable": true }, "month": { "title": "Nullable`1", "type": "integer", "format": "int64", "nullable": true }, "year": { "title": "Nullable`1", "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "DeleteCustomFieldReply": { "title": "DeleteCustomFieldReply", "type": "object", "properties": { "message": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "Document": { "title": "Document", "type": "object", "properties": { "documentId": { "title": "String", "type": "string", "nullable": true }, "senderDetail": { "$ref": "#/components/schemas/DocumentSenderDetail" }, "ccDetails": { "title": "DocumentCcDetails[]", "type": "array", "items": { "$ref": "#/components/schemas/DocumentCcDetails" }, "nullable": true }, "createdDate": { "title": "Int64", "type": "integer", "format": "int64" }, "activityDate": { "title": "Int64", "type": "integer", "format": "int64" }, "activityBy": { "title": "String", "type": "string", "nullable": true }, "messageTitle": { "title": "String", "type": "string", "nullable": true }, "status": { "title": "DocumentStatus", "enum": [ "InProgress", "Completed", "Declined", "Expired", "Revoked", "Draft", "Scheduled" ], "type": "string" }, "signerDetails": { "title": "DocumentSignerDetails[]", "type": "array", "items": { "$ref": "#/components/schemas/DocumentSignerDetails" }, "nullable": true }, "expiryDate": { "title": "Int64", "type": "integer", "format": "int64" }, "enableSigningOrder": { "title": "Boolean", "type": "boolean" }, "isDeleted": { "title": "Boolean", "type": "boolean" }, "labels": { "title": "List`1", "type": "array", "items": { "title": "String", "type": "string" }, "nullable": true }, "cursor": { "title": "Int64", "type": "integer", "format": "int64" }, "brandId": { "title": "String", "type": "string", "nullable": true }, "scheduledSendTime": { "title": "Nullable`1", "type": "integer", "format": "int64", "nullable": true }, "inEditingMode": { "title": "Boolean", "type": "boolean" }, "displayStatus": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "DocumentCC": { "title": "DocumentCC", "required": [ "emailAddress" ], "type": "object", "properties": { "emailAddress": { "title": "String", "minLength": 1, "type": "string" } }, "additionalProperties": false }, "DocumentCcDetails": { "title": "DocumentCcDetails", "type": "object", "properties": { "emailAddress": { "title": "String", "type": "string", "nullable": true }, "isViewed": { "title": "Boolean", "type": "boolean", "default": false } }, "additionalProperties": false }, "DocumentCcWebhookModel": { "title": "DocumentCcWebhookModel", "type": "object", "properties": { "emailAddress": { "title": "String", "type": "string", "nullable": true }, "id": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "DocumentCreated": { "title": "DocumentCreated", "type": "object", "properties": { "documentId": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "DocumentEdited": { "title": "DocumentEdited", "type": "object", "properties": { "status": { "title": "EditProcessStatus", "enum": [ "Completed", "Queued" ], "type": "string" } }, "additionalProperties": false }, "DocumentEvent": { "title": "DocumentEvent", "type": "object", "properties": { "object": { "title": "String", "type": "string", "nullable": true }, "documentId": { "title": "String", "type": "string", "nullable": true }, "messageTitle": { "title": "String", "type": "string", "nullable": true }, "documentDescription": { "title": "String", "type": "string", "nullable": true }, "status": { "title": "DocumentStatus", "enum": [ "InProgress", "Completed", "Declined", "Expired", "Revoked", "Draft", "Scheduled" ], "type": "string" }, "senderDetail": { "$ref": "#/components/schemas/DocumentSender" }, "signerDetails": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/DocumentSignerWebhookModel" }, "nullable": true }, "ccDetails": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/DocumentCcWebhookModel" }, "nullable": true }, "onBehalfOf": { "title": "String", "type": "string", "nullable": true }, "createdDate": { "title": "Nullable`1", "type": "string", "format": "date-time", "nullable": true }, "expiryDate": { "title": "Nullable`1", "type": "string", "format": "date-time", "nullable": true }, "enableSigningOrder": { "title": "Boolean", "type": "boolean" }, "disableEmails": { "title": "Boolean", "type": "boolean" }, "revokeMessage": { "title": "String", "type": "string", "nullable": true }, "errorMessage": { "title": "String", "type": "string", "nullable": true }, "labels": { "title": "List`1", "type": "array", "items": { "title": "String", "type": "string" }, "nullable": true }, "isCombinedAudit": { "title": "Boolean", "type": "boolean" }, "isCombinedAttachment": { "title": "Boolean", "type": "boolean" }, "BrandId": { "title": "String", "type": "string", "nullable": true }, "documentDownloadOption": { "title": "String", "type": "string", "nullable": true }, "metaData": { "title": "Dictionary`2", "type": "object", "additionalProperties": { "title": "String", "type": "string", "nullable": true }, "nullable": true }, "failedDeliveryMode": { "title": "Nullable`1", "enum": [ "Email", "SMS", "WhatsApp" ], "type": "string", "nullable": true }, "behalfOf": { "$ref": "#/components/schemas/BehalfOfWebhookModel" }, "allowedSignatureTypes": { "title": "List`1", "type": "array", "items": { "title": "SignatureType", "enum": [ "Text", "Draw", "Image" ], "type": "string" }, "nullable": true }, "groupSignerSettings": { "$ref": "#/components/schemas/GroupSignerSettingsWebhookModel" }, "enableAllowSignEverywhere": { "title": "Nullable`1", "type": "boolean", "nullable": true }, "documentTimeZone": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "DocumentExpirySettings": { "title": "DocumentExpirySettings", "type": "object", "properties": { "expiryDateType": { "title": "Nullable`1", "enum": [ "Days", "Hours", "SpecificDateTime" ], "type": "string", "format": "Enumeration", "nullable": true }, "expiryValue": { "title": "Nullable`1", "type": "integer", "format": "int32", "nullable": true }, "enableDefaultExpiryAlert": { "title": "Nullable`1", "type": "boolean", "nullable": true }, "enableAutoReminder": { "title": "Nullable`1", "type": "boolean", "nullable": true }, "reminderDays": { "title": "Nullable`1", "maximum": 180, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "reminderCount": { "title": "Nullable`1", "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "DocumentFiles": { "title": "DocumentFiles", "type": "object", "properties": { "id": { "title": "String", "type": "string", "nullable": true }, "documentName": { "title": "String", "type": "string", "nullable": true }, "order": { "title": "Int32", "type": "integer", "format": "int32" }, "pageCount": { "title": "Int32", "type": "integer", "format": "int32" }, "templateName": { "title": "String", "type": "string", "nullable": true }, "templateId": { "title": "String", "type": "string", "nullable": true } }, "additionalProperties": false }, "DocumentFormFields": { "title": "DocumentFormFields", "type": "object", "properties": { "id": { "title": "String", "type": "string", "nullable": true }, "formFieldId": { "title": "String", "type": "string", "nullable": true }, "type": { "title": "String", "type": "string", "nullable": true }, "value": { "title": "String", "type": "string", "nullable": true }, "font": { "title": "String", "type": "string", "nullable": true }, "isRequired": { "title": "Boolean", "type": "boolean" }, "isReadOnly": { "title": "Boolean", "type": "boolean" }, "lineHeight": { "title": "Single", "type": "number", "format": "float" }, "fontSize": { "title": "Single", "type": "number", "format": "float" }, "fontColor": { "title": "String", "type": "string", "nullable": true }, "isUnderline": { "title": "Boolean", "type": "boolean" }, "isItalic": { "title": "Boolean", "type": "boolean" }, "isBold": { "title": "Boolean", "type": "boolean" }, "groupName": { "title": "String", "type": "string", "nullable": true }, "label": { "title": "String", "type": "string", "nullable": true }, "placeholder": { "title": "String", "type": "string", "nullable": true }, "validationtype": { "title": "ValidationType", "enum": [ "None", "NumbersOnly", "EmailAddress", "Currency", "CustomRegex" ], "type": "string" }, "validationCustomRegex": { "title": "String", "type": "string", "nullable": true }, "validationCustomRegexMessage": { "title": "String", "type": "string", "nullable": true }, "dateFormat": { "title": "String", "type": "string", "nullable": true }, "timeFormat": { "title": "String", "type": "string", "nullable": true }, "imageInfo": { "$ref": "#/components/schemas/ImageInfo" }, "attachmentInfo": { "$ref": "#/components/schemas/AttachmentInfo" }, "fileInfo": { "$ref": "#/components/schemas/FileInfo" }, "editableDateFieldSettings": { "$ref": "#/components/schemas/EditableDateFieldSettings" }, "hyperlinkText": { "title": "String", "type": "string", "nullable": true }, "conditionalRules": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/ConditionalRule" }, "nullable": true }, "bounds": { "$ref": "#/components/schemas/Rectangle" }, "pageNumber": { "title": "Int32", "type": "integer", "format": "int32" }, "dataSyncTag": { "title": "String", "type": "string", "nullable": true }, "dropdownOptions": { "title": "String[]", "type": "array", "items": { "title": "String", "type": "string" }, "nullable": true }, "textAlign": { "title": "TextAlign", "enum": [ "Left", "Center", "Right" ], "type": "string" }, "textDirection": { "title": "TextDirection", "enum": [ "LTR", "RTL" ], "type": "string" }, "characterSpacing": { "title": "Single", "type": "number", "format": "float" }, "backgroundHexColor": { "title": "String", "type": "string", "nullable": true }, "tabIndex": { "title": "Int32", "type": "integer", "format": "int32" }, "formulaFieldSettings": { "$ref": "#/components/schemas/FormulaFieldSettings" }, "resizeOption": { "title": "Nullable`1", "enum": [ "GrowVertically", "GrowHorizontally", "GrowBoth", "Fixed", "AutoResizeFont" ], "type": "string", "nullable": true }, "allowEditFormField": { "title": "Boolean", "type": "boolean" }, "allowDeleteFormField": { "title": "Boolean", "type": "boolean" }, "collaborationSettings": { "$ref": "#/components/schemas/CollaborationSettings" }, "hidden": { "title": "Boolean", "type": "boolean" }, "isMasked": { "title": "Boolean", "type": "boolean", "default": false } }, "additionalProperties": false }, "DocumentGroupSignerWebhookModel": { "title": "DocumentGroupSignerWebhookModel", "type": "object", "properties": { "id": { "title": "String", "type": "string", "nullable": true }, "signerEmail": { "title": "String", "type": "string", "nullable": true }, "signerName": { "title": "String", "type": "string", "nullable": true }, "status": { "title": "SignerStatus", "enum": [ "None", "NotCompleted", "Completed", "Declined", "Revoked", "Expired" ], "type": "string" }, "isViewed": { "title": "Boolean", "type": "boolean" }, "isDeliveryFailed": { "title": "Boolean", "type": "boolean" }, "isAuthenticationFailed": { "title": "Nullable`1", "type": "boolean", "nullable": true }, "lastReminderSentOn": { "title": "Nullable`1", "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DocumentInfo": { "title": "DocumentInfo", "required": [ "locale", "title" ], "type": "object", "properties": { "language": { "title": "Languages", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 ], "type": "integer", "description": "
Description:
Description:
Description:
Description:
Description:
Description: