Signer (docusign-esign-java 2.9.0-beta-1 API)

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

```
public class Signer
extends Object
```
Signer

Constructor Summary

Constructors
Constructor and Description

Signer()

Constructors
Constructor and Description
`Signer()`

Method Summary

Methods
Modifier and Type	Method and Description
`Signer`	`accessCode(String accessCode)`
`Signer`	`addAccessCodeToEmail(String addAccessCodeToEmail)`
`Signer`	`addCustomFieldsItem(String customFieldsItem)`
`Signer`	`addDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)`
`Signer`	`addExcludedDocumentsItem(String excludedDocumentsItem)`
`Signer`	`addRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)`
`Signer`	`addRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)`
`Signer`	`addSigningGroupUsersItem(UserInfo signingGroupUsersItem)`
`Signer`	`addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)`
`Signer`	`agentCanEditEmail(String agentCanEditEmail)`
`Signer`	`agentCanEditName(String agentCanEditName)`
`Signer`	`autoNavigation(String autoNavigation)`
`Signer`	`bulkRecipientsUri(String bulkRecipientsUri)`
`Signer`	`canSignOffline(String canSignOffline)`
`Signer`	`clientUserId(String clientUserId)`
`Signer`	`creationReason(String creationReason)`
`Signer`	`customFields(List<String> customFields)`
`Signer`	`declinedDateTime(String declinedDateTime)`
`Signer`	`declinedReason(String declinedReason)`
`Signer`	`defaultRecipient(String defaultRecipient)`
`Signer`	`deliveredDateTime(String deliveredDateTime)`
`Signer`	`deliveryMethod(String deliveryMethod)`
`Signer`	`documentVisibility(List<DocumentVisibility> documentVisibility)`
`Signer`	`email(String email)`
`Signer`	`emailNotification(RecipientEmailNotification emailNotification)`
`Signer`	`emailRecipientPostSigningURL(String emailRecipientPostSigningURL)`
`Signer`	`embeddedRecipientStartURL(String embeddedRecipientStartURL)`
`boolean`	`equals(Object o)`
`Signer`	`errorDetails(ErrorDetails errorDetails)`
`Signer`	`excludedDocuments(List<String> excludedDocuments)`
`Signer`	`faxNumber(String faxNumber)`
`String`	`getAccessCode()` If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
`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.
`String`	`getAgentCanEditEmail()`
`String`	`getAgentCanEditName()`
`String`	`getAutoNavigation()`
`String`	`getBulkRecipientsUri()` Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information.
`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`	`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()`
`String`	`getDeliveredDateTime()` Reserved: For DocuSign use only.
`String`	`getDeliveryMethod()` Reserved: For DocuSign use only.
`List<DocumentVisibility>`	`getDocumentVisibility()`
`String`	`getEmail()` Email id of the recipient.
`RecipientEmailNotification`	`getEmailNotification()` Get emailNotification
`String`	`getEmailRecipientPostSigningURL()`
`String`	`getEmbeddedRecipientStartURL()` Specifies a sender provided valid URL string for redirecting an embedded recipient.
`ErrorDetails`	`getErrorDetails()` Get errorDetails
`List<String>`	`getExcludedDocuments()` Specifies the documents that are not visible to this recipient.
`String`	`getFaxNumber()` Reserved:
`String`	`getIdCheckConfigurationName()` Specifies authentication check by name.
`IdCheckInformationInput`	`getIdCheckInformationInput()` Get idCheckInformationInput
`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.
`String`	`getName()`
`String`	`getNote()` Specifies a note that is unique to this recipient.
`OfflineAttributes`	`getOfflineAttributes()` Get offlineAttributes
`RecipientPhoneAuthentication`	`getPhoneAuthentication()` Get phoneAuthentication
`List<RecipientAttachment>`	`getRecipientAttachments()` Reserved:
`AuthenticationStatus`	`getRecipientAuthenticationStatus()` Get recipientAuthenticationStatus
`String`	`getRecipientId()` Unique for the recipient.
`String`	`getRecipientIdGuid()`
`List<RecipientSignatureProvider>`	`getRecipientSignatureProviders()`
`String`	`getRecipientSuppliesTabs()`
`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.
`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`	`getRoleName()` Optional element.
`String`	`getRoutingOrder()` Specifies the routing order of the recipient in the envelope.
`RecipientSAMLAuthentication`	`getSamlAuthentication()` Get samlAuthentication
`String`	`getSentDateTime()` The date and time the envelope was sent.
`RecipientSignatureInformation`	`getSignatureInfo()` Get signatureInfo
`String`	`getSignedDateTime()` Reserved: For DocuSign use only.
`String`	`getSignInEachLocation()` When set to true, specifies that the signer must sign in all locations.
`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).
`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()` Get smsAuthentication
`List<SocialAuthentication>`	`getSocialAuthentications()` Lists the social ID type that can be used for recipient authentication.
`String`	`getStatus()` Indicates the envelope status.
`Tabs`	`getTabs()` Get tabs
`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()`
`Signer`	`idCheckConfigurationName(String idCheckConfigurationName)`
`Signer`	`idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)`
`Signer`	`inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)`
`Signer`	`isBulkRecipient(String isBulkRecipient)`
`Signer`	`name(String name)`
`Signer`	`note(String note)`
`Signer`	`offlineAttributes(OfflineAttributes offlineAttributes)`
`Signer`	`phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)`
`Signer`	`recipientAttachments(List<RecipientAttachment> recipientAttachments)`
`Signer`	`recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)`
`Signer`	`recipientId(String recipientId)`
`Signer`	`recipientIdGuid(String recipientIdGuid)`
`Signer`	`recipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)`
`Signer`	`recipientSuppliesTabs(String recipientSuppliesTabs)`
`Signer`	`requireIdLookup(String requireIdLookup)`
`Signer`	`requireSignerCertificate(String requireSignerCertificate)`
`Signer`	`requireSignOnPaper(String requireSignOnPaper)`
`Signer`	`roleName(String roleName)`
`Signer`	`routingOrder(String routingOrder)`
`Signer`	`samlAuthentication(RecipientSAMLAuthentication samlAuthentication)`
`Signer`	`sentDateTime(String sentDateTime)`
`void`	`setAccessCode(String accessCode)`
`void`	`setAddAccessCodeToEmail(String addAccessCodeToEmail)`
`void`	`setAgentCanEditEmail(String agentCanEditEmail)`
`void`	`setAgentCanEditName(String agentCanEditName)`
`void`	`setAutoNavigation(String autoNavigation)`
`void`	`setBulkRecipientsUri(String bulkRecipientsUri)`
`void`	`setCanSignOffline(String canSignOffline)`
`void`	`setClientUserId(String clientUserId)`
`void`	`setCreationReason(String creationReason)`
`void`	`setCustomFields(List<String> customFields)`
`void`	`setDeclinedDateTime(String declinedDateTime)`
`void`	`setDeclinedReason(String declinedReason)`
`void`	`setDefaultRecipient(String defaultRecipient)`
`void`	`setDeliveredDateTime(String deliveredDateTime)`
`void`	`setDeliveryMethod(String deliveryMethod)`
`void`	`setDocumentVisibility(List<DocumentVisibility> documentVisibility)`
`void`	`setEmail(String email)`
`void`	`setEmailNotification(RecipientEmailNotification emailNotification)`
`void`	`setEmailRecipientPostSigningURL(String emailRecipientPostSigningURL)`
`void`	`setEmbeddedRecipientStartURL(String embeddedRecipientStartURL)`
`void`	`setErrorDetails(ErrorDetails errorDetails)`
`void`	`setExcludedDocuments(List<String> excludedDocuments)`
`void`	`setFaxNumber(String faxNumber)`
`void`	`setIdCheckConfigurationName(String idCheckConfigurationName)`
`void`	`setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)`
`void`	`setInheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)`
`void`	`setIsBulkRecipient(String isBulkRecipient)`
`void`	`setName(String name)`
`void`	`setNote(String note)`
`void`	`setOfflineAttributes(OfflineAttributes offlineAttributes)`
`void`	`setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)`
`void`	`setRecipientAttachments(List<RecipientAttachment> recipientAttachments)`
`void`	`setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)`
`void`	`setRecipientId(String recipientId)`
`void`	`setRecipientIdGuid(String recipientIdGuid)`
`void`	`setRecipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)`
`void`	`setRecipientSuppliesTabs(String recipientSuppliesTabs)`
`void`	`setRequireIdLookup(String requireIdLookup)`
`void`	`setRequireSignerCertificate(String requireSignerCertificate)`
`void`	`setRequireSignOnPaper(String requireSignOnPaper)`
`void`	`setRoleName(String roleName)`
`void`	`setRoutingOrder(String routingOrder)`
`void`	`setSamlAuthentication(RecipientSAMLAuthentication samlAuthentication)`
`void`	`setSentDateTime(String sentDateTime)`
`void`	`setSignatureInfo(RecipientSignatureInformation signatureInfo)`
`void`	`setSignedDateTime(String signedDateTime)`
`void`	`setSignInEachLocation(String signInEachLocation)`
`void`	`setSigningGroupId(String signingGroupId)`
`void`	`setSigningGroupName(String signingGroupName)`
`void`	`setSigningGroupUsers(List<UserInfo> signingGroupUsers)`
`void`	`setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)`
`void`	`setSocialAuthentications(List<SocialAuthentication> socialAuthentications)`
`void`	`setStatus(String status)`
`void`	`setTabs(Tabs tabs)`
`void`	`setTemplateLocked(String templateLocked)`
`void`	`setTemplateRequired(String templateRequired)`
`void`	`setTotalTabCount(String totalTabCount)`
`void`	`setUserId(String userId)`
`Signer`	`signatureInfo(RecipientSignatureInformation signatureInfo)`
`Signer`	`signedDateTime(String signedDateTime)`
`Signer`	`signInEachLocation(String signInEachLocation)`
`Signer`	`signingGroupId(String signingGroupId)`
`Signer`	`signingGroupName(String signingGroupName)`
`Signer`	`signingGroupUsers(List<UserInfo> signingGroupUsers)`
`Signer`	`smsAuthentication(RecipientSMSAuthentication smsAuthentication)`
`Signer`	`socialAuthentications(List<SocialAuthentication> socialAuthentications)`
`Signer`	`status(String status)`
`Signer`	`tabs(Tabs tabs)`
`Signer`	`templateLocked(String templateLocked)`
`Signer`	`templateRequired(String templateRequired)`
`String`	`toString()`
`Signer`	`totalTabCount(String totalTabCount)`
`Signer`	`userId(String 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)
```
  - 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)
