BoldSign · Schema
BoldSign API Schemas
JSON Schema definitions for all BoldSign eSignature API components
E-SignatureElectronic SignatureDocument ManagementEmbedded SigningWebhooksTemplatesIdentity VerificationCompliance
JSON Schema
{
"$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",
# --- truncated at 32 KB (280 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/boldsign/refs/heads/main/json-schema/boldsign-schemas.json