java.lang.Object
- com.docusign.esign.model.Witness

All Implemented Interfaces:

Serializable
```
public class Witness
extends Object
implements Serializable
```
A complex type containing information about a witness recipient. Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope..

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

Witness()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Witness`	`accessCode(String accessCode)`	accessCode.
`Witness`	`accessCodeMetadata(PropertyMetadata accessCodeMetadata)`	accessCodeMetadata.
`Witness`	`addAccessCodeToEmail(String addAccessCodeToEmail)`	addAccessCodeToEmail.
`Witness`	`addAdditionalNotificationsItem(RecipientAdditionalNotification additionalNotificationsItem)`	addAdditionalNotificationsItem.
`Witness`	`addConsentDetailsListItem(ConsentDetails consentDetailsListItem)`	addConsentDetailsListItem.
`Witness`	`addCustomFieldsItem(String customFieldsItem)`	addCustomFieldsItem.
`Witness`	`addDelegatedToItem(DelegationInfo delegatedToItem)`	addDelegatedToItem.
`Witness`	`addDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)`	addDocumentVisibilityItem.
`Witness`	`addExcludedDocumentsItem(String excludedDocumentsItem)`	addExcludedDocumentsItem.
`Witness`	`additionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)`	additionalNotifications.
`Witness`	`addRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)`	addRecipientAttachmentsItem.
`Witness`	`addRecipientFeatureMetadataItem(FeatureAvailableMetadata recipientFeatureMetadataItem)`	addRecipientFeatureMetadataItem.
`Witness`	`addRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)`	addRecipientSignatureProvidersItem.
`Witness`	`addSigningGroupUsersItem(UserInfo signingGroupUsersItem)`	addSigningGroupUsersItem.
`Witness`	`addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)`	addSocialAuthenticationsItem.
`Witness`	`agentCanEditEmail(String agentCanEditEmail)`	agentCanEditEmail.
`Witness`	`agentCanEditName(String agentCanEditName)`	agentCanEditName.
`Witness`	`allowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)`	allowSystemOverrideForLockedRecipient.
`Witness`	`autoNavigation(String autoNavigation)`	autoNavigation.
`Witness`	`autoRespondedReason(String autoRespondedReason)`	autoRespondedReason.
`Witness`	`bulkRecipientsUri(String bulkRecipientsUri)`	bulkRecipientsUri.
`Witness`	`bulkSendV2Recipient(String bulkSendV2Recipient)`	bulkSendV2Recipient.
`Witness`	`canSignOffline(String canSignOffline)`	canSignOffline.
`Witness`	`clientUserId(String clientUserId)`	clientUserId.
`Witness`	`completedCount(String completedCount)`	completedCount.
`Witness`	`consentDetailsList(List<ConsentDetails> consentDetailsList)`	consentDetailsList.
`Witness`	`creationReason(String creationReason)`	creationReason.
`Witness`	`customFields(List<String> customFields)`	customFields.
`Witness`	`declinedDateTime(String declinedDateTime)`	declinedDateTime.
`Witness`	`declinedReason(String declinedReason)`	declinedReason.
`Witness`	`defaultRecipient(String defaultRecipient)`	defaultRecipient.
`Witness`	`delegatedBy(DelegationInfo delegatedBy)`	delegatedBy.
`Witness`	`delegatedTo(List<DelegationInfo> delegatedTo)`	delegatedTo.
`Witness`	`deliveredDateTime(String deliveredDateTime)`	deliveredDateTime.
`Witness`	`deliveryMethod(String deliveryMethod)`	deliveryMethod.
`Witness`	`deliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)`	deliveryMethodMetadata.
`Witness`	`designatorId(String designatorId)`	designatorId.
`Witness`	`designatorIdGuid(String designatorIdGuid)`	designatorIdGuid.
`Witness`	`documentVisibility(List<DocumentVisibility> documentVisibility)`	documentVisibility.
`Witness`	`email(String email)`	email.
`Witness`	`emailMetadata(PropertyMetadata emailMetadata)`	emailMetadata.
`Witness`	`emailNotification(RecipientEmailNotification emailNotification)`	emailNotification.
`Witness`	`emailRecipientPostSigningURL(String emailRecipientPostSigningURL)`	emailRecipientPostSigningURL.
`Witness`	`embeddedRecipientStartURL(String embeddedRecipientStartURL)`	embeddedRecipientStartURL.
`boolean`	`equals(Object o)`	Compares objects.
`Witness`	`errorDetails(ErrorDetails errorDetails)`	errorDetails.
`Witness`	`excludedDocuments(List<String> excludedDocuments)`	excludedDocuments.
`Witness`	`faxNumber(String faxNumber)`	faxNumber.
`Witness`	`faxNumberMetadata(PropertyMetadata faxNumberMetadata)`	faxNumberMetadata.
`Witness`	`firstName(String firstName)`	firstName.
`Witness`	`firstNameMetadata(PropertyMetadata firstNameMetadata)`	firstNameMetadata.
`Witness`	`fullName(String fullName)`	fullName.
`Witness`	`fullNameMetadata(PropertyMetadata fullNameMetadata)`	fullNameMetadata.
`String`	`getAccessCode()`	If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
`PropertyMetadata`	`getAccessCodeMetadata()`	Metadata that indicates whether the `accessCode` property is editable.
`String`	`getAddAccessCodeToEmail()`	This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient..
`List<RecipientAdditionalNotification>`	`getAdditionalNotifications()`	.
`String`	`getAgentCanEditEmail()`	.
`String`	`getAgentCanEditName()`	.
`String`	`getAllowSystemOverrideForLockedRecipient()`	.
`String`	`getAutoNavigation()`	.
`String`	`getAutoRespondedReason()`	.
`String`	`getBulkRecipientsUri()`	Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information..
`String`	`getBulkSendV2Recipient()`	.
`String`	`getCanSignOffline()`	When set to true, specifies that the signer can perform the signing ceremony offline..
`String`	`getClientUserId()`	Specifies whether the recipient is embedded or remote.
`String`	`getCompletedCount()`	.
`List<ConsentDetails>`	`getConsentDetailsList()`	.
`String`	`getCreationReason()`	.
`List<String>`	`getCustomFields()`	An optional array of strings that allows the sender to provide custom data about the recipient.
`String`	`getDeclinedDateTime()`	The date and time the recipient declined the document..
`String`	`getDeclinedReason()`	The reason the recipient declined the document..
`String`	`getDefaultRecipient()`	.
`DelegationInfo`	`getDelegatedBy()`	.
`List<DelegationInfo>`	`getDelegatedTo()`	.
`String`	`getDeliveredDateTime()`	Reserved: For DocuSign use only..
`String`	`getDeliveryMethod()`	Reserved: For DocuSign use only..
`PropertyMetadata`	`getDeliveryMethodMetadata()`	Reserved for DocuSign..
`String`	`getDesignatorId()`	.
`String`	`getDesignatorIdGuid()`	.
`List<DocumentVisibility>`	`getDocumentVisibility()`	.
`String`	`getEmail()`	.
`PropertyMetadata`	`getEmailMetadata()`	Metadata that indicates whether the `email` property is editable.
`RecipientEmailNotification`	`getEmailNotification()`	A complex type that contains information sets the language of the recipient's email information.
`String`	`getEmailRecipientPostSigningURL()`	.
`String`	`getEmbeddedRecipientStartURL()`	Specifies a sender provided valid URL string for redirecting an embedded recipient.
`ErrorDetails`	`getErrorDetails()`	Array or errors..
`List<String>`	`getExcludedDocuments()`	Specifies the documents that are not visible to this recipient.
`String`	`getFaxNumber()`	Reserved:.
`PropertyMetadata`	`getFaxNumberMetadata()`	Reserved for DocuSign..
`String`	`getFirstName()`	The user's first name.
`PropertyMetadata`	`getFirstNameMetadata()`	Metadata that indicates whether the `firstName` property is editable.
`String`	`getFullName()`	.
`PropertyMetadata`	`getFullNameMetadata()`	Reserved for DocuSign..
`String`	`getIdCheckConfigurationName()`	Specifies authentication check by name.
`PropertyMetadata`	`getIdCheckConfigurationNameMetadata()`	Metadata that indicates whether the `idCheckConfigurationName` property is editable.
`IdCheckInformationInput`	`getIdCheckInformationInput()`	An object that contains input information related to a recipient ID check..
`RecipientIdentityVerification`	`getIdentityVerification()`	Specifies the ID Verification workflow applied on an envelope by workflow ID.
`String`	`getInheritEmailNotificationConfiguration()`	When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
`String`	`getIsBulkRecipient()`	.
`PropertyMetadata`	`getIsBulkRecipientMetadata()`	Reserved for DocuSign..
`String`	`getLastName()`	.
`PropertyMetadata`	`getLastNameMetadata()`	Metadata that indicates whether the `lastName` property is editable.
`String`	`getLockedRecipientPhoneAuthEditable()`	.
`String`	`getLockedRecipientSmsEditable()`	.
`String`	`getName()`	.
`PropertyMetadata`	`getNameMetadata()`	Metadata that indicates whether the `name` property is editable.
`String`	`getNotaryId()`	.
`String`	`getNotarySignerEmailSent()`	.
`String`	`getNote()`	Specifies a note that is unique to this recipient.
`PropertyMetadata`	`getNoteMetadata()`	Metadata that indicates whether the `note` property is editable.
`OfflineAttributes`	`getOfflineAttributes()`	Reserved for DocuSign..
`RecipientPhoneAuthentication`	`getPhoneAuthentication()`	When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details.
`RecipientPhoneNumber`	`getPhoneNumber()`	Describes the recipient phone number..
`RecipientProofFile`	`getProofFile()`	The proof file of the recipient..
`List<RecipientAttachment>`	`getRecipientAttachments()`	Reserved:.
`AuthenticationStatus`	`getRecipientAuthenticationStatus()`	Information about the recipient's authentication status.
`List<FeatureAvailableMetadata>`	`getRecipientFeatureMetadata()`	.
`String`	`getRecipientId()`	Unique for the recipient.
`String`	`getRecipientIdGuid()`	.
`List<RecipientSignatureProvider>`	`getRecipientSignatureProviders()`	.
`String`	`getRecipientSuppliesTabs()`	.
`String`	`getRecipientType()`	.
`PropertyMetadata`	`getRecipientTypeMetadata()`	Metadata that indicates whether the `recipientType` property is editable.
`String`	`getRequireIdLookup()`	When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
`PropertyMetadata`	`getRequireIdLookupMetadata()`	Metadata that indicates whether the `requireIdLookup` property is editable.
`String`	`getRequireSignerCertificate()`	.
`String`	`getRequireSignOnPaper()`	.
`String`	`getRequireUploadSignature()`	.
`String`	`getRoleName()`	Optional element.
`String`	`getRoutingOrder()`	Specifies the routing order of the recipient in the envelope.
`PropertyMetadata`	`getRoutingOrderMetadata()`	Metadata that indicates whether the `routingOrder` property is editable.
`String`	`getSentDateTime()`	The date and time the envelope was sent..
`RecipientSignatureInformation`	`getSignatureInfo()`	Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.
`String`	`getSignedDateTime()`	Reserved: For DocuSign use only.
`String`	`getSignInEachLocation()`	When set to true, specifies that the signer must sign in all locations..
`PropertyMetadata`	`getSignInEachLocationMetadata()`	Metadata that indicates whether the `signInEachLocation` property is editable.
`String`	`getSigningGroupId()`	When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once)..
`PropertyMetadata`	`getSigningGroupIdMetadata()`	Metadata that indicates whether the `signingGroupId` property is editable.
`String`	`getSigningGroupName()`	The display name for the signing group.
`List<UserInfo>`	`getSigningGroupUsers()`	A complex type that contains information about users in the signing group..
`RecipientSMSAuthentication`	`getSmsAuthentication()`	When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details.
`List<SocialAuthentication>`	`getSocialAuthentications()`	Lists the social ID type that can be used for recipient authentication..
`String`	`getStatus()`	Indicates the envelope status.
`String`	`getStatusCode()`	.
`String`	`getSuppressEmails()`	.
`Tabs`	`getTabs()`	A list of tabs, which are represented graphically as symbols on documents at the time of signing.
`String`	`getTemplateLocked()`	When set to true, the sender cannot change any attributes of the recipient.
`String`	`getTemplateRequired()`	When set to true, the sender may not remove the recipient.
`String`	`getTotalTabCount()`	.
`String`	`getUserId()`	.
`String`	`getWitnessFor()`	.
`String`	`getWitnessForGuid()`	.
`int`	`hashCode()`	Returns the HashCode.
`Witness`	`idCheckConfigurationName(String idCheckConfigurationName)`	idCheckConfigurationName.
`Witness`	`idCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)`	idCheckConfigurationNameMetadata.
`Witness`	`idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)`	idCheckInformationInput.
`Witness`	`identityVerification(RecipientIdentityVerification identityVerification)`	identityVerification.
`Witness`	`inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)`	inheritEmailNotificationConfiguration.
`Witness`	`isBulkRecipient(String isBulkRecipient)`	isBulkRecipient.
`Witness`	`isBulkRecipientMetadata(PropertyMetadata isBulkRecipientMetadata)`	isBulkRecipientMetadata.
`Witness`	`lastName(String lastName)`	lastName.
`Witness`	`lastNameMetadata(PropertyMetadata lastNameMetadata)`	lastNameMetadata.
`Witness`	`lockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)`	lockedRecipientPhoneAuthEditable.
`Witness`	`lockedRecipientSmsEditable(String lockedRecipientSmsEditable)`	lockedRecipientSmsEditable.
`Witness`	`name(String name)`	name.
`Witness`	`nameMetadata(PropertyMetadata nameMetadata)`	nameMetadata.
`Witness`	`notaryId(String notaryId)`	notaryId.
`Witness`	`notarySignerEmailSent(String notarySignerEmailSent)`	notarySignerEmailSent.
`Witness`	`note(String note)`	note.
`Witness`	`noteMetadata(PropertyMetadata noteMetadata)`	noteMetadata.
`Witness`	`offlineAttributes(OfflineAttributes offlineAttributes)`	offlineAttributes.
`Witness`	`phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)`	phoneAuthentication.
`Witness`	`phoneNumber(RecipientPhoneNumber phoneNumber)`	phoneNumber.
`Witness`	`proofFile(RecipientProofFile proofFile)`	proofFile.
`Witness`	`recipientAttachments(List<RecipientAttachment> recipientAttachments)`	recipientAttachments.
`Witness`	`recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)`	recipientAuthenticationStatus.
`Witness`	`recipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)`	recipientFeatureMetadata.
`Witness`	`recipientId(String recipientId)`	recipientId.
`Witness`	`recipientIdGuid(String recipientIdGuid)`	recipientIdGuid.
`Witness`	`recipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)`	recipientSignatureProviders.
`Witness`	`recipientSuppliesTabs(String recipientSuppliesTabs)`	recipientSuppliesTabs.
`Witness`	`recipientType(String recipientType)`	recipientType.
`Witness`	`recipientTypeMetadata(PropertyMetadata recipientTypeMetadata)`	recipientTypeMetadata.
`Witness`	`requireIdLookup(String requireIdLookup)`	requireIdLookup.
`Witness`	`requireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)`	requireIdLookupMetadata.
`Witness`	`requireSignerCertificate(String requireSignerCertificate)`	requireSignerCertificate.
`Witness`	`requireSignOnPaper(String requireSignOnPaper)`	requireSignOnPaper.
`Witness`	`requireUploadSignature(String requireUploadSignature)`	requireUploadSignature.
`Witness`	`roleName(String roleName)`	roleName.
`Witness`	`routingOrder(String routingOrder)`	routingOrder.
`Witness`	`routingOrderMetadata(PropertyMetadata routingOrderMetadata)`	routingOrderMetadata.
`Witness`	`sentDateTime(String sentDateTime)`	sentDateTime.
`void`	`setAccessCode(String accessCode)`	setAccessCode.
`void`	`setAccessCodeMetadata(PropertyMetadata accessCodeMetadata)`	setAccessCodeMetadata.
`void`	`setAddAccessCodeToEmail(String addAccessCodeToEmail)`	setAddAccessCodeToEmail.
`void`	`setAdditionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)`	setAdditionalNotifications.
`void`	`setAgentCanEditEmail(String agentCanEditEmail)`	setAgentCanEditEmail.
`void`	`setAgentCanEditName(String agentCanEditName)`	setAgentCanEditName.
`void`	`setAllowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)`	setAllowSystemOverrideForLockedRecipient.
`void`	`setAutoNavigation(String autoNavigation)`	setAutoNavigation.
`void`	`setAutoRespondedReason(String autoRespondedReason)`	setAutoRespondedReason.
`void`	`setBulkRecipientsUri(String bulkRecipientsUri)`	setBulkRecipientsUri.
`void`	`setBulkSendV2Recipient(String bulkSendV2Recipient)`	setBulkSendV2Recipient.
`void`	`setCanSignOffline(String canSignOffline)`	setCanSignOffline.
`void`	`setClientUserId(String clientUserId)`	setClientUserId.
`void`	`setCompletedCount(String completedCount)`	setCompletedCount.
`void`	`setConsentDetailsList(List<ConsentDetails> consentDetailsList)`	setConsentDetailsList.
`void`	`setCreationReason(String creationReason)`	setCreationReason.
`void`	`setCustomFields(List<String> customFields)`	setCustomFields.
`void`	`setDeclinedDateTime(String declinedDateTime)`	setDeclinedDateTime.
`void`	`setDeclinedReason(String declinedReason)`	setDeclinedReason.
`void`	`setDefaultRecipient(String defaultRecipient)`	setDefaultRecipient.
`void`	`setDelegatedBy(DelegationInfo delegatedBy)`	setDelegatedBy.
`void`	`setDelegatedTo(List<DelegationInfo> delegatedTo)`	setDelegatedTo.
`void`	`setDeliveredDateTime(String deliveredDateTime)`	setDeliveredDateTime.
`void`	`setDeliveryMethod(String deliveryMethod)`	setDeliveryMethod.
`void`	`setDeliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)`	setDeliveryMethodMetadata.
`void`	`setDesignatorId(String designatorId)`	setDesignatorId.
`void`	`setDesignatorIdGuid(String designatorIdGuid)`	setDesignatorIdGuid.
`void`	`setDocumentVisibility(List<DocumentVisibility> documentVisibility)`	setDocumentVisibility.
`void`	`setEmail(String email)`	setEmail.
`void`	`setEmailMetadata(PropertyMetadata emailMetadata)`	setEmailMetadata.
`void`	`setEmailNotification(RecipientEmailNotification emailNotification)`	setEmailNotification.
`void`	`setEmailRecipientPostSigningURL(String emailRecipientPostSigningURL)`	setEmailRecipientPostSigningURL.
`void`	`setEmbeddedRecipientStartURL(String embeddedRecipientStartURL)`	setEmbeddedRecipientStartURL.
`void`	`setErrorDetails(ErrorDetails errorDetails)`	setErrorDetails.
`void`	`setExcludedDocuments(List<String> excludedDocuments)`	setExcludedDocuments.
`void`	`setFaxNumber(String faxNumber)`	setFaxNumber.
`void`	`setFaxNumberMetadata(PropertyMetadata faxNumberMetadata)`	setFaxNumberMetadata.
`void`	`setFirstName(String firstName)`	setFirstName.
`void`	`setFirstNameMetadata(PropertyMetadata firstNameMetadata)`	setFirstNameMetadata.
`void`	`setFullName(String fullName)`	setFullName.
`void`	`setFullNameMetadata(PropertyMetadata fullNameMetadata)`	setFullNameMetadata.
`void`	`setIdCheckConfigurationName(String idCheckConfigurationName)`	setIdCheckConfigurationName.
`void`	`setIdCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)`	setIdCheckConfigurationNameMetadata.
`void`	`setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)`	setIdCheckInformationInput.
`void`	`setIdentityVerification(RecipientIdentityVerification identityVerification)`	setIdentityVerification.
`void`	`setInheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)`	setInheritEmailNotificationConfiguration.
`void`	`setIsBulkRecipient(String isBulkRecipient)`	setIsBulkRecipient.
`void`	`setIsBulkRecipientMetadata(PropertyMetadata isBulkRecipientMetadata)`	setIsBulkRecipientMetadata.
`void`	`setLastName(String lastName)`	setLastName.
`void`	`setLastNameMetadata(PropertyMetadata lastNameMetadata)`	setLastNameMetadata.
`void`	`setLockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)`	setLockedRecipientPhoneAuthEditable.
`void`	`setLockedRecipientSmsEditable(String lockedRecipientSmsEditable)`	setLockedRecipientSmsEditable.
`void`	`setName(String name)`	setName.
`void`	`setNameMetadata(PropertyMetadata nameMetadata)`	setNameMetadata.
`void`	`setNotaryId(String notaryId)`	setNotaryId.
`void`	`setNotarySignerEmailSent(String notarySignerEmailSent)`	setNotarySignerEmailSent.
`void`	`setNote(String note)`	setNote.
`void`	`setNoteMetadata(PropertyMetadata noteMetadata)`	setNoteMetadata.
`void`	`setOfflineAttributes(OfflineAttributes offlineAttributes)`	setOfflineAttributes.
`void`	`setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)`	setPhoneAuthentication.
`void`	`setPhoneNumber(RecipientPhoneNumber phoneNumber)`	setPhoneNumber.
`void`	`setProofFile(RecipientProofFile proofFile)`	setProofFile.
`void`	`setRecipientAttachments(List<RecipientAttachment> recipientAttachments)`	setRecipientAttachments.
`void`	`setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)`	setRecipientAuthenticationStatus.
`void`	`setRecipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)`	setRecipientFeatureMetadata.
`void`	`setRecipientId(String recipientId)`	setRecipientId.
`void`	`setRecipientIdGuid(String recipientIdGuid)`	setRecipientIdGuid.
`void`	`setRecipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)`	setRecipientSignatureProviders.
`void`	`setRecipientSuppliesTabs(String recipientSuppliesTabs)`	setRecipientSuppliesTabs.
`void`	`setRecipientType(String recipientType)`	setRecipientType.
`void`	`setRecipientTypeMetadata(PropertyMetadata recipientTypeMetadata)`	setRecipientTypeMetadata.
`void`	`setRequireIdLookup(String requireIdLookup)`	setRequireIdLookup.
`void`	`setRequireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)`	setRequireIdLookupMetadata.
`void`	`setRequireSignerCertificate(String requireSignerCertificate)`	setRequireSignerCertificate.
`void`	`setRequireSignOnPaper(String requireSignOnPaper)`	setRequireSignOnPaper.
`void`	`setRequireUploadSignature(String requireUploadSignature)`	setRequireUploadSignature.
`void`	`setRoleName(String roleName)`	setRoleName.
`void`	`setRoutingOrder(String routingOrder)`	setRoutingOrder.
`void`	`setRoutingOrderMetadata(PropertyMetadata routingOrderMetadata)`	setRoutingOrderMetadata.
`void`	`setSentDateTime(String sentDateTime)`	setSentDateTime.
`void`	`setSignatureInfo(RecipientSignatureInformation signatureInfo)`	setSignatureInfo.
`void`	`setSignedDateTime(String signedDateTime)`	setSignedDateTime.
`void`	`setSignInEachLocation(String signInEachLocation)`	setSignInEachLocation.
`void`	`setSignInEachLocationMetadata(PropertyMetadata signInEachLocationMetadata)`	setSignInEachLocationMetadata.
`void`	`setSigningGroupId(String signingGroupId)`	setSigningGroupId.
`void`	`setSigningGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)`	setSigningGroupIdMetadata.
`void`	`setSigningGroupName(String signingGroupName)`	setSigningGroupName.
`void`	`setSigningGroupUsers(List<UserInfo> signingGroupUsers)`	setSigningGroupUsers.
`void`	`setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)`	setSmsAuthentication.
`void`	`setSocialAuthentications(List<SocialAuthentication> socialAuthentications)`	setSocialAuthentications.
`void`	`setStatus(String status)`	setStatus.
`void`	`setStatusCode(String statusCode)`	setStatusCode.
`void`	`setSuppressEmails(String suppressEmails)`	setSuppressEmails.
`void`	`setTabs(Tabs tabs)`	setTabs.
`void`	`setTemplateLocked(String templateLocked)`	setTemplateLocked.
`void`	`setTemplateRequired(String templateRequired)`	setTemplateRequired.
`void`	`setTotalTabCount(String totalTabCount)`	setTotalTabCount.
`void`	`setUserId(String userId)`	setUserId.
`void`	`setWitnessFor(String witnessFor)`	setWitnessFor.
`void`	`setWitnessForGuid(String witnessForGuid)`	setWitnessForGuid.
`Witness`	`signatureInfo(RecipientSignatureInformation signatureInfo)`	signatureInfo.
`Witness`	`signedDateTime(String signedDateTime)`	signedDateTime.
`Witness`	`signInEachLocation(String signInEachLocation)`	signInEachLocation.
`Witness`	`signInEachLocationMetadata(PropertyMetadata signInEachLocationMetadata)`	signInEachLocationMetadata.
`Witness`	`signingGroupId(String signingGroupId)`	signingGroupId.
`Witness`	`signingGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)`	signingGroupIdMetadata.
`Witness`	`signingGroupName(String signingGroupName)`	signingGroupName.
`Witness`	`signingGroupUsers(List<UserInfo> signingGroupUsers)`	signingGroupUsers.
`Witness`	`smsAuthentication(RecipientSMSAuthentication smsAuthentication)`	smsAuthentication.
`Witness`	`socialAuthentications(List<SocialAuthentication> socialAuthentications)`	socialAuthentications.
`Witness`	`status(String status)`	status.
`Witness`	`statusCode(String statusCode)`	statusCode.
`Witness`	`suppressEmails(String suppressEmails)`	suppressEmails.
`Witness`	`tabs(Tabs tabs)`	tabs.
`Witness`	`templateLocked(String templateLocked)`	templateLocked.
`Witness`	`templateRequired(String templateRequired)`	templateRequired.
`String`	`toString()`	Converts the given object to string.
`Witness`	`totalTabCount(String totalTabCount)`	totalTabCount.
`Witness`	`userId(String userId)`	userId.
`Witness`	`witnessFor(String witnessFor)`	witnessFor.
`Witness`	`witnessForGuid(String witnessForGuid)`	witnessForGuid.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Witness
```
public Witness()
```
- Method Detail
  - accessCode
```
public Witness accessCode(String accessCode)
```
    accessCode.
    
    Returns:
    
    Witness
  - getAccessCode
```
public String getAccessCode()
```
    If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required..
    
    Returns:
    
    accessCode
  - setAccessCode
```
public void setAccessCode(String accessCode)
```
    setAccessCode.
  - accessCodeMetadata
```
public Witness accessCodeMetadata(PropertyMetadata accessCodeMetadata)
```
    accessCodeMetadata.
    
    Returns:
    
    Witness
  - getAccessCodeMetadata
```
public PropertyMetadata getAccessCodeMetadata()
```
    Metadata that indicates whether the `accessCode` property is editable. This property is read-only..
    
    Returns:
    
    accessCodeMetadata
  - setAccessCodeMetadata
```
public void setAccessCodeMetadata(PropertyMetadata accessCodeMetadata)
```
    setAccessCodeMetadata.
  - addAccessCodeToEmail
```
public Witness addAccessCodeToEmail(String addAccessCodeToEmail)
```
    addAccessCodeToEmail.
    
    Returns:
    
    Witness
  - getAddAccessCodeToEmail
```
public String getAddAccessCodeToEmail()
```
    This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient..
    
    Returns:
    
    addAccessCodeToEmail
  - setAddAccessCodeToEmail
```
public void setAddAccessCodeToEmail(String addAccessCodeToEmail)
```
    setAddAccessCodeToEmail.
  - additionalNotifications
```
public Witness additionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)
```
    additionalNotifications.
    
    Returns:
    
    Witness
  - addAdditionalNotificationsItem
```
public Witness addAdditionalNotificationsItem(RecipientAdditionalNotification additionalNotificationsItem)
```
    addAdditionalNotificationsItem.
    
    Returns:
    
    Witness
  - getAdditionalNotifications
```
public List<RecipientAdditionalNotification> getAdditionalNotifications()
```
    .
    
    Returns:
    
    additionalNotifications
  - setAdditionalNotifications
```
public void setAdditionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)
```
    setAdditionalNotifications.
  - agentCanEditEmail
```
public Witness agentCanEditEmail(String agentCanEditEmail)
```
    agentCanEditEmail.
    
    Returns:
    
    Witness
  - getAgentCanEditEmail
```
public String getAgentCanEditEmail()
```
    .
    
    Returns:
    
    agentCanEditEmail
  - setAgentCanEditEmail
```
public void setAgentCanEditEmail(String agentCanEditEmail)
```
    setAgentCanEditEmail.
  - agentCanEditName
```
public Witness agentCanEditName(String agentCanEditName)
```
    agentCanEditName.
    
    Returns:
    
    Witness
  - getAgentCanEditName
```
public String getAgentCanEditName()
```
    .
    
    Returns:
    
    agentCanEditName
  - setAgentCanEditName
```
public void setAgentCanEditName(String agentCanEditName)
```
    setAgentCanEditName.
  - allowSystemOverrideForLockedRecipient
```
public Witness allowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)
```
    allowSystemOverrideForLockedRecipient.
    
    Returns:
    
    Witness
  - getAllowSystemOverrideForLockedRecipient
```
public String getAllowSystemOverrideForLockedRecipient()
```
    .
    
    Returns:
    
    allowSystemOverrideForLockedRecipient
  - setAllowSystemOverrideForLockedRecipient
```
public void setAllowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)
```
    setAllowSystemOverrideForLockedRecipient.
  - autoNavigation
```
public Witness autoNavigation(String autoNavigation)
```
    autoNavigation.
    
    Returns:
    
    Witness
  - getAutoNavigation
```
public String getAutoNavigation()
```
    .
    
    Returns:
    
    autoNavigation
  - setAutoNavigation
```
public void setAutoNavigation(String autoNavigation)
```
    setAutoNavigation.
  - autoRespondedReason
```
public Witness autoRespondedReason(String autoRespondedReason)
```
    autoRespondedReason.
    
    Returns:
    
    Witness
  - getAutoRespondedReason
```
public String getAutoRespondedReason()
```
    .
    
    Returns:
    
    autoRespondedReason
  - setAutoRespondedReason
```
public void setAutoRespondedReason(String autoRespondedReason)
```
    setAutoRespondedReason.
  - bulkRecipientsUri
```
public Witness bulkRecipientsUri(String bulkRecipientsUri)
```
    bulkRecipientsUri.
    
    Returns:
    
    Witness
  - getBulkRecipientsUri
```
public String getBulkRecipientsUri()
```
    Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information..
    
    Returns:
    
    bulkRecipientsUri
  - setBulkRecipientsUri
```
public void setBulkRecipientsUri(String bulkRecipientsUri)
```
    setBulkRecipientsUri.
  - bulkSendV2Recipient
```
public Witness bulkSendV2Recipient(String bulkSendV2Recipient)
```
    bulkSendV2Recipient.
    
    Returns:
    
    Witness
  - getBulkSendV2Recipient
```
public String getBulkSendV2Recipient()
```
    .
    
    Returns:
    
    bulkSendV2Recipient
  - setBulkSendV2Recipient
```
public void setBulkSendV2Recipient(String bulkSendV2Recipient)
```
    setBulkSendV2Recipient.
  - canSignOffline
```
public Witness canSignOffline(String canSignOffline)
```
    canSignOffline.
    
    Returns:
    
    Witness
  - getCanSignOffline
```
public String getCanSignOffline()
```
    When set to **true**, specifies that the signer can perform the signing ceremony offline..
    
    Returns:
    
    canSignOffline
  - setCanSignOffline
```
public void setCanSignOffline(String canSignOffline)
```
    setCanSignOffline.
  - clientUserId
```
public Witness clientUserId(String clientUserId)
```
    clientUserId.
    
    Returns:
    
    Witness
  - getClientUserId
```
public String getClientUserId()
```
    Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. .
    
    Returns:
    
    clientUserId
  - setClientUserId
```
public void setClientUserId(String clientUserId)
```
    setClientUserId.
  - completedCount
```
public Witness completedCount(String completedCount)
```
    completedCount.
    
    Returns:
    
    Witness
  - getCompletedCount
```
public String getCompletedCount()
```
    .
    
    Returns:
    
    completedCount
  - setCompletedCount
```
public void setCompletedCount(String completedCount)
```
    setCompletedCount.
  - consentDetailsList
```
public Witness consentDetailsList(List<ConsentDetails> consentDetailsList)
```
    consentDetailsList.
    
    Returns:
    
    Witness
  - addConsentDetailsListItem
```
public Witness addConsentDetailsListItem(ConsentDetails consentDetailsListItem)
```
    addConsentDetailsListItem.
    
    Returns:
    
    Witness
  - getConsentDetailsList
```
public List<ConsentDetails> getConsentDetailsList()
```
    .
    
    Returns:
    
    consentDetailsList
  - setConsentDetailsList
```
public void setConsentDetailsList(List<ConsentDetails> consentDetailsList)
```
    setConsentDetailsList.
  - creationReason
```
public Witness creationReason(String creationReason)
```
    creationReason.
    
    Returns:
    
    Witness
  - getCreationReason
```
public String getCreationReason()
```
    .
    
    Returns:
    
    creationReason
  - setCreationReason
```
public void setCreationReason(String creationReason)
```
    setCreationReason.
  - customFields
```
public Witness customFields(List<String> customFields)
```
    customFields.
    
    Returns:
    
    Witness
  - addCustomFieldsItem
```
public Witness addCustomFieldsItem(String customFieldsItem)
```
    addCustomFieldsItem.
    
    Returns:
    
    Witness
  - getCustomFields
```
public List<String> getCustomFields()
```
    An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters..
    
    Returns:
    
    customFields
  - setCustomFields
```
public void setCustomFields(List<String> customFields)
```
    setCustomFields.
  - declinedDateTime
```
public Witness declinedDateTime(String declinedDateTime)
```
    declinedDateTime.
    
    Returns:
    
    Witness
  - getDeclinedDateTime
```
public String getDeclinedDateTime()
```
    The date and time the recipient declined the document..
    
    Returns:
    
    declinedDateTime
  - setDeclinedDateTime
```
public void setDeclinedDateTime(String declinedDateTime)
```
    setDeclinedDateTime.
  - declinedReason
```
public Witness declinedReason(String declinedReason)
```
    declinedReason.
    
    Returns:
    
    Witness
  - getDeclinedReason
```
public String getDeclinedReason()
```
    The reason the recipient declined the document..
    
    Returns:
    
    declinedReason
  - setDeclinedReason
```
public void setDeclinedReason(String declinedReason)
```
    setDeclinedReason.
  - defaultRecipient
```
public Witness defaultRecipient(String defaultRecipient)
```
    defaultRecipient.
    
    Returns:
    
    Witness
  - getDefaultRecipient
```
public String getDefaultRecipient()
```
    .
    
    Returns:
    
    defaultRecipient
  - setDefaultRecipient
```
public void setDefaultRecipient(String defaultRecipient)
```
    setDefaultRecipient.
  - delegatedBy
```
public Witness delegatedBy(DelegationInfo delegatedBy)
```
    delegatedBy.
    
    Returns:
    
    Witness
  - getDelegatedBy
```
public DelegationInfo getDelegatedBy()
```
    .
    
    Returns:
    
    delegatedBy
  - setDelegatedBy
```
public void setDelegatedBy(DelegationInfo delegatedBy)
```
    setDelegatedBy.
  - delegatedTo
```
public Witness delegatedTo(List<DelegationInfo> delegatedTo)
```
    delegatedTo.
    
    Returns:
    
    Witness
  - addDelegatedToItem
```
public Witness addDelegatedToItem(DelegationInfo delegatedToItem)
```
    addDelegatedToItem.
    
    Returns:
    
    Witness
  - getDelegatedTo
```
public List<DelegationInfo> getDelegatedTo()
```
    .
    
    Returns:
    
    delegatedTo
  - setDelegatedTo
```
public void setDelegatedTo(List<DelegationInfo> delegatedTo)
```
    setDelegatedTo.
  - deliveredDateTime
```
public Witness deliveredDateTime(String deliveredDateTime)
```
    deliveredDateTime.
    
    Returns:
    
    Witness
  - getDeliveredDateTime
```
public String getDeliveredDateTime()
```
    Reserved: For DocuSign use only..
    
    Returns:
    
    deliveredDateTime
  - setDeliveredDateTime
```
public void setDeliveredDateTime(String deliveredDateTime)
```
    setDeliveredDateTime.
  - deliveryMethod
```
public Witness deliveryMethod(String deliveryMethod)
```
    deliveryMethod.
    
    Returns:
    
    Witness
  - getDeliveryMethod
```
public String getDeliveryMethod()
```
    Reserved: For DocuSign use only..
    
    Returns:
    
    deliveryMethod
  - setDeliveryMethod
```
public void setDeliveryMethod(String deliveryMethod)
```
    setDeliveryMethod.
  - deliveryMethodMetadata
```
public Witness deliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)
```
    deliveryMethodMetadata.
    
    Returns:
    
    Witness
  - getDeliveryMethodMetadata
```
public PropertyMetadata getDeliveryMethodMetadata()
```
    Reserved for DocuSign..
    
    Returns:
    
    deliveryMethodMetadata
  - setDeliveryMethodMetadata
```
public void setDeliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)
```
    setDeliveryMethodMetadata.
  - designatorId
```
public Witness designatorId(String designatorId)
```
    designatorId.
    
    Returns:
    
    Witness
  - getDesignatorId
```
public String getDesignatorId()
```
    .
    
    Returns:
    
    designatorId
  - setDesignatorId
```
public void setDesignatorId(String designatorId)
```
    setDesignatorId.
  - designatorIdGuid
```
public Witness designatorIdGuid(String designatorIdGuid)
```
    designatorIdGuid.
    
    Returns:
    
    Witness
  - getDesignatorIdGuid
```
public String getDesignatorIdGuid()
```
    .
    
    Returns:
    
    designatorIdGuid
  - setDesignatorIdGuid
```
public void setDesignatorIdGuid(String designatorIdGuid)
```
    setDesignatorIdGuid.
  - documentVisibility
```
public Witness documentVisibility(List<DocumentVisibility> documentVisibility)
```
    documentVisibility.
    
    Returns:
    
    Witness
  - addDocumentVisibilityItem
```
public Witness addDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)
```
    addDocumentVisibilityItem.
    
    Returns:
    
    Witness
  - getDocumentVisibility
```
public List<DocumentVisibility> getDocumentVisibility()
```
    .
    
    Returns:
    
    documentVisibility
  - setDocumentVisibility
```
public void setDocumentVisibility(List<DocumentVisibility> documentVisibility)
```
    setDocumentVisibility.
  - email
```
public Witness email(String email)
```
    email.
    
    Returns:
    
    Witness
  - getEmail
```
public String getEmail()
```
    .
    
    Returns:
    
    email
  - setEmail
```
public void setEmail(String email)
```
    setEmail.
  - emailMetadata
```
public Witness emailMetadata(PropertyMetadata emailMetadata)
```
    emailMetadata.
    
    Returns:
    
    Witness
  - getEmailMetadata
```
public PropertyMetadata getEmailMetadata()
```
    Metadata that indicates whether the `email` property is editable. This property is read-only..
    
    Returns:
    
    emailMetadata
  - setEmailMetadata
```
public void setEmailMetadata(PropertyMetadata emailMetadata)
```
    setEmailMetadata.
  - emailNotification
```
public Witness emailNotification(RecipientEmailNotification emailNotification)
```
    emailNotification.
    
    Returns:
    
    Witness
  - getEmailNotification
```
public RecipientEmailNotification getEmailNotification()
```
    A complex type that contains information sets the language of the recipient's email information. **IMPORTANT**: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and `EmailBlurb` property settings. .
    
    Returns:
    
    emailNotification
  - setEmailNotification
```
public void setEmailNotification(RecipientEmailNotification emailNotification)
```
    setEmailNotification.
  - emailRecipientPostSigningURL
```
public Witness emailRecipientPostSigningURL(String emailRecipientPostSigningURL)
```
    emailRecipientPostSigningURL.
    
    Returns:
    
    Witness
  - getEmailRecipientPostSigningURL
```
public String getEmailRecipientPostSigningURL()
```
    .
    
    Returns:
    
    emailRecipientPostSigningURL
  - setEmailRecipientPostSigningURL
```
public void setEmailRecipientPostSigningURL(String emailRecipientPostSigningURL)
```
    setEmailRecipientPostSigningURL.
  - embeddedRecipientStartURL
```
public Witness embeddedRecipientStartURL(String embeddedRecipientStartURL)
```
    embeddedRecipientStartURL.
    
    Returns:
    
    Witness
  - getEmbeddedRecipientStartURL
```
public String getEmbeddedRecipientStartURL()
```
    Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` .
    
    Returns:
    
    embeddedRecipientStartURL
  - setEmbeddedRecipientStartURL