```
  - addAccessCodeToEmail
```
public Signer addAccessCodeToEmail(String addAccessCodeToEmail)
```
  - 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)
```
  - agentCanEditEmail
```
public Signer agentCanEditEmail(String agentCanEditEmail)
```
  - getAgentCanEditEmail
```
public String getAgentCanEditEmail()
```
    Returns:
    agentCanEditEmail
  - setAgentCanEditEmail
```
public void setAgentCanEditEmail(String agentCanEditEmail)
```
  - agentCanEditName
```
public Signer agentCanEditName(String agentCanEditName)
```
  - getAgentCanEditName
```
public String getAgentCanEditName()
```
    Returns:
    agentCanEditName
  - setAgentCanEditName
```
public void setAgentCanEditName(String agentCanEditName)
```
  - autoNavigation
```
public Signer autoNavigation(String autoNavigation)
```
  - getAutoNavigation
```
public String getAutoNavigation()
```
    Returns:
    autoNavigation
  - setAutoNavigation
```
public void setAutoNavigation(String autoNavigation)
```
  - bulkRecipientsUri
```
public Signer bulkRecipientsUri(String bulkRecipientsUri)
```
  - 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)
```
  - canSignOffline
```
public Signer canSignOffline(String canSignOffline)
```
  - 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)
```
  - clientUserId
