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

```
public class Signer
extends Object
```
A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document..

Constructor Summary

Constructors
Constructor Description

Signer()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Signer`	`accessCode(String accessCode)`	accessCode.
`Signer`	`accessCodeMetadata(PropertyMetadata accessCodeMetadata)`	accessCodeMetadata.
`Signer`	`addAccessCodeToEmail(String addAccessCodeToEmail)`	addAccessCodeToEmail.
`Signer`	`addAdditionalNotificationsItem(RecipientAdditionalNotification additionalNotificationsItem)`	addAdditionalNotificationsItem.
`Signer`	`addConsentDetailsListItem(ConsentDetails consentDetailsListItem)`	addConsentDetailsListItem.
`Signer`	`addCustomFieldsItem(String customFieldsItem)`	addCustomFieldsItem.
`Signer`	`addDelegatedToItem(DelegationInfo delegatedToItem)`	addDelegatedToItem.
`Signer`	`addDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)`	addDocumentVisibilityItem.
`Signer`	`addExcludedDocumentsItem(String excludedDocumentsItem)`	addExcludedDocumentsItem.
`Signer`	`additionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)`	additionalNotifications.
`Signer`	`addRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)`	addRecipientAttachmentsItem.
`Signer`	`addRecipientFeatureMetadataItem(FeatureAvailableMetadata recipientFeatureMetadataItem)`	addRecipientFeatureMetadataItem.
`Signer`	`addRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)`	addRecipientSignatureProvidersItem.
`Signer`	`addSigningGroupUsersItem(UserInfo signingGroupUsersItem)`	addSigningGroupUsersItem.
`Signer`	`addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)`	addSocialAuthenticationsItem.
`Signer`	`agentCanEditEmail(String agentCanEditEmail)`	agentCanEditEmail.
`Signer`	`agentCanEditName(String agentCanEditName)`	agentCanEditName.
`Signer`	`allowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)`	allowSystemOverrideForLockedRecipient.
`Signer`	`autoNavigation(String autoNavigation)`	autoNavigation.
`Signer`	`autoRespondedReason(String autoRespondedReason)`	autoRespondedReason.
`Signer`	`bulkRecipientsUri(String bulkRecipientsUri)`	bulkRecipientsUri.
`Signer`	`bulkSendV2Recipient(String bulkSendV2Recipient)`	bulkSendV2Recipient.
`Signer`	`canSignOffline(String canSignOffline)`	canSignOffline.
`Signer`	`clientUserId(String clientUserId)`	clientUserId.
`Signer`	`completedCount(String completedCount)`	completedCount.
`Signer`	`consentDetailsList(List<ConsentDetails> consentDetailsList)`	consentDetailsList.
`Signer`	`creationReason(String creationReason)`	creationReason.
`Signer`	`customFields(List<String> customFields)`	customFields.
`Signer`	`declinedDateTime(String declinedDateTime)`	declinedDateTime.
`Signer`	`declinedReason(String declinedReason)`	declinedReason.
`Signer`	`defaultRecipient(String defaultRecipient)`	defaultRecipient.
`Signer`	`delegatedBy(DelegationInfo delegatedBy)`	delegatedBy.
`Signer`	`delegatedTo(List<DelegationInfo> delegatedTo)`	delegatedTo.
`Signer`	`deliveredDateTime(String deliveredDateTime)`	deliveredDateTime.
`Signer`	`deliveryMethod(String deliveryMethod)`	deliveryMethod.
`Signer`	`deliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)`	deliveryMethodMetadata.
`Signer`	`designatorId(String designatorId)`	designatorId.
`Signer`	`designatorIdGuid(String designatorIdGuid)`	designatorIdGuid.
`Signer`	`documentVisibility(List<DocumentVisibility> documentVisibility)`	documentVisibility.
`Signer`	`email(String email)`	email.
`Signer`	`emailMetadata(PropertyMetadata emailMetadata)`	emailMetadata.
`Signer`	`emailNotification(RecipientEmailNotification emailNotification)`	emailNotification.
`Signer`	`emailRecipientPostSigningURL(String emailRecipientPostSigningURL)`	emailRecipientPostSigningURL.
`Signer`	`embeddedRecipientStartURL(String embeddedRecipientStartURL)`	embeddedRecipientStartURL.
`boolean`	`equals(Object o)`	Compares objects.
`Signer`	`errorDetails(ErrorDetails errorDetails)`	errorDetails.
`Signer`	`excludedDocuments(List<String> excludedDocuments)`	excludedDocuments.
`Signer`	`faxNumber(String faxNumber)`	faxNumber.
`Signer`	`faxNumberMetadata(PropertyMetadata faxNumberMetadata)`	faxNumberMetadata.
`Signer`	`firstName(String firstName)`	firstName.
`Signer`	`firstNameMetadata(PropertyMetadata firstNameMetadata)`	firstNameMetadata.
`Signer`	`fullName(String fullName)`	fullName.
`Signer`	`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()`	Email id of the recipient.
`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()`	When set to true, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file.
`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()`	Sets the type of signer certificate required for signing.
`String`	`getRequireSignOnPaper()`	When set to true, the signer must print, sign, and upload or fax the signed documents to DocuSign..
`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()`	The tabs to assign to the recipient.
`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()`	.
`int`	`hashCode()`	Returns the HashCode.
`Signer`	`idCheckConfigurationName(String idCheckConfigurationName)`	idCheckConfigurationName.
`Signer`	`idCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)`	idCheckConfigurationNameMetadata.
`Signer`	`idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)`	idCheckInformationInput.
`Signer`	`identityVerification(RecipientIdentityVerification identityVerification)`	identityVerification.
`Signer`	`inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)`	inheritEmailNotificationConfiguration.
`Signer`	`isBulkRecipient(String isBulkRecipient)`	isBulkRecipient.
`Signer`	`isBulkRecipientMetadata(PropertyMetadata isBulkRecipientMetadata)`	isBulkRecipientMetadata.
`Signer`	`lastName(String lastName)`	lastName.
`Signer`	`lastNameMetadata(PropertyMetadata lastNameMetadata)`	lastNameMetadata.
`Signer`	`lockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)`	lockedRecipientPhoneAuthEditable.
`Signer`	`lockedRecipientSmsEditable(String lockedRecipientSmsEditable)`	lockedRecipientSmsEditable.
`Signer`	`name(String name)`	name.
`Signer`	`nameMetadata(PropertyMetadata nameMetadata)`	nameMetadata.
`Signer`	`notaryId(String notaryId)`	notaryId.
`Signer`	`notarySignerEmailSent(String notarySignerEmailSent)`	notarySignerEmailSent.
`Signer`	`note(String note)`	note.
`Signer`	`noteMetadata(PropertyMetadata noteMetadata)`	noteMetadata.
`Signer`	`offlineAttributes(OfflineAttributes offlineAttributes)`	offlineAttributes.
`Signer`	`phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)`	phoneAuthentication.
`Signer`	`phoneNumber(RecipientPhoneNumber phoneNumber)`	phoneNumber.
`Signer`	`proofFile(RecipientProofFile proofFile)`	proofFile.
`Signer`	`recipientAttachments(List<RecipientAttachment> recipientAttachments)`	recipientAttachments.
`Signer`	`recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)`	recipientAuthenticationStatus.
`Signer`	`recipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)`	recipientFeatureMetadata.
`Signer`	`recipientId(String recipientId)`	recipientId.
`Signer`	`recipientIdGuid(String recipientIdGuid)`	recipientIdGuid.
`Signer`	`recipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)`	recipientSignatureProviders.
`Signer`	`recipientSuppliesTabs(String recipientSuppliesTabs)`	recipientSuppliesTabs.
`Signer`	`recipientType(String recipientType)`	recipientType.
`Signer`	`recipientTypeMetadata(PropertyMetadata recipientTypeMetadata)`	recipientTypeMetadata.
`Signer`	`requireIdLookup(String requireIdLookup)`	requireIdLookup.
`Signer`	`requireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)`	requireIdLookupMetadata.
`Signer`	`requireSignerCertificate(String requireSignerCertificate)`	requireSignerCertificate.
`Signer`	`requireSignOnPaper(String requireSignOnPaper)`	requireSignOnPaper.
`Signer`	`requireUploadSignature(String requireUploadSignature)`	requireUploadSignature.
`Signer`	`roleName(String roleName)`	roleName.
`Signer`	`routingOrder(String routingOrder)`	routingOrder.
`Signer`	`routingOrderMetadata(PropertyMetadata routingOrderMetadata)`	routingOrderMetadata.
`Signer`	`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.
`Signer`	`signatureInfo(RecipientSignatureInformation signatureInfo)`	signatureInfo.
`Signer`	`signedDateTime(String signedDateTime)`	signedDateTime.
`Signer`	`signInEachLocation(String signInEachLocation)`	signInEachLocation.
`Signer`	`signInEachLocationMetadata(PropertyMetadata signInEachLocationMetadata)`	signInEachLocationMetadata.
`Signer`	`signingGroupId(String signingGroupId)`	signingGroupId.
`Signer`	`signingGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)`	signingGroupIdMetadata.
`Signer`	`signingGroupName(String signingGroupName)`	signingGroupName.
`Signer`	`signingGroupUsers(List<UserInfo> signingGroupUsers)`	signingGroupUsers.
`Signer`	`smsAuthentication(RecipientSMSAuthentication smsAuthentication)`	smsAuthentication.
`Signer`	`socialAuthentications(List<SocialAuthentication> socialAuthentications)`	socialAuthentications.
`Signer`	`status(String status)`	status.
`Signer`	`statusCode(String statusCode)`	statusCode.
`Signer`	`suppressEmails(String suppressEmails)`	suppressEmails.
`Signer`	`tabs(Tabs tabs)`	tabs.
`Signer`	`templateLocked(String templateLocked)`	templateLocked.
`Signer`	`templateRequired(String templateRequired)`	templateRequired.
`String`	`toString()`	Converts the given object to string.
`Signer`	`totalTabCount(String totalTabCount)`	totalTabCount.
`Signer`	`userId(String userId)`	userId.

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