```
public void setEmbeddedRecipientStartURL(String embeddedRecipientStartURL)
```
    setEmbeddedRecipientStartURL.
  - errorDetails
```
public Witness errorDetails(ErrorDetails errorDetails)
```
    errorDetails.
    
    Returns:
    
    Witness
  - getErrorDetails
```
public ErrorDetails getErrorDetails()
```
    Array or errors..
    
    Returns:
    
    errorDetails
  - setErrorDetails
```
public void setErrorDetails(ErrorDetails errorDetails)
```
    setErrorDetails.
  - excludedDocuments
```
public Witness excludedDocuments(List<String> excludedDocuments)
```
    excludedDocuments.
    
    Returns:
    
    Witness
  - addExcludedDocumentsItem
```
public Witness addExcludedDocumentsItem(String excludedDocumentsItem)
```
    addExcludedDocumentsItem.
    
    Returns:
    
    Witness
  - getExcludedDocuments
```
public List<String> getExcludedDocuments()
```
    Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent..
    
    Returns:
    
    excludedDocuments
  - setExcludedDocuments
```
public void setExcludedDocuments(List<String> excludedDocuments)
```
    setExcludedDocuments.
  - faxNumber
```
public Witness faxNumber(String faxNumber)
```
    faxNumber.
    
    Returns:
    
    Witness
  - getFaxNumber