```
public Signer clientUserId(String clientUserId)
```
  - 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)
```
  - creationReason
```
public Signer creationReason(String creationReason)
```
  - getCreationReason
```
public String getCreationReason()
```
    Returns:
    creationReason
  - setCreationReason
```
public void setCreationReason(String creationReason)
```
  - customFields
```
public Signer customFields(List<String> customFields)
```
  - addCustomFieldsItem
```
public Signer addCustomFieldsItem(String customFieldsItem)
```
  - 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)
```
  - declinedDateTime
```
public Signer declinedDateTime(String declinedDateTime)
```
  - getDeclinedDateTime
```
public String getDeclinedDateTime()
```
    The date and time the recipient declined the document.
    
    Returns:
    declinedDateTime
  - setDeclinedDateTime
```
public void setDeclinedDateTime(String declinedDateTime)
```
  - declinedReason
```
public Signer declinedReason(String declinedReason)
```
  - getDeclinedReason
```
public String getDeclinedReason()
```
    The reason the recipient declined the document.
    
    Returns:
    declinedReason
  - setDeclinedReason
```
public void setDeclinedReason(String declinedReason)
```
  - defaultRecipient
```
public Signer defaultRecipient(String defaultRecipient)
```
  - getDefaultRecipient
```
public String getDefaultRecipient()
```
    Returns:
    defaultRecipient
  - setDefaultRecipient