- Constructor Detail
  - Signer
```
public Signer()
```
- Method Detail
  - accessCode
```
public Signer accessCode(String accessCode)
```
    accessCode.
    
    Returns:
    
    Signer
  - 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 Signer accessCodeMetadata(PropertyMetadata accessCodeMetadata)
```
    accessCodeMetadata.
    
    Returns:
    
    Signer
  - 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 Signer addAccessCodeToEmail(String addAccessCodeToEmail)
```
    addAccessCodeToEmail.
    
    Returns:
    
    Signer
  - 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 Signer additionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)
```
    additionalNotifications.
    
    Returns:
    
    Signer
  - addAdditionalNotificationsItem
```
public Signer addAdditionalNotificationsItem(RecipientAdditionalNotification additionalNotificationsItem)
```
    addAdditionalNotificationsItem.
    
    Returns:
    
    Signer
  - getAdditionalNotifications
```
public List<RecipientAdditionalNotification> getAdditionalNotifications()
```
    .
    
    Returns:
    
    additionalNotifications
  - setAdditionalNotifications
```
public void setAdditionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)
```
    setAdditionalNotifications.
  - agentCanEditEmail
```
public Signer agentCanEditEmail(String agentCanEditEmail)
```
    agentCanEditEmail.
    
    Returns:
    
    Signer
  - getAgentCanEditEmail
```
public String getAgentCanEditEmail()
```
    .
    
    Returns:
    
    agentCanEditEmail
  - setAgentCanEditEmail
```
public void setAgentCanEditEmail(String agentCanEditEmail)
```
    setAgentCanEditEmail.
  - agentCanEditName
```
public Signer agentCanEditName(String agentCanEditName)
```
    agentCanEditName.
    
    Returns:
    
    Signer
  - getAgentCanEditName
```
public String getAgentCanEditName()
```
    .
    
    Returns:
    
    agentCanEditName
  - setAgentCanEditName
```
public void setAgentCanEditName(String agentCanEditName)
```
    setAgentCanEditName.
  - allowSystemOverrideForLockedRecipient
```
public Signer allowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)
```
    allowSystemOverrideForLockedRecipient.
    
    Returns:
    
    Signer
  - getAllowSystemOverrideForLockedRecipient
```
public String getAllowSystemOverrideForLockedRecipient()
```
    .
    
    Returns:
    
    allowSystemOverrideForLockedRecipient
  - setAllowSystemOverrideForLockedRecipient
```
public void setAllowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)
```
    setAllowSystemOverrideForLockedRecipient.
  - autoNavigation
```
public Signer autoNavigation(String autoNavigation)
```
    autoNavigation.
    
    Returns:
    
    Signer
  - getAutoNavigation
```
public String getAutoNavigation()
```
    .
    
    Returns:
    
    autoNavigation
  - setAutoNavigation
```
public void setAutoNavigation(String autoNavigation)
```
    setAutoNavigation.
  - autoRespondedReason
```
public Signer autoRespondedReason(String autoRespondedReason)
```
    autoRespondedReason.
    
    Returns:
    
    Signer
  - getAutoRespondedReason
```
public String getAutoRespondedReason()
```
    .
    
    Returns:
    
    autoRespondedReason
  - setAutoRespondedReason
```
public void setAutoRespondedReason(String autoRespondedReason)
```
    setAutoRespondedReason.
  - bulkRecipientsUri
```
public Signer bulkRecipientsUri(String bulkRecipientsUri)
```
    bulkRecipientsUri.
    
    Returns:
    
    Signer
  - 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 Signer bulkSendV2Recipient(String bulkSendV2Recipient)
```
    bulkSendV2Recipient.
    
    Returns:
    
    Signer
  - getBulkSendV2Recipient