```
public String getFaxNumber()
```
    Reserved:.
    
    Returns:
    
    faxNumber
  - setFaxNumber
```
public void setFaxNumber(String faxNumber)
```
    setFaxNumber.
  - faxNumberMetadata
```
public Witness faxNumberMetadata(PropertyMetadata faxNumberMetadata)
```
    faxNumberMetadata.
    
    Returns:
    
    Witness
  - getFaxNumberMetadata
```
public PropertyMetadata getFaxNumberMetadata()
```
    Reserved for DocuSign..
    
    Returns:
    
    faxNumberMetadata
  - setFaxNumberMetadata
```
public void setFaxNumberMetadata(PropertyMetadata faxNumberMetadata)
```
    setFaxNumberMetadata.
  - firstName
```
public Witness firstName(String firstName)
```
    firstName.
    
    Returns:
    
    Witness
  - getFirstName
```
public String getFirstName()
```
    The user's first name. Maximum Length: 50 characters..
    
    Returns:
    
    firstName
  - setFirstName
```
public void setFirstName(String firstName)
```
    setFirstName.
  - firstNameMetadata
```
public Witness firstNameMetadata(PropertyMetadata firstNameMetadata)
```
    firstNameMetadata.
    
    Returns:
    
    Witness
  - getFirstNameMetadata