```
public void setDefaultRecipient(String defaultRecipient)
```
  - deliveredDateTime
```
public Signer deliveredDateTime(String deliveredDateTime)
```
  - getDeliveredDateTime
```
public String getDeliveredDateTime()
```
    Reserved: For DocuSign use only.
    
    Returns:
    deliveredDateTime
  - setDeliveredDateTime
```
public void setDeliveredDateTime(String deliveredDateTime)
```
  - deliveryMethod
```
public Signer deliveryMethod(String deliveryMethod)
```
  - getDeliveryMethod
```
public String getDeliveryMethod()
```
    Reserved: For DocuSign use only.
    
    Returns:
    deliveryMethod
  - setDeliveryMethod
```
public void setDeliveryMethod(String deliveryMethod)
```
  - documentVisibility
```
public Signer documentVisibility(List<DocumentVisibility> documentVisibility)
```
  - addDocumentVisibilityItem
```
public Signer addDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)
```
  - getDocumentVisibility
```
public List<DocumentVisibility> getDocumentVisibility()
```
    Returns:
    documentVisibility
  - setDocumentVisibility
```
public void setDocumentVisibility(List<DocumentVisibility> documentVisibility)
```
  - email
```
public Signer email(String email)
```
  - 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)
```
  - emailNotification
```
public Signer emailNotification(RecipientEmailNotification emailNotification)
```
  - getEmailNotification
```
public RecipientEmailNotification getEmailNotification()
```
    Get emailNotification
    
    Returns:
    emailNotification
  - setEmailNotification
```
public void setEmailNotification(RecipientEmailNotification emailNotification)
```
  - emailRecipientPostSigningURL
```
public Signer emailRecipientPostSigningURL(String emailRecipientPostSigningURL)
```
  - getEmailRecipientPostSigningURL
```
public String getEmailRecipientPostSigningURL()
```
    Returns:
    emailRecipientPostSigningURL
  - setEmailRecipientPostSigningURL
```
public void setEmailRecipientPostSigningURL(String emailRecipientPostSigningURL)
```
  - embeddedRecipientStartURL
```
public Signer embeddedRecipientStartURL(String embeddedRecipientStartURL)
```
  - 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)
```
  - errorDetails
```
public Signer errorDetails(ErrorDetails errorDetails)
```
  - getErrorDetails
```
public ErrorDetails getErrorDetails()
```
    Get errorDetails
    
    Returns:
    errorDetails
  - setErrorDetails
```
public void setErrorDetails(ErrorDetails errorDetails)
```
  - excludedDocuments
```
public Signer excludedDocuments(List<String> excludedDocuments)
```
  - addExcludedDocumentsItem
```
public Signer addExcludedDocumentsItem(String excludedDocumentsItem)
```
  - 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)
```
  - faxNumber
```
public Signer faxNumber(String faxNumber)
```
  - getFaxNumber
```
public String getFaxNumber()
```
    Reserved:
    
    Returns:
    faxNumber
  - setFaxNumber
```
public void setFaxNumber(String faxNumber)
```
  - idCheckConfigurationName
```
public Signer idCheckConfigurationName(String idCheckConfigurationName)
```
  - 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)
```
  - idCheckInformationInput
```
public Signer idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
```
  - getIdCheckInformationInput
```
public IdCheckInformationInput getIdCheckInformationInput()
```
    Get idCheckInformationInput
    
    Returns:
    idCheckInformationInput
  - setIdCheckInformationInput
```
public void setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
```
  - inheritEmailNotificationConfiguration
```
public Signer inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)
```
  - 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)
```
  - isBulkRecipient
```
public Signer isBulkRecipient(String isBulkRecipient)
```
  - 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 bulk@recipient.com and \"Bulk Recipient\". These fields can not be changed for the bulk recipient.
    
    Returns:
    isBulkRecipient
  - setIsBulkRecipient
```
public void setIsBulkRecipient(String isBulkRecipient)
```
  - name
```
public Signer name(String name)
```
  - getName
```
public String getName()
```
    Returns:
    name
  - setName
```
public void setName(String name)
```
  - note
```
public Signer note(String note)
```
  - 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)
```
  - offlineAttributes