```
public String getBulkSendV2Recipient()
```
    .
    
    Returns:
    
    bulkSendV2Recipient
  - setBulkSendV2Recipient
```
public void setBulkSendV2Recipient(String bulkSendV2Recipient)
```
    setBulkSendV2Recipient.
  - canSignOffline
```
public Signer canSignOffline(String canSignOffline)
```
    canSignOffline.
    
    Returns:
    
    Signer
  - 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 Signer clientUserId(String clientUserId)
```
    clientUserId.
    
    Returns:
    
    Signer
  - 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 Signer completedCount(String completedCount)
```
    completedCount.
    
    Returns:
    
    Signer
  - getCompletedCount
```
public String getCompletedCount()
```
    .
    
    Returns:
    
    completedCount
  - setCompletedCount
```
public void setCompletedCount(String completedCount)
```
    setCompletedCount.
  - consentDetailsList
```
public Signer consentDetailsList(List<ConsentDetails> consentDetailsList)
```
    consentDetailsList.
    
    Returns:
    
    Signer
  - addConsentDetailsListItem
```
public Signer addConsentDetailsListItem(ConsentDetails consentDetailsListItem)
```
    addConsentDetailsListItem.
    
    Returns:
    
    Signer
  - getConsentDetailsList
```
public List<ConsentDetails> getConsentDetailsList()
```
    .
    
    Returns:
    
    consentDetailsList
  - setConsentDetailsList
```
public void setConsentDetailsList(List<ConsentDetails> consentDetailsList)
```
    setConsentDetailsList.
  - creationReason
```
public Signer creationReason(String creationReason)
```
    creationReason.
    
    Returns:
    
    Signer
  - getCreationReason
```
public String getCreationReason()
```
    .
    
    Returns:
    
    creationReason
  - setCreationReason