```
public PropertyMetadata getFirstNameMetadata()
```
    Metadata that indicates whether the `firstName` property is editable. This property is read-only..
    
    Returns:
    
    firstNameMetadata
  - setFirstNameMetadata
```
public void setFirstNameMetadata(PropertyMetadata firstNameMetadata)
```
    setFirstNameMetadata.
  - fullName
```
public Witness fullName(String fullName)
```
    fullName.
    
    Returns:
    
    Witness
  - getFullName
```
public String getFullName()
```
    .
    
    Returns:
    
    fullName
  - setFullName
```
public void setFullName(String fullName)
```
    setFullName.
  - fullNameMetadata
```
public Witness fullNameMetadata(PropertyMetadata fullNameMetadata)
```
    fullNameMetadata.
    
    Returns:
    
    Witness
  - getFullNameMetadata
```
public PropertyMetadata getFullNameMetadata()
```
    Reserved for DocuSign..
    
    Returns:
    
    fullNameMetadata
  - setFullNameMetadata
```
public void setFullNameMetadata(PropertyMetadata fullNameMetadata)
```
    setFullNameMetadata.
  - idCheckConfigurationName
```
public Witness idCheckConfigurationName(String idCheckConfigurationName)
```
    idCheckConfigurationName.
    
    Returns:
    
    Witness
  - getIdCheckConfigurationName