```
public Signer offlineAttributes(OfflineAttributes offlineAttributes)
```
  - getOfflineAttributes
```
public OfflineAttributes getOfflineAttributes()
```
    Get offlineAttributes
    
    Returns:
    offlineAttributes
  - setOfflineAttributes
```
public void setOfflineAttributes(OfflineAttributes offlineAttributes)
```
  - phoneAuthentication
```
public Signer phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
```
  - getPhoneAuthentication
```
public RecipientPhoneAuthentication getPhoneAuthentication()
```
    Get phoneAuthentication
    
    Returns:
    phoneAuthentication
  - setPhoneAuthentication
```
public void setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
```
  - recipientAttachments
```
public Signer recipientAttachments(List<RecipientAttachment> recipientAttachments)
```
  - addRecipientAttachmentsItem
```
public Signer addRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)
```
  - getRecipientAttachments
```
public List<RecipientAttachment> getRecipientAttachments()
```
    Reserved:
    
    Returns:
    recipientAttachments
  - setRecipientAttachments
```
public void setRecipientAttachments(List<RecipientAttachment> recipientAttachments)
```
  - recipientAuthenticationStatus
```
public Signer recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
```
  - getRecipientAuthenticationStatus
```
public AuthenticationStatus getRecipientAuthenticationStatus()
```
    Get recipientAuthenticationStatus
    
    Returns:
    recipientAuthenticationStatus
  - setRecipientAuthenticationStatus
```
public void setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
```
  - recipientId
```
public Signer recipientId(String recipientId)
```
  - 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)
```
  - recipientIdGuid
```
public Signer recipientIdGuid(String recipientIdGuid)
```
  - getRecipientIdGuid
```
public String getRecipientIdGuid()
```
    Returns:
    recipientIdGuid
  - setRecipientIdGuid
```
public void setRecipientIdGuid(String recipientIdGuid)
```
  - recipientSignatureProviders
```
public Signer recipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)
```
  - addRecipientSignatureProvidersItem
```
public Signer addRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)
```
  - getRecipientSignatureProviders
```
public List<RecipientSignatureProvider> getRecipientSignatureProviders()
```
    Returns:
    recipientSignatureProviders
  - setRecipientSignatureProviders
```
public void setRecipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)
```
  - recipientSuppliesTabs
```
public Signer recipientSuppliesTabs(String recipientSuppliesTabs)
```
  - getRecipientSuppliesTabs
```
public String getRecipientSuppliesTabs()
```
    Returns:
    recipientSuppliesTabs
  - setRecipientSuppliesTabs
```
public void setRecipientSuppliesTabs(String recipientSuppliesTabs)
```
  - requireIdLookup
```
public Signer requireIdLookup(String requireIdLookup)
```
  - 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)
```
  - requireSignerCertificate
```
public Signer requireSignerCertificate(String requireSignerCertificate)
```
  - 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)
```
  - requireSignOnPaper
```
public Signer requireSignOnPaper(String requireSignOnPaper)
```
  - 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)
```
  - roleName
```
public Signer roleName(String roleName)
```
  - 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)
```
  - routingOrder
```
public Signer routingOrder(String routingOrder)
```
  - getRoutingOrder
```
public String getRoutingOrder()
```
    Specifies the routing order of the recipient in the envelope.
    
    Returns:
    routingOrder
  - setRoutingOrder
```
public void setRoutingOrder(String routingOrder)
```
  - samlAuthentication
```
public Signer samlAuthentication(RecipientSAMLAuthentication samlAuthentication)
```
  - getSamlAuthentication
```
public RecipientSAMLAuthentication getSamlAuthentication()
```
    Get samlAuthentication
    
    Returns:
    samlAuthentication
  - setSamlAuthentication
```
public void setSamlAuthentication(RecipientSAMLAuthentication samlAuthentication)
```
  - sentDateTime
```
public Signer sentDateTime(String sentDateTime)
```
  - getSentDateTime
```
public String getSentDateTime()
```
    The date and time the envelope was sent.
    
    Returns:
    sentDateTime
  - setSentDateTime
```
public void setSentDateTime(String sentDateTime)
```
  - signatureInfo
```
public Signer signatureInfo(RecipientSignatureInformation signatureInfo)
```
  - getSignatureInfo
```
public RecipientSignatureInformation getSignatureInfo()
```
    Get signatureInfo
    
    Returns:
    signatureInfo
  - setSignatureInfo
```
public void setSignatureInfo(RecipientSignatureInformation signatureInfo)
```
  - signedDateTime
```
public Signer signedDateTime(String signedDateTime)
```
  - getSignedDateTime
```
public String getSignedDateTime()
```
    Reserved: For DocuSign use only.
    
    Returns:
    signedDateTime
  - setSignedDateTime
```
public void setSignedDateTime(String signedDateTime)
```
  - signInEachLocation
```
public Signer signInEachLocation(String signInEachLocation)
```
  - 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)
```
  - signingGroupId