```
public void setCreationReason(String creationReason)
```
    setCreationReason.
  - customFields
```
public Signer customFields(List<String> customFields)
```
    customFields.
    
    Returns:
    
    Signer
  - addCustomFieldsItem
```
public Signer addCustomFieldsItem(String customFieldsItem)
```
    addCustomFieldsItem.
    
    Returns:
    
    Signer
  - 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 Signer declinedDateTime(String declinedDateTime)
```
    declinedDateTime.
    
    Returns:
    
    Signer
  - getDeclinedDateTime
```
public String getDeclinedDateTime()
```
    The date and time the recipient declined the document..
    
    Returns:
    
    declinedDateTime
  - setDeclinedDateTime
```
public void setDeclinedDateTime(String declinedDateTime)
```
    setDeclinedDateTime.
  - declinedReason
```
public Signer declinedReason(String declinedReason)
```
    declinedReason.
    
    Returns:
    
    Signer
  - getDeclinedReason
```
public String getDeclinedReason()
```
    The reason the recipient declined the document..
    
    Returns:
    
    declinedReason
  - setDeclinedReason
```
public void setDeclinedReason(String declinedReason)
```
    setDeclinedReason.
  - defaultRecipient
```
public Signer defaultRecipient(String defaultRecipient)
```
    defaultRecipient.
    
    Returns:
    
    Signer
  - getDefaultRecipient
```
public String getDefaultRecipient()
```
    .
    
    Returns:
    
    defaultRecipient
  - setDefaultRecipient
```
public void setDefaultRecipient(String defaultRecipient)
```
    setDefaultRecipient.
  - delegatedBy
```
public Signer delegatedBy(DelegationInfo delegatedBy)
```
    delegatedBy.
    
    Returns:
    
    Signer
  - getDelegatedBy
```
public DelegationInfo getDelegatedBy()
```
    .
    
    Returns:
    
    delegatedBy
  - setDelegatedBy
```
public void setDelegatedBy(DelegationInfo delegatedBy)
```
    setDelegatedBy.
  - delegatedTo
```
public Signer delegatedTo(List<DelegationInfo> delegatedTo)
```
    delegatedTo.
    
    Returns:
    
    Signer
  - addDelegatedToItem
```
public Signer addDelegatedToItem(DelegationInfo delegatedToItem)
```
    addDelegatedToItem.
    
    Returns:
    
    Signer
  - getDelegatedTo
```
public List<DelegationInfo> getDelegatedTo()
```
    .
    
    Returns:
    
    delegatedTo
  - setDelegatedTo
```
public void setDelegatedTo(List<DelegationInfo> delegatedTo)
```
    setDelegatedTo.
  - deliveredDateTime
```
public Signer deliveredDateTime(String deliveredDateTime)
```
    deliveredDateTime.
    
    Returns:
    
    Signer
  - getDeliveredDateTime
```
public String getDeliveredDateTime()
```
    Reserved: For DocuSign use only..
    
    Returns:
    
    deliveredDateTime
  - setDeliveredDateTime
```
public void setDeliveredDateTime(String deliveredDateTime)
```
    setDeliveredDateTime.
  - deliveryMethod
```
public Signer deliveryMethod(String deliveryMethod)
```
    deliveryMethod.
    
    Returns:
    
    Signer
  - getDeliveryMethod
```
public String getDeliveryMethod()
```
    Reserved: For DocuSign use only..
    
    Returns:
    
    deliveryMethod
  - setDeliveryMethod
```
public void setDeliveryMethod(String deliveryMethod)
```
    setDeliveryMethod.
  - deliveryMethodMetadata
```
public Signer deliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)
```
    deliveryMethodMetadata.
    
    Returns:
    
    Signer
  - getDeliveryMethodMetadata
```
public PropertyMetadata getDeliveryMethodMetadata()
```
    Reserved for DocuSign..
    
    Returns:
    
    deliveryMethodMetadata
  - setDeliveryMethodMetadata
```
public void setDeliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)
```
    setDeliveryMethodMetadata.
  - designatorId
```
public Signer designatorId(String designatorId)
```
    designatorId.
    
    Returns:
    
    Signer
  - getDesignatorId
```
public String getDesignatorId()
```
    .
    
    Returns:
    
    designatorId
  - setDesignatorId
```
public void setDesignatorId(String designatorId)
```
    setDesignatorId.
  - designatorIdGuid
```
public Signer designatorIdGuid(String designatorIdGuid)
```
    designatorIdGuid.
    
    Returns:
    
    Signer
  - getDesignatorIdGuid
```
public String getDesignatorIdGuid()
```
    .
    
    Returns:
    
    designatorIdGuid
  - setDesignatorIdGuid
```
public void setDesignatorIdGuid(String designatorIdGuid)
```
    setDesignatorIdGuid.
  - documentVisibility
```
public Signer documentVisibility(List<DocumentVisibility> documentVisibility)
```
    documentVisibility.
    
    Returns:
    
    Signer
  - addDocumentVisibilityItem
```
public Signer addDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)
```
    addDocumentVisibilityItem.
    
    Returns:
    
    Signer
  - getDocumentVisibility
```
public List<DocumentVisibility> getDocumentVisibility()
```
    .
    
    Returns:
    
    documentVisibility
  - setDocumentVisibility
```
public void setDocumentVisibility(List<DocumentVisibility> documentVisibility)
```
    setDocumentVisibility.
  - email
```
public Signer email(String email)
```
    email.
    
    Returns:
    
    Signer
  - getEmail
```
public String getEmail()
```
    Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters. .
    
    Returns:
    
    email
  - setEmail
```
public void setEmail(String email)
```
    setEmail.
  - emailMetadata
```
public Signer emailMetadata(PropertyMetadata emailMetadata)
```
    emailMetadata.
    
    Returns:
    
    Signer
  - 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 Signer emailNotification(RecipientEmailNotification emailNotification)
```
    emailNotification.
    
    Returns:
    
    Signer
  - 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 Signer emailRecipientPostSigningURL(String emailRecipientPostSigningURL)