```
public String getIdCheckConfigurationName()
```
    Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node..
    
    Returns:
    
    idCheckConfigurationName
  - setIdCheckConfigurationName
```
public void setIdCheckConfigurationName(String idCheckConfigurationName)
```
    setIdCheckConfigurationName.
  - idCheckConfigurationNameMetadata
```
public Witness idCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)
```
    idCheckConfigurationNameMetadata.
    
    Returns:
    
    Witness
  - getIdCheckConfigurationNameMetadata
```
public PropertyMetadata getIdCheckConfigurationNameMetadata()
```
    Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only..
    
    Returns:
    
    idCheckConfigurationNameMetadata
  - setIdCheckConfigurationNameMetadata
```
public void setIdCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)
```
    setIdCheckConfigurationNameMetadata.
  - idCheckInformationInput
```
public Witness idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
```
    idCheckInformationInput.
    
    Returns:
    
    Witness
  - getIdCheckInformationInput
```
public IdCheckInformationInput getIdCheckInformationInput()
```
    An object that contains input information related to a recipient ID check..
    
    Returns:
    
    idCheckInformationInput
  - setIdCheckInformationInput
```
public void setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
```
    setIdCheckInformationInput.
  - identityVerification
```
public Witness identityVerification(RecipientIdentityVerification identityVerification)
```
    identityVerification.
    
    Returns:
    
    Witness
  - getIdentityVerification
```
public RecipientIdentityVerification getIdentityVerification()
```
    Specifies the ID Verification workflow applied on an envelope by workflow ID.
    See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account.
    This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
    Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)..
    
    Returns:
    
    identityVerification
  - setIdentityVerification
```
public void setIdentityVerification(RecipientIdentityVerification identityVerification)
```
    setIdentityVerification.
  - inheritEmailNotificationConfiguration
```
public Witness inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)
```
    inheritEmailNotificationConfiguration.
    
    Returns:
    
    Witness
  - getInheritEmailNotificationConfiguration
```
public String getInheritEmailNotificationConfiguration()
```
    When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. .
    
    Returns:
    
    inheritEmailNotificationConfiguration
  - setInheritEmailNotificationConfiguration
```
public void setInheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)
```
    setInheritEmailNotificationConfiguration.
  - isBulkRecipient
```
public Witness isBulkRecipient(String isBulkRecipient)
```
    isBulkRecipient.
    
    Returns:
    
    Witness
  - getIsBulkRecipient
```
public String getIsBulkRecipient()
```
    .
    
    Returns:
    
    isBulkRecipient
  - setIsBulkRecipient
```
public void setIsBulkRecipient(String isBulkRecipient)
```
    setIsBulkRecipient.
  - isBulkRecipientMetadata
```
public Witness isBulkRecipientMetadata(PropertyMetadata isBulkRecipientMetadata)
```
    isBulkRecipientMetadata.
    
    Returns:
    
    Witness
  - getIsBulkRecipientMetadata
```
public PropertyMetadata getIsBulkRecipientMetadata()
```
    Reserved for DocuSign..
    
    Returns:
    
    isBulkRecipientMetadata
  - setIsBulkRecipientMetadata
```
public void setIsBulkRecipientMetadata(PropertyMetadata isBulkRecipientMetadata)
```
    setIsBulkRecipientMetadata.
  - lastName
```
public Witness lastName(String lastName)
```
    lastName.
    
    Returns:
    
    Witness
  - getLastName
```
public String getLastName()
```
    .
    
    Returns:
    
    lastName
  - setLastName
```
public void setLastName(String lastName)
```
    setLastName.
  - lastNameMetadata
```
public Witness lastNameMetadata(PropertyMetadata lastNameMetadata)
```
    lastNameMetadata.
    
    Returns:
    
    Witness
  - getLastNameMetadata
```
public PropertyMetadata getLastNameMetadata()
```
    Metadata that indicates whether the `lastName` property is editable. This property is read-only..
    
    Returns:
    
    lastNameMetadata
  - setLastNameMetadata
```
public void setLastNameMetadata(PropertyMetadata lastNameMetadata)
```
    setLastNameMetadata.
  - lockedRecipientPhoneAuthEditable
```
public Witness lockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)
```
    lockedRecipientPhoneAuthEditable.
    
    Returns:
    
    Witness
  - getLockedRecipientPhoneAuthEditable
```
public String getLockedRecipientPhoneAuthEditable()
```
    .
    
    Returns:
    
    lockedRecipientPhoneAuthEditable
  - setLockedRecipientPhoneAuthEditable
```
public void setLockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)
```
    setLockedRecipientPhoneAuthEditable.
  - lockedRecipientSmsEditable
```
public Witness lockedRecipientSmsEditable(String lockedRecipientSmsEditable)
```
    lockedRecipientSmsEditable.
    
    Returns:
    
    Witness
  - getLockedRecipientSmsEditable
```
public String getLockedRecipientSmsEditable()
```
    .
    
    Returns:
    
    lockedRecipientSmsEditable
  - setLockedRecipientSmsEditable
```
public void setLockedRecipientSmsEditable(String lockedRecipientSmsEditable)
```
    setLockedRecipientSmsEditable.
  - name
```
public Witness name(String name)
```
    name.
    
    Returns:
    
    Witness
  - getName
```
public String getName()
```
    .
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
    setName.
  - nameMetadata
```
public Witness nameMetadata(PropertyMetadata nameMetadata)
```
    nameMetadata.
    
    Returns:
    
    Witness
  - getNameMetadata
```
public PropertyMetadata getNameMetadata()
```
    Metadata that indicates whether the `name` property is editable. This property is read-only..
    
    Returns:
    
    nameMetadata
  - setNameMetadata
```
public void setNameMetadata(PropertyMetadata nameMetadata)
```
    setNameMetadata.
  - notaryId
```
public Witness notaryId(String notaryId)
```
    notaryId.
    
    Returns:
    
    Witness
  - getNotaryId
```
public String getNotaryId()
```
    .
    
    Returns:
    
    notaryId
  - setNotaryId
```
public void setNotaryId(String notaryId)
```
    setNotaryId.
  - notarySignerEmailSent
```
public Witness notarySignerEmailSent(String notarySignerEmailSent)
```
    notarySignerEmailSent.
    
    Returns:
    
    Witness
  - getNotarySignerEmailSent
```
public String getNotarySignerEmailSent()
```
    .
    
    Returns:
    
    notarySignerEmailSent
  - setNotarySignerEmailSent
```
public void setNotarySignerEmailSent(String notarySignerEmailSent)
```
    setNotarySignerEmailSent.
  - note
```
public Witness note(String note)
```
    note.
    
    Returns:
    
    Witness
  - getNote
```
public String getNote()
```
    Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters..
    
    Returns:
    
    note
  - setNote
```
public void setNote(String note)
```
    setNote.
  - noteMetadata
```
public Witness noteMetadata(PropertyMetadata noteMetadata)
```
    noteMetadata.
    
    Returns:
    
    Witness
  - getNoteMetadata
```
public PropertyMetadata getNoteMetadata()
```
    Metadata that indicates whether the `note` property is editable. This property is read-only..
    
    Returns:
    
    noteMetadata
  - setNoteMetadata
```
public void setNoteMetadata(PropertyMetadata noteMetadata)
```
    setNoteMetadata.
  - offlineAttributes
```
public Witness offlineAttributes(OfflineAttributes offlineAttributes)
```
    offlineAttributes.
    
    Returns:
    
    Witness
  - getOfflineAttributes
```
public OfflineAttributes getOfflineAttributes()
```
    Reserved for DocuSign..
    
    Returns:
    
    offlineAttributes
  - setOfflineAttributes
```
public void setOfflineAttributes(OfflineAttributes offlineAttributes)
```
    setOfflineAttributes.
  - phoneAuthentication
```
public Witness phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
```
    phoneAuthentication.
    
    Returns:
    
    Witness
  - getPhoneAuthentication
```
public RecipientPhoneAuthentication getPhoneAuthentication()
```
    When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign. .
    
    Returns:
    
    phoneAuthentication
  - setPhoneAuthentication
```
public void setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
```
    setPhoneAuthentication.
  - phoneNumber
```
public Witness phoneNumber(RecipientPhoneNumber phoneNumber)
```
    phoneNumber.
    
    Returns:
    
    Witness
  - getPhoneNumber
```
public RecipientPhoneNumber getPhoneNumber()
```
    Describes the recipient phone number..
    
    Returns:
    
    phoneNumber
  - setPhoneNumber
```
public void setPhoneNumber(RecipientPhoneNumber phoneNumber)
```
    setPhoneNumber.
  - proofFile
```
public Witness proofFile(RecipientProofFile proofFile)
```
    proofFile.
    
    Returns:
    
    Witness
  - getProofFile
```
public RecipientProofFile getProofFile()
```
    The proof file of the recipient..
    
    Returns:
    
    proofFile
  - setProofFile
```
public void setProofFile(RecipientProofFile proofFile)
```
    setProofFile.
  - recipientAttachments
```
public Witness recipientAttachments(List<RecipientAttachment> recipientAttachments)
```
    recipientAttachments.
    
    Returns:
    
    Witness
  - addRecipientAttachmentsItem
```
public Witness addRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)
```
    addRecipientAttachmentsItem.
    
    Returns:
    
    Witness
  - getRecipientAttachments
```
public List<RecipientAttachment> getRecipientAttachments()
```
    Reserved:.
    
    Returns:
    
    recipientAttachments
  - setRecipientAttachments
```
public void setRecipientAttachments(List<RecipientAttachment> recipientAttachments)
```
    setRecipientAttachments.
  - recipientAuthenticationStatus
```
public Witness recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
```
    recipientAuthenticationStatus.
    
    Returns:
    
    Witness
  - getRecipientAuthenticationStatus
```
public AuthenticationStatus getRecipientAuthenticationStatus()
```
    Information about the recipient's authentication status. This property is read-only..
    
    Returns:
    
    recipientAuthenticationStatus
  - setRecipientAuthenticationStatus
```
public void setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
```
    setRecipientAuthenticationStatus.
  - recipientFeatureMetadata
```
public Witness recipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)
```
    recipientFeatureMetadata.
    
    Returns:
    
    Witness
  - addRecipientFeatureMetadataItem
```
public Witness addRecipientFeatureMetadataItem(FeatureAvailableMetadata recipientFeatureMetadataItem)
```
    addRecipientFeatureMetadataItem.
    
    Returns:
    
    Witness
  - getRecipientFeatureMetadata
```
public List<FeatureAvailableMetadata> getRecipientFeatureMetadata()
```
    .
    
    Returns:
    
    recipientFeatureMetadata
  - setRecipientFeatureMetadata
```
public void setRecipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)
```
    setRecipientFeatureMetadata.
  - recipientId
```
public Witness recipientId(String recipientId)
```
    recipientId.
    
    Returns:
    
    Witness
  - getRecipientId
```
public String getRecipientId()
```
    Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document..
    
    Returns:
    
    recipientId
  - setRecipientId
```
public void setRecipientId(String recipientId)
```
    setRecipientId.
  - recipientIdGuid
```
public Witness recipientIdGuid(String recipientIdGuid)
```
    recipientIdGuid.
    
    Returns:
    
    Witness
  - getRecipientIdGuid
```
public String getRecipientIdGuid()
```
    .
    
    Returns:
    
    recipientIdGuid
  - setRecipientIdGuid
```
public void setRecipientIdGuid(String recipientIdGuid)
```
    setRecipientIdGuid.
  - recipientSignatureProviders
```
public Witness recipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)
```
    recipientSignatureProviders.
    
    Returns:
    
    Witness
  - addRecipientSignatureProvidersItem
```
public Witness addRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)
```
    addRecipientSignatureProvidersItem.
    
    Returns:
    
    Witness
  - getRecipientSignatureProviders
```
public List<RecipientSignatureProvider> getRecipientSignatureProviders()
```
    .
    
    Returns:
    
    recipientSignatureProviders
  - setRecipientSignatureProviders
```
public void setRecipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)
```
    setRecipientSignatureProviders.
  - recipientSuppliesTabs
```
public Witness recipientSuppliesTabs(String recipientSuppliesTabs)
```
    recipientSuppliesTabs.
    
    Returns:
    
    Witness
  - getRecipientSuppliesTabs
```
public String getRecipientSuppliesTabs()
```
    .
    
    Returns:
    
    recipientSuppliesTabs
  - setRecipientSuppliesTabs
```
public void setRecipientSuppliesTabs(String recipientSuppliesTabs)
```
    setRecipientSuppliesTabs.
  - recipientType
```
public Witness recipientType(String recipientType)
```
    recipientType.
    
    Returns:
    
    Witness
  - getRecipientType
```
public String getRecipientType()
```
    .
    
    Returns:
    
    recipientType
  - setRecipientType
```
public void setRecipientType(String recipientType)
```
    setRecipientType.
  - recipientTypeMetadata
```
public Witness recipientTypeMetadata(PropertyMetadata recipientTypeMetadata)
```
    recipientTypeMetadata.
    
    Returns:
    
    Witness
  - getRecipientTypeMetadata
```
public PropertyMetadata getRecipientTypeMetadata()
```
    Metadata that indicates whether the `recipientType` property is editable. This property is read-only..
    
    Returns:
    
    recipientTypeMetadata
  - setRecipientTypeMetadata
```
public void setRecipientTypeMetadata(PropertyMetadata recipientTypeMetadata)
```
    setRecipientTypeMetadata.
  - requireIdLookup
```
public Witness requireIdLookup(String requireIdLookup)
```
    requireIdLookup.
    
    Returns:
    
    Witness
  - getRequireIdLookup
```
public String getRequireIdLookup()
```
    When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. .
    
    Returns:
    
    requireIdLookup
  - setRequireIdLookup
```
public void setRequireIdLookup(String requireIdLookup)
```
    setRequireIdLookup.
  - requireIdLookupMetadata
```
public Witness requireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)
```
    requireIdLookupMetadata.
    
    Returns:
    
    Witness
  - getRequireIdLookupMetadata
```
public PropertyMetadata getRequireIdLookupMetadata()
```
    Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only..
    
    Returns:
    
    requireIdLookupMetadata
  - setRequireIdLookupMetadata
```
public void setRequireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)
```
    setRequireIdLookupMetadata.
  - requireSignerCertificate
```
public Witness requireSignerCertificate(String requireSignerCertificate)
```
    requireSignerCertificate.
    
    Returns:
    
    Witness
  - getRequireSignerCertificate
```
public String getRequireSignerCertificate()
```
    .
    
    Returns:
    
    requireSignerCertificate
  - setRequireSignerCertificate
```
public void setRequireSignerCertificate(String requireSignerCertificate)
```
    setRequireSignerCertificate.
  - requireSignOnPaper
```
public Witness requireSignOnPaper(String requireSignOnPaper)
```
    requireSignOnPaper.
    
    Returns:
    
    Witness
  - getRequireSignOnPaper
```
public String getRequireSignOnPaper()
```
    .
    
    Returns:
    
    requireSignOnPaper
  - setRequireSignOnPaper
```
public void setRequireSignOnPaper(String requireSignOnPaper)
```
    setRequireSignOnPaper.
  - requireUploadSignature
```
public Witness requireUploadSignature(String requireUploadSignature)
```
    requireUploadSignature.
    
    Returns:
    
    Witness
  - getRequireUploadSignature
```
public String getRequireUploadSignature()
```
    .
    
    Returns:
    
    requireUploadSignature
  - setRequireUploadSignature
```
public void setRequireUploadSignature(String requireUploadSignature)
```
    setRequireUploadSignature.
  - roleName
```
public Witness roleName(String roleName)
```
    roleName.
    
    Returns:
    
    Witness
  - getRoleName
```
public String getRoleName()
```
    Optional element. Specifies the role name associated with the recipient.
    
    This is required when working with template recipients..
    
    Returns:
    
    roleName
  - setRoleName
```
public void setRoleName(String roleName)
```
    setRoleName.
  - routingOrder
```
public Witness routingOrder(String routingOrder)
```
    routingOrder.
    
    Returns:
    
    Witness
  - getRoutingOrder
```
public String getRoutingOrder()
```
    Specifies the routing order of the recipient in the envelope. .
    
    Returns:
    
    routingOrder
  - setRoutingOrder
```
public void setRoutingOrder(String routingOrder)
```
    setRoutingOrder.
  - routingOrderMetadata
```
public Witness routingOrderMetadata(PropertyMetadata routingOrderMetadata)
```
    routingOrderMetadata.
    
    Returns:
    
    Witness
  - getRoutingOrderMetadata
```
public PropertyMetadata getRoutingOrderMetadata()
```
    Metadata that indicates whether the `routingOrder` property is editable. This property is read-only..
    
    Returns:
    
    routingOrderMetadata
  - setRoutingOrderMetadata
```
public void setRoutingOrderMetadata(PropertyMetadata routingOrderMetadata)
```
    setRoutingOrderMetadata.
  - sentDateTime
```
public Witness sentDateTime(String sentDateTime)
```
    sentDateTime.
    
    Returns:
    
    Witness
  - getSentDateTime
```
public String getSentDateTime()
```
    The date and time the envelope was sent..
    
    Returns:
    
    sentDateTime
  - setSentDateTime
```
public void setSentDateTime(String sentDateTime)
```
    setSentDateTime.
  - signatureInfo
```
public Witness signatureInfo(RecipientSignatureInformation signatureInfo)
```
    signatureInfo.
    
    Returns:
    
    Witness
  - getSignatureInfo
```
public RecipientSignatureInformation getSignatureInfo()
```
    Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers..
    
    Returns:
    
    signatureInfo
  - setSignatureInfo
```
public void setSignatureInfo(RecipientSignatureInformation signatureInfo)
```
    setSignatureInfo.
  - signedDateTime
```
public Witness signedDateTime(String signedDateTime)
```
    signedDateTime.
    
    Returns:
    
    Witness
  - getSignedDateTime
```
public String getSignedDateTime()
```
    Reserved: For DocuSign use only. .
    
    Returns:
    
    signedDateTime
  - setSignedDateTime
```
public void setSignedDateTime(String signedDateTime)
```
    setSignedDateTime.
  - signInEachLocation
```
public Witness signInEachLocation(String signInEachLocation)
```
    signInEachLocation.
    
    Returns:
    
    Witness
  - getSignInEachLocation
```
public String getSignInEachLocation()
```
    When set to **true**, specifies that the signer must sign in all locations..
    
    Returns:
    
    signInEachLocation
  - setSignInEachLocation
```
public void setSignInEachLocation(String signInEachLocation)
```
    setSignInEachLocation.
  - signInEachLocationMetadata
```
public Witness signInEachLocationMetadata(PropertyMetadata signInEachLocationMetadata)
```
    signInEachLocationMetadata.
    
    Returns:
    
    Witness
  - getSignInEachLocationMetadata
```
public PropertyMetadata getSignInEachLocationMetadata()
```
    Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only..
    
    Returns:
    
    signInEachLocationMetadata
  - setSignInEachLocationMetadata
```
public void setSignInEachLocationMetadata(PropertyMetadata signInEachLocationMetadata)
```
    setSignInEachLocationMetadata.
  - signingGroupId
```
public Witness signingGroupId(String signingGroupId)
```
    signingGroupId.
    
    Returns:
    
    Witness
  - getSigningGroupId
```
public String getSigningGroupId()
```
    When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once)..
    
    Returns:
    
    signingGroupId
  - setSigningGroupId
```
public void setSigningGroupId(String signingGroupId)
```
    setSigningGroupId.
  - signingGroupIdMetadata
```
public Witness signingGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)
```
    signingGroupIdMetadata.
    
    Returns:
    
    Witness
  - getSigningGroupIdMetadata
```
public PropertyMetadata getSigningGroupIdMetadata()
```
    Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only..
    
    Returns:
    
    signingGroupIdMetadata
  - setSigningGroupIdMetadata
```
public void setSigningGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)
```
    setSigningGroupIdMetadata.
  - signingGroupName
```
public Witness signingGroupName(String signingGroupName)
```
    signingGroupName.
    
    Returns:
    
    Witness
  - getSigningGroupName
```
public String getSigningGroupName()
```
    The display name for the signing group. Maximum Length: 100 characters. .
    
    Returns:
    
    signingGroupName
  - setSigningGroupName
```
public void setSigningGroupName(String signingGroupName)
```
    setSigningGroupName.
  - signingGroupUsers
```
public Witness signingGroupUsers(List<UserInfo> signingGroupUsers)
```
    signingGroupUsers.
    
    Returns:
    
    Witness
  - addSigningGroupUsersItem
```
public Witness addSigningGroupUsersItem(UserInfo signingGroupUsersItem)
```
    addSigningGroupUsersItem.
    
    Returns:
    
    Witness
  - getSigningGroupUsers
```
public List<UserInfo> getSigningGroupUsers()
```
    A complex type that contains information about users in the signing group..
    
    Returns:
    
    signingGroupUsers
  - setSigningGroupUsers
```
public void setSigningGroupUsers(List<UserInfo> signingGroupUsers)
```
    setSigningGroupUsers.
  - smsAuthentication
```
public Witness smsAuthentication(RecipientSMSAuthentication smsAuthentication)
```
    smsAuthentication.
    
    Returns:
    
    Witness
  - getSmsAuthentication
```
public RecipientSMSAuthentication getSmsAuthentication()
```
    When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. .
    
    Returns:
    
    smsAuthentication
  - setSmsAuthentication
```
public void setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)
```
    setSmsAuthentication.
  - socialAuthentications
```
public Witness socialAuthentications(List<SocialAuthentication> socialAuthentications)
```
    socialAuthentications.
    
    Returns:
    
    Witness
  - addSocialAuthenticationsItem
```
public Witness addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)
```
    addSocialAuthenticationsItem.
    
    Returns:
    
    Witness
  - getSocialAuthentications
```
public List<SocialAuthentication> getSocialAuthentications()
```
    Lists the social ID type that can be used for recipient authentication..
    
    Returns:
    
    socialAuthentications
  - setSocialAuthentications
```
public void setSocialAuthentications(List<SocialAuthentication> socialAuthentications)
```
    setSocialAuthentications.
  - status
```
public Witness status(String status)
```
    status.
    
    Returns:
    
    Witness
  - getStatus
```
public String getStatus()
```
    Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later..
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(String status)
```
    setStatus.
  - statusCode
```
public Witness statusCode(String statusCode)
```
    statusCode.
    
    Returns:
    
    Witness
  - getStatusCode
```
public String getStatusCode()
```
    .
    
    Returns:
    
    statusCode
  - setStatusCode
```
public void setStatusCode(String statusCode)
```
    setStatusCode.
  - suppressEmails
```
public Witness suppressEmails(String suppressEmails)
```
    suppressEmails.
    
    Returns:
    
    Witness
  - getSuppressEmails
```
public String getSuppressEmails()
```
    .
    
    Returns:
    
    suppressEmails
  - setSuppressEmails
```
public void setSuppressEmails(String suppressEmails)
```
    setSuppressEmails.
  - tabs
```
public Witness tabs(Tabs tabs)
```
    tabs.
    
    Returns:
    
    Witness
  - getTabs
```
public Tabs getTabs()
```
    A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients..
    
    Returns:
    
    tabs
  - setTabs
```
public void setTabs(Tabs tabs)
```
    setTabs.
  - templateLocked
```
public Witness templateLocked(String templateLocked)
```
    templateLocked.
    
    Returns:
    
    Witness
  - getTemplateLocked
```
public String getTemplateLocked()
```
    When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. .
    
    Returns:
    
    templateLocked
  - setTemplateLocked
```
public void setTemplateLocked(String templateLocked)
```
    setTemplateLocked.
  - templateRequired
```
public Witness templateRequired(String templateRequired)
```
    templateRequired.
    
    Returns:
    
    Witness
  - getTemplateRequired
```
public String getTemplateRequired()
```
    When set to **true**, the sender may not remove the recipient. Used only when working with template recipients..
    
    Returns:
    
    templateRequired
  - setTemplateRequired
```
public void setTemplateRequired(String templateRequired)
```
    setTemplateRequired.
  - totalTabCount
```
public Witness totalTabCount(String totalTabCount)
```
    totalTabCount.
    
    Returns:
    
    Witness
  - getTotalTabCount
```
public String getTotalTabCount()
```
    .
    
    Returns:
    
    totalTabCount
  - setTotalTabCount
```
public void setTotalTabCount(String totalTabCount)
```
    setTotalTabCount.
  - userId
```
public Witness userId(String userId)
```
    userId.
    
    Returns:
    
    Witness
  - getUserId
```
public String getUserId()
```
    .
    
    Returns:
    
    userId
  - setUserId
```
public void setUserId(String userId)
```
    setUserId.
  - witnessFor
```
public Witness witnessFor(String witnessFor)
```
    witnessFor.
    
    Returns:
    
    Witness
  - getWitnessFor
```
public String getWitnessFor()
```
    .
    
    Returns:
    
    witnessFor
  - setWitnessFor
```
public void setWitnessFor(String witnessFor)
```
    setWitnessFor.
  - witnessForGuid
```
public Witness witnessForGuid(String witnessForGuid)
```
    witnessForGuid.
    
    Returns:
    
    Witness
  - getWitnessForGuid
```
public String getWitnessForGuid()
```
    .
    
    Returns:
    
    witnessForGuid
  - setWitnessForGuid
```
public void setWitnessForGuid(String witnessForGuid)
```
    setWitnessForGuid.
  - equals
```
public boolean equals(Object o)
```
    Compares objects.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true or false depending on comparison result.
  - hashCode
```
public int hashCode()
```
    Returns the HashCode.
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Converts the given object to string.
    
    Overrides:
    
    toString in class Object

Class Witness

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Witness

Method Detail

accessCode

getAccessCode

setAccessCode

accessCodeMetadata

getAccessCodeMetadata

setAccessCodeMetadata

addAccessCodeToEmail

getAddAccessCodeToEmail

setAddAccessCodeToEmail

additionalNotifications

addAdditionalNotificationsItem

getAdditionalNotifications

setAdditionalNotifications

agentCanEditEmail

getAgentCanEditEmail

setAgentCanEditEmail

agentCanEditName

getAgentCanEditName

setAgentCanEditName

allowSystemOverrideForLockedRecipient

getAllowSystemOverrideForLockedRecipient

setAllowSystemOverrideForLockedRecipient

autoNavigation

getAutoNavigation

setAutoNavigation

autoRespondedReason

getAutoRespondedReason

setAutoRespondedReason

bulkRecipientsUri

getBulkRecipientsUri

setBulkRecipientsUri

bulkSendV2Recipient

getBulkSendV2Recipient

setBulkSendV2Recipient

canSignOffline

getCanSignOffline

setCanSignOffline

clientUserId

getClientUserId

setClientUserId

completedCount

getCompletedCount

setCompletedCount

consentDetailsList

addConsentDetailsListItem

getConsentDetailsList

setConsentDetailsList

creationReason

getCreationReason

setCreationReason

customFields

addCustomFieldsItem

getCustomFields

setCustomFields

declinedDateTime

getDeclinedDateTime

setDeclinedDateTime

declinedReason

getDeclinedReason

setDeclinedReason

defaultRecipient

getDefaultRecipient

setDefaultRecipient

delegatedBy

getDelegatedBy

setDelegatedBy

delegatedTo

addDelegatedToItem

getDelegatedTo

setDelegatedTo

deliveredDateTime

getDeliveredDateTime

setDeliveredDateTime