```
public Signer signingGroupId(String signingGroupId)
```
  - 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)
```
  - signingGroupName
```
public Signer signingGroupName(String signingGroupName)
```
  - getSigningGroupName
```
public String getSigningGroupName()
```
    The display name for the signing group. Maximum Length: 100 characters.
    
    Returns:
    signingGroupName
  - setSigningGroupName
```
public void setSigningGroupName(String signingGroupName)
```
  - signingGroupUsers
```
public Signer signingGroupUsers(List<UserInfo> signingGroupUsers)
```
  - addSigningGroupUsersItem
```
public Signer addSigningGroupUsersItem(UserInfo signingGroupUsersItem)
```
  - 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)
```
  - smsAuthentication
```
public Signer smsAuthentication(RecipientSMSAuthentication smsAuthentication)
```
  - getSmsAuthentication
```
public RecipientSMSAuthentication getSmsAuthentication()
```
    Get smsAuthentication
    
    Returns:
    smsAuthentication
  - setSmsAuthentication
```
public void setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)
```
  - socialAuthentications
```
public Signer socialAuthentications(List<SocialAuthentication> socialAuthentications)
```
  - addSocialAuthenticationsItem
```
public Signer addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)
```
  - 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)
```
  - status
```
public Signer status(String status)
```
  - 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)
```
  - tabs
```
public Signer tabs(Tabs tabs)
```
  - getTabs
```
public Tabs getTabs()
```
    Get tabs
    
    Returns:
    tabs
  - setTabs
```
public void setTabs(Tabs tabs)
```
  - templateLocked
```
public Signer templateLocked(String templateLocked)
```
  - 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)
```
  - templateRequired
```
public Signer templateRequired(String templateRequired)
```
  - 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)
```
  - totalTabCount
```
public Signer totalTabCount(String totalTabCount)
```
  - getTotalTabCount
```
public String getTotalTabCount()
```
    Returns:
    totalTabCount
  - setTotalTabCount
```
public void setTotalTabCount(String totalTabCount)
```
  - userId
```
public Signer userId(String userId)
```
  - getUserId
```
public String getUserId()
```
    Returns:
    userId
  - setUserId
```
public void setUserId(String userId)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    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

addAccessCodeToEmail

getAddAccessCodeToEmail

setAddAccessCodeToEmail

agentCanEditEmail

getAgentCanEditEmail

setAgentCanEditEmail

agentCanEditName

getAgentCanEditName

setAgentCanEditName

autoNavigation

getAutoNavigation

setAutoNavigation

bulkRecipientsUri

getBulkRecipientsUri

setBulkRecipientsUri

canSignOffline

getCanSignOffline

setCanSignOffline

clientUserId

getClientUserId

setClientUserId

creationReason

getCreationReason

setCreationReason

customFields

addCustomFieldsItem

getCustomFields

setCustomFields

declinedDateTime

getDeclinedDateTime

setDeclinedDateTime

declinedReason

getDeclinedReason

setDeclinedReason

defaultRecipient

getDefaultRecipient

setDefaultRecipient

deliveredDateTime

getDeliveredDateTime

setDeliveredDateTime

deliveryMethod

getDeliveryMethod

setDeliveryMethod

documentVisibility

addDocumentVisibilityItem

getDocumentVisibility

setDocumentVisibility

email

getEmail

setEmail

emailNotification

getEmailNotification

setEmailNotification

emailRecipientPostSigningURL

getEmailRecipientPostSigningURL

setEmailRecipientPostSigningURL

embeddedRecipientStartURL

getEmbeddedRecipientStartURL

setEmbeddedRecipientStartURL

errorDetails

getErrorDetails

setErrorDetails

excludedDocuments

addExcludedDocumentsItem

getExcludedDocuments

setExcludedDocuments

faxNumber

getFaxNumber

setFaxNumber

idCheckConfigurationName