```
    emailRecipientPostSigningURL.
    
    Returns:
    
    Signer
  - getEmailRecipientPostSigningURL
```
public String getEmailRecipientPostSigningURL()
```
    .
    
    Returns:
    
    emailRecipientPostSigningURL
  - setEmailRecipientPostSigningURL
```
public void setEmailRecipientPostSigningURL(String emailRecipientPostSigningURL)
```
    setEmailRecipientPostSigningURL.
  - embeddedRecipientStartURL
```
public Signer embeddedRecipientStartURL(String embeddedRecipientStartURL)
```
    embeddedRecipientStartURL.
    
    Returns:
    
    Signer
  - 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 Signer errorDetails(ErrorDetails errorDetails)
```
    errorDetails.
    
    Returns:
    
    Signer
  - getErrorDetails
```
public ErrorDetails getErrorDetails()
```
    Array or errors..
    
    Returns:
    
    errorDetails
  - setErrorDetails
```
public void setErrorDetails(ErrorDetails errorDetails)
```
    setErrorDetails.
  - excludedDocuments
```
public Signer excludedDocuments(List<String> excludedDocuments)
```
    excludedDocuments.
    
    Returns:
    
    Signer
  - addExcludedDocumentsItem
```
public Signer addExcludedDocumentsItem(String excludedDocumentsItem)
```
    addExcludedDocumentsItem.
    
    Returns:
    
    Signer
  - 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 Signer faxNumber(String faxNumber)
```
    faxNumber.
    
    Returns:
    
    Signer
  - getFaxNumber
```
public String getFaxNumber()
```
    Reserved:.
    
    Returns:
    
    faxNumber
  - setFaxNumber
```
public void setFaxNumber(String faxNumber)
```
    setFaxNumber.
  - faxNumberMetadata
```
public Signer faxNumberMetadata(PropertyMetadata faxNumberMetadata)
```
    faxNumberMetadata.
    
    Returns:
    
    Signer
  - getFaxNumberMetadata
```
public PropertyMetadata getFaxNumberMetadata()
```
    Reserved for DocuSign..
    
    Returns:
    
    faxNumberMetadata
  - setFaxNumberMetadata
```
public void setFaxNumberMetadata(PropertyMetadata faxNumberMetadata)
```
    setFaxNumberMetadata.
  - firstName
```
public Signer firstName(String firstName)
```
    firstName.
    
    Returns:
    
    Signer
  - getFirstName
```
public String getFirstName()
```
    The user's first name. Maximum Length: 50 characters..
    
    Returns:
    
    firstName
  - setFirstName
```
public void setFirstName(String firstName)
```
    setFirstName.
  - firstNameMetadata
```
public Signer firstNameMetadata(PropertyMetadata firstNameMetadata)
```
    firstNameMetadata.
    
    Returns:
    
    Signer
  - 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 Signer fullName(String fullName)
```
    fullName.
    
    Returns:
    
    Signer
  - getFullName
```
public String getFullName()
```
    .
    
    Returns:
    
    fullName
  - setFullName
```
public void setFullName(String fullName)
```
    setFullName.
  - fullNameMetadata
```
public Signer fullNameMetadata(PropertyMetadata fullNameMetadata)
```
    fullNameMetadata.
    
    Returns:
    
    Signer
  - getFullNameMetadata
```
public PropertyMetadata getFullNameMetadata()
```
    Reserved for DocuSign..
    
    Returns:
    
    fullNameMetadata
  - setFullNameMetadata
```
public void setFullNameMetadata(PropertyMetadata fullNameMetadata)
```
    setFullNameMetadata.
  - idCheckConfigurationName
```
public Signer idCheckConfigurationName(String idCheckConfigurationName)
```
    idCheckConfigurationName.
    
    Returns:
    
    Signer
  - 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 Signer idCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)
```
    idCheckConfigurationNameMetadata.
    
    Returns:
    
    Signer
  - 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 Signer idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
```
    idCheckInformationInput.
    
    Returns:
    
    Signer
  - 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 Signer identityVerification(RecipientIdentityVerification identityVerification)
```
    identityVerification.
    
    Returns:
    
    Signer
  - 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 Signer inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)
```
    inheritEmailNotificationConfiguration.
    
    Returns:
    
    Signer
  - 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 Signer isBulkRecipient(String isBulkRecipient)
```
    isBulkRecipient.
    
    Returns:
    
    Signer
  - getIsBulkRecipient
```
public String getIsBulkRecipient()
```
    When set to **true**, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. Note that when this is true the email and name for the recipient becomes [email protected] and \"Bulk Recipient\". These fields can not be changed for the bulk recipient. .
    
    Returns:
    
    isBulkRecipient
  - setIsBulkRecipient
```
public void setIsBulkRecipient(String isBulkRecipient)
```
    setIsBulkRecipient.
  - isBulkRecipientMetadata
```
public Signer isBulkRecipientMetadata(PropertyMetadata isBulkRecipientMetadata)
```
    isBulkRecipientMetadata.
    
    Returns:
    
    Signer
  - getIsBulkRecipientMetadata
```
public PropertyMetadata getIsBulkRecipientMetadata()
```
    Reserved for DocuSign..
    
    Returns:
    
    isBulkRecipientMetadata
  - setIsBulkRecipientMetadata
```
public void setIsBulkRecipientMetadata(PropertyMetadata isBulkRecipientMetadata)
```
    setIsBulkRecipientMetadata.
  - lastName
```
public Signer lastName(String lastName)
```
    lastName.
    
    Returns:
    
    Signer
  - getLastName
```
public String getLastName()
```
    .
    
    Returns:
    
    lastName
  - setLastName
```
public void setLastName(String lastName)
```
    setLastName.
  - lastNameMetadata
```
public Signer lastNameMetadata(PropertyMetadata lastNameMetadata)
```
    lastNameMetadata.
    
    Returns:
    
    Signer
  - 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 Signer lockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)
```
    lockedRecipientPhoneAuthEditable.
    
    Returns:
    
    Signer
  - getLockedRecipientPhoneAuthEditable
```
public String getLockedRecipientPhoneAuthEditable()
```
    .
    
    Returns:
    
    lockedRecipientPhoneAuthEditable
  - setLockedRecipientPhoneAuthEditable
```
public void setLockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)
```
    setLockedRecipientPhoneAuthEditable.
  - lockedRecipientSmsEditable
```
public Signer lockedRecipientSmsEditable(String lockedRecipientSmsEditable)
```
    lockedRecipientSmsEditable.
    
    Returns:
    
    Signer
  - getLockedRecipientSmsEditable
```
public String getLockedRecipientSmsEditable()
```
    .
    
    Returns:
    
    lockedRecipientSmsEditable
  - setLockedRecipientSmsEditable
```
public void setLockedRecipientSmsEditable(String lockedRecipientSmsEditable)
```
    setLockedRecipientSmsEditable.
  - name
```
public Signer name(String name)
```
    name.
    
    Returns:
    
    Signer
  - getName
```
public String getName()
```
    .
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
    setName.
  - nameMetadata
```
public Signer nameMetadata(PropertyMetadata nameMetadata)
```
    nameMetadata.
    
    Returns:
    
    Signer
  - 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 Signer notaryId(String notaryId)
```
    notaryId.
    
    Returns:
    
    Signer
  - getNotaryId
```
public String getNotaryId()
```
    .
    
    Returns:
    
    notaryId
  - setNotaryId
```
public void setNotaryId(String notaryId)
```
    setNotaryId.
  - notarySignerEmailSent
```
public Signer notarySignerEmailSent(String notarySignerEmailSent)
```
    notarySignerEmailSent.
    
    Returns:
    
    Signer
  - getNotarySignerEmailSent
```
public String getNotarySignerEmailSent()
```
    .
    
    Returns:
    
    notarySignerEmailSent
  - setNotarySignerEmailSent
```
public void setNotarySignerEmailSent(String notarySignerEmailSent)
```
    setNotarySignerEmailSent.
  - note
```
public Signer note(String note)
```
    note.
    
    Returns:
    
    Signer
  - 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 Signer noteMetadata(PropertyMetadata noteMetadata)
```
    noteMetadata.
    
    Returns:
    
    Signer
  - 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 Signer offlineAttributes(OfflineAttributes offlineAttributes)
```
    offlineAttributes.
    
    Returns:
    
    Signer
  - getOfflineAttributes
```
public OfflineAttributes getOfflineAttributes()
```
    Reserved for DocuSign..
    
    Returns:
    
    offlineAttributes
  - setOfflineAttributes
```
public void setOfflineAttributes(OfflineAttributes offlineAttributes)
```
    setOfflineAttributes.
  - phoneAuthentication
```
public Signer phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
```
    phoneAuthentication.
    
    Returns:
    
    Signer
  - 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 Signer phoneNumber(RecipientPhoneNumber phoneNumber)
```
    phoneNumber.
    
    Returns:
    
    Signer
  - getPhoneNumber
```
public RecipientPhoneNumber getPhoneNumber()
```
    Describes the recipient phone number..
    
    Returns:
    
    phoneNumber
  - setPhoneNumber
```
public void setPhoneNumber(RecipientPhoneNumber phoneNumber)
```
    setPhoneNumber.
  - proofFile
```
public Signer proofFile(RecipientProofFile proofFile)
```
    proofFile.
    
    Returns:
    
    Signer
  - getProofFile
```
public RecipientProofFile getProofFile()
```
    The proof file of the recipient..
    
    Returns:
    
    proofFile
  - setProofFile
```
public void setProofFile(RecipientProofFile proofFile)
```
    setProofFile.
  - recipientAttachments
```
public Signer recipientAttachments(List<RecipientAttachment> recipientAttachments)
```
    recipientAttachments.
    
    Returns:
    
    Signer
  - addRecipientAttachmentsItem
```
public Signer addRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)
```
    addRecipientAttachmentsItem.
    
    Returns:
    
    Signer
  - getRecipientAttachments
```
public List<RecipientAttachment> getRecipientAttachments()
```
    Reserved:.
    
    Returns:
    
    recipientAttachments
  - setRecipientAttachments
```
public void setRecipientAttachments(List<RecipientAttachment> recipientAttachments)
```
    setRecipientAttachments.
  - recipientAuthenticationStatus
```
public Signer recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
```
    recipientAuthenticationStatus.
    
    Returns:
    
    Signer
  - 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 Signer recipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)
```
    recipientFeatureMetadata.
    
    Returns:
    
    Signer
  - addRecipientFeatureMetadataItem
```
public Signer addRecipientFeatureMetadataItem(FeatureAvailableMetadata recipientFeatureMetadataItem)
```
    addRecipientFeatureMetadataItem.
    
    Returns:
    
    Signer
  - getRecipientFeatureMetadata
```
public List<FeatureAvailableMetadata> getRecipientFeatureMetadata()
```
    .
    
    Returns:
    
    recipientFeatureMetadata
  - setRecipientFeatureMetadata
```
public void setRecipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)
```
    setRecipientFeatureMetadata.
  - recipientId
```
public Signer recipientId(String recipientId)
```
    recipientId.
    
    Returns:
    
    Signer
  - 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 Signer recipientIdGuid(String recipientIdGuid)
```
    recipientIdGuid.
    
    Returns:
    
    Signer
  - getRecipientIdGuid
```
public String getRecipientIdGuid()
```
    .
    
    Returns:
    
    recipientIdGuid
  - setRecipientIdGuid
```
public void setRecipientIdGuid(String recipientIdGuid)
```
    setRecipientIdGuid.
  - recipientSignatureProviders
```
public Signer recipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)
```
    recipientSignatureProviders.
    
    Returns:
    
    Signer
  - addRecipientSignatureProvidersItem
```
public Signer addRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)
```
    addRecipientSignatureProvidersItem.
    
    Returns:
    
    Signer
  - getRecipientSignatureProviders
```
public List<RecipientSignatureProvider> getRecipientSignatureProviders()
```
    .
    
    Returns:
    
    recipientSignatureProviders
  - setRecipientSignatureProviders
```
public void setRecipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)
```
    setRecipientSignatureProviders.
  - recipientSuppliesTabs
```
public Signer recipientSuppliesTabs(String recipientSuppliesTabs)
```
    recipientSuppliesTabs.
    
    Returns:
    
    Signer
  - getRecipientSuppliesTabs
```
public String getRecipientSuppliesTabs()
```
    .
    
    Returns:
    
    recipientSuppliesTabs
  - setRecipientSuppliesTabs
```
public void setRecipientSuppliesTabs(String recipientSuppliesTabs)
```
    setRecipientSuppliesTabs.
  - recipientType
```
public Signer recipientType(String recipientType)
```
    recipientType.
    
    Returns:
    
    Signer
  - getRecipientType
```
public String getRecipientType()
```
    .
    
    Returns:
    
    recipientType
  - setRecipientType
```
public void setRecipientType(String recipientType)
```
    setRecipientType.
  - recipientTypeMetadata
```
public Signer recipientTypeMetadata(PropertyMetadata recipientTypeMetadata)
```
    recipientTypeMetadata.
    
    Returns:
    
    Signer
  - 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 Signer requireIdLookup(String requireIdLookup)
```
    requireIdLookup.
    
    Returns:
    
    Signer
  - 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 Signer requireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)
```
    requireIdLookupMetadata.
    
    Returns:
    
    Signer
  - 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 Signer requireSignerCertificate(String requireSignerCertificate)
```
    requireSignerCertificate.
    
    Returns:
    
    Signer
  - getRequireSignerCertificate
```
public String getRequireSignerCertificate()
```
    Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. The possible values are: * docusign_express - Requires a DocuSign Express certificate. * safe - Requires a SAFE-BioPharma certificate. * open_trust - Requires an OpenTrust certificate. **Important**: There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information. .
    
    Returns:
    
    requireSignerCertificate
  - setRequireSignerCertificate
```
public void setRequireSignerCertificate(String requireSignerCertificate)
```
    setRequireSignerCertificate.
  - requireSignOnPaper
```
public Signer requireSignOnPaper(String requireSignOnPaper)
```
    requireSignOnPaper.
    
    Returns:
    
    Signer
  - getRequireSignOnPaper
```
public String getRequireSignOnPaper()
```
    When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign..
    
    Returns:
    
    requireSignOnPaper
  - setRequireSignOnPaper
```
public void setRequireSignOnPaper(String requireSignOnPaper)
```
    setRequireSignOnPaper.
  - requireUploadSignature
```
public Signer requireUploadSignature(String requireUploadSignature)
```
    requireUploadSignature.
    
    Returns:
    
    Signer
  - getRequireUploadSignature
```
public String getRequireUploadSignature()
```
    .
    
    Returns:
    
    requireUploadSignature
  - setRequireUploadSignature
```
public void setRequireUploadSignature(String requireUploadSignature)
```
    setRequireUploadSignature.
  - roleName
```
public Signer roleName(String roleName)
```
    roleName.
    
    Returns:
    
    Signer
  - 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 Signer routingOrder(String routingOrder)
```
    routingOrder.
    
    Returns:
    
    Signer
  - 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 Signer routingOrderMetadata(PropertyMetadata routingOrderMetadata)
```
    routingOrderMetadata.
    
    Returns:
    
    Signer
  - 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 Signer sentDateTime(String sentDateTime)
```
    sentDateTime.
    
    Returns:
    
    Signer
  - getSentDateTime
```
public String getSentDateTime()
```
    The date and time the envelope was sent..
    
    Returns:
    
    sentDateTime
  - setSentDateTime
```
public void setSentDateTime(String sentDateTime)
```
    setSentDateTime.
  - signatureInfo
```
public Signer signatureInfo(RecipientSignatureInformation signatureInfo)
```
    signatureInfo.
    
    Returns:
    
    Signer
  - 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 Signer signedDateTime(String signedDateTime)
```
    signedDateTime.
    
    Returns:
    
    Signer
  - getSignedDateTime
```
public String getSignedDateTime()
```
    Reserved: For DocuSign use only. .
    
    Returns:
    
    signedDateTime
  - setSignedDateTime
```
public void setSignedDateTime(String signedDateTime)
```
    setSignedDateTime.
  - signInEachLocation
```
public Signer signInEachLocation(String signInEachLocation)
```
    signInEachLocation.
    
    Returns:
    
    Signer
  - 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 Signer signInEachLocationMetadata(PropertyMetadata signInEachLocationMetadata)
```
    signInEachLocationMetadata.
    
    Returns:
    
    Signer
  - 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 Signer signingGroupId(String signingGroupId)
```
    signingGroupId.
    
    Returns:
    
    Signer
  - 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 Signer signingGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)
```
    signingGroupIdMetadata.
    
    Returns:
    
    Signer
  - 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 Signer signingGroupName(String signingGroupName)
```
    signingGroupName.
    
    Returns:
    
    Signer
  - 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 Signer signingGroupUsers(List<UserInfo> signingGroupUsers)
```
    signingGroupUsers.
    
    Returns:
    
    Signer
  - addSigningGroupUsersItem
```
public Signer addSigningGroupUsersItem(UserInfo signingGroupUsersItem)
```
    addSigningGroupUsersItem.
    
    Returns:
    
    Signer
  - 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 Signer smsAuthentication(RecipientSMSAuthentication smsAuthentication)
```
    smsAuthentication.
    
    Returns:
    
    Signer
  - 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 Signer socialAuthentications(List<SocialAuthentication> socialAuthentications)
```
    socialAuthentications.
    
    Returns:
    
    Signer
  - addSocialAuthenticationsItem
```
public Signer addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)
```
    addSocialAuthenticationsItem.
    
    Returns:
    
    Signer
  - 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 Signer status(String status)
```
    status.
    
    Returns:
    
    Signer
  - 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 Signer statusCode(String statusCode)
```
    statusCode.
    
    Returns:
    
    Signer
  - getStatusCode
```
public String getStatusCode()
```
    .
    
    Returns:
    
    statusCode
  - setStatusCode
```
public void setStatusCode(String statusCode)
```
    setStatusCode.
  - suppressEmails
```
public Signer suppressEmails(String suppressEmails)
```
    suppressEmails.
    
    Returns:
    
    Signer
  - getSuppressEmails
```
public String getSuppressEmails()
```
    .
    
    Returns:
    
    suppressEmails
  - setSuppressEmails
```
public void setSuppressEmails(String suppressEmails)
```
    setSuppressEmails.
  - tabs
```
public Signer tabs(Tabs tabs)
```
    tabs.
    
    Returns:
    
    Signer
  - getTabs
```
public Tabs getTabs()
```
    The tabs to assign to the recipient. [More information](/docs/esign-rest-api/esign101/concepts/tabs/)..
    
    Returns:
    
    tabs
  - setTabs
```
public void setTabs(Tabs tabs)
```
    setTabs.
  - templateLocked
```
public Signer templateLocked(String templateLocked)
```
    templateLocked.
    
    Returns:
    
    Signer
  - 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 Signer templateRequired(String templateRequired)
```
    templateRequired.
    
    Returns:
    
    Signer
  - 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 Signer totalTabCount(String totalTabCount)
```
    totalTabCount.
    
    Returns:
    
    Signer
  - getTotalTabCount
```
public String getTotalTabCount()
```
    .
    
    Returns:
    
    totalTabCount
  - setTotalTabCount
```
public void setTotalTabCount(String totalTabCount)
```
    setTotalTabCount.
  - userId
```
public Signer userId(String userId)
```
    userId.
    
    Returns:
    
    Signer
  - getUserId
```
public String getUserId()
```
    .
    
    Returns:
    
    userId
  - setUserId
```
public void setUserId(String userId)
```
    setUserId.
  - 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 Signer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Signer

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