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

All Implemented Interfaces:

Serializable
```
public class Participant
extends Object
implements Serializable
```
Participant.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

Participant()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Participant`	`accessCode(String accessCode)`	accessCode.
`Participant`	`accessCodeMetadata(PropertyMetadata accessCodeMetadata)`	accessCodeMetadata.
`Participant`	`addAccessCodeToEmail(String addAccessCodeToEmail)`	addAccessCodeToEmail.
`Participant`	`addAdditionalNotificationsItem(RecipientAdditionalNotification additionalNotificationsItem)`	addAdditionalNotificationsItem.
`Participant`	`addConsentDetailsListItem(ConsentDetails consentDetailsListItem)`	addConsentDetailsListItem.
`Participant`	`addCustomFieldsItem(String customFieldsItem)`	addCustomFieldsItem.
`Participant`	`addDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)`	addDocumentVisibilityItem.
`Participant`	`additionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)`	additionalNotifications.
`Participant`	`addRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)`	addRecipientAttachmentsItem.
`Participant`	`addRecipientFeatureMetadataItem(FeatureAvailableMetadata recipientFeatureMetadataItem)`	addRecipientFeatureMetadataItem.
`Participant`	`addSigningGroupUsersItem(UserInfo signingGroupUsersItem)`	addSigningGroupUsersItem.
`Participant`	`addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)`	addSocialAuthenticationsItem.
`Participant`	`allowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)`	allowSystemOverrideForLockedRecipient.
`Participant`	`autoRespondedReason(String autoRespondedReason)`	autoRespondedReason.
`Participant`	`bulkSendV2Recipient(String bulkSendV2Recipient)`	bulkSendV2Recipient.
`Participant`	`clientUserId(String clientUserId)`	clientUserId.
`Participant`	`completedCount(String completedCount)`	completedCount.
`Participant`	`consentDetailsList(List<ConsentDetails> consentDetailsList)`	consentDetailsList.
`Participant`	`customFields(List<String> customFields)`	customFields.
`Participant`	`declinedDateTime(String declinedDateTime)`	declinedDateTime.
`Participant`	`declinedReason(String declinedReason)`	declinedReason.
`Participant`	`deliveredDateTime(String deliveredDateTime)`	deliveredDateTime.
`Participant`	`deliveryMethod(String deliveryMethod)`	deliveryMethod.
`Participant`	`deliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)`	deliveryMethodMetadata.
`Participant`	`designatorId(String designatorId)`	designatorId.
`Participant`	`designatorIdGuid(String designatorIdGuid)`	designatorIdGuid.
`Participant`	`documentTemplateId(String documentTemplateId)`	documentTemplateId.
`Participant`	`documentVisibility(List<DocumentVisibility> documentVisibility)`	documentVisibility.
`Participant`	`email(String email)`	email.
`Participant`	`emailMetadata(PropertyMetadata emailMetadata)`	emailMetadata.
`Participant`	`emailNotification(RecipientEmailNotification emailNotification)`	emailNotification.
`Participant`	`emailRecipientPostSigningURL(String emailRecipientPostSigningURL)`	emailRecipientPostSigningURL.
`Participant`	`embeddedRecipientStartURL(String embeddedRecipientStartURL)`	embeddedRecipientStartURL.
`boolean`	`equals(Object o)`	Compares objects.
`Participant`	`errorDetails(ErrorDetails errorDetails)`	errorDetails.
`Participant`	`faxNumber(String faxNumber)`	faxNumber.
`Participant`	`faxNumberMetadata(PropertyMetadata faxNumberMetadata)`	faxNumberMetadata.
`Participant`	`firstName(String firstName)`	firstName.
`Participant`	`firstNameMetadata(PropertyMetadata firstNameMetadata)`	firstNameMetadata.
`Participant`	`fullName(String fullName)`	fullName.
`Participant`	`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()`	.
`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`	`getAllowSystemOverrideForLockedRecipient()`	.
`String`	`getAutoRespondedReason()`	.
`String`	`getBulkSendV2Recipient()`	.
`String`	`getClientUserId()`	Specifies whether the recipient is embedded or remote.
`String`	`getCompletedCount()`	.
`List<ConsentDetails>`	`getConsentDetailsList()`	.
`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`	`getDeliveredDateTime()`	Reserved: For DocuSign use only..
`String`	`getDeliveryMethod()`	Reserved: For DocuSign use only..
`PropertyMetadata`	`getDeliveryMethodMetadata()`	.
`String`	`getDesignatorId()`	.
`String`	`getDesignatorIdGuid()`	.
`String`	`getDocumentTemplateId()`	.
`List<DocumentVisibility>`	`getDocumentVisibility()`	.
`String`	`getEmail()`	.
`PropertyMetadata`	`getEmailMetadata()`	.
`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..
`String`	`getFaxNumber()`	Reserved:.
`PropertyMetadata`	`getFaxNumberMetadata()`	.
`String`	`getFirstName()`	The user's first name.
`PropertyMetadata`	`getFirstNameMetadata()`	.
`String`	`getFullName()`	.
`PropertyMetadata`	`getFullNameMetadata()`	.
`String`	`getIdCheckConfigurationName()`	Specifies authentication check by name.
`PropertyMetadata`	`getIdCheckConfigurationNameMetadata()`	.
`IdCheckInformationInput`	`getIdCheckInformationInput()`	.
`RecipientIdentityVerification`	`getIdentityVerification()`	.
`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`	`getLastName()`	.
`PropertyMetadata`	`getLastNameMetadata()`	.
`String`	`getLockedRecipientPhoneAuthEditable()`	.
`String`	`getLockedRecipientSmsEditable()`	.
`String`	`getName()`	.
`PropertyMetadata`	`getNameMetadata()`	.
`String`	`getNote()`	Specifies a note that is unique to this recipient.
`PropertyMetadata`	`getNoteMetadata()`	.
`String`	`getParticipateFor()`	.
`String`	`getParticipateForGuid()`	.
`RecipientPhoneAuthentication`	`getPhoneAuthentication()`	.
`RecipientPhoneNumber`	`getPhoneNumber()`	.
`List<RecipientAttachment>`	`getRecipientAttachments()`	Reserved:.
`AuthenticationStatus`	`getRecipientAuthenticationStatus()`	.
`List<FeatureAvailableMetadata>`	`getRecipientFeatureMetadata()`	.
`String`	`getRecipientId()`	Unique for the recipient.
`String`	`getRecipientIdGuid()`	.
`String`	`getRecipientType()`	.
`PropertyMetadata`	`getRecipientTypeMetadata()`	.
`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()`	.
`String`	`getRoleName()`	Optional element.
`String`	`getRoutingOrder()`	Specifies the routing order of the recipient in the envelope.
`PropertyMetadata`	`getRoutingOrderMetadata()`	.
`String`	`getSentDateTime()`	The date and time the envelope was sent..
`String`	`getSignedDateTime()`	Reserved: For DocuSign use only.
`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()`	.
`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()`	.
`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()`	.
`String`	`getTemplateLocked()`	When set to true, the sender cannot change any attributes of the recipient.
`String`	`getTemplateRequired()`	When set to true, the sender may not remove the recipient.
`String`	`getTotalTabCount()`	.
`String`	`getUserId()`	.
`String`	`getWebFormRecipientViewId()`	.
`int`	`hashCode()`	Returns the HashCode.
`Participant`	`idCheckConfigurationName(String idCheckConfigurationName)`	idCheckConfigurationName.
`Participant`	`idCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)`	idCheckConfigurationNameMetadata.
`Participant`	`idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)`	idCheckInformationInput.
`Participant`	`identityVerification(RecipientIdentityVerification identityVerification)`	identityVerification.
`Participant`	`inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)`	inheritEmailNotificationConfiguration.
`Participant`	`lastName(String lastName)`	lastName.
`Participant`	`lastNameMetadata(PropertyMetadata lastNameMetadata)`	lastNameMetadata.
`Participant`	`lockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)`	lockedRecipientPhoneAuthEditable.
`Participant`	`lockedRecipientSmsEditable(String lockedRecipientSmsEditable)`	lockedRecipientSmsEditable.
`Participant`	`name(String name)`	name.
`Participant`	`nameMetadata(PropertyMetadata nameMetadata)`	nameMetadata.
`Participant`	`note(String note)`	note.
`Participant`	`noteMetadata(PropertyMetadata noteMetadata)`	noteMetadata.
`Participant`	`participateFor(String participateFor)`	participateFor.
`Participant`	`participateForGuid(String participateForGuid)`	participateForGuid.
`Participant`	`phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)`	phoneAuthentication.
`Participant`	`phoneNumber(RecipientPhoneNumber phoneNumber)`	phoneNumber.
`Participant`	`recipientAttachments(List<RecipientAttachment> recipientAttachments)`	recipientAttachments.
`Participant`	`recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)`	recipientAuthenticationStatus.
`Participant`	`recipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)`	recipientFeatureMetadata.
`Participant`	`recipientId(String recipientId)`	recipientId.
`Participant`	`recipientIdGuid(String recipientIdGuid)`	recipientIdGuid.
`Participant`	`recipientType(String recipientType)`	recipientType.
`Participant`	`recipientTypeMetadata(PropertyMetadata recipientTypeMetadata)`	recipientTypeMetadata.
`Participant`	`requireIdLookup(String requireIdLookup)`	requireIdLookup.
`Participant`	`requireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)`	requireIdLookupMetadata.
`Participant`	`roleName(String roleName)`	roleName.
`Participant`	`routingOrder(String routingOrder)`	routingOrder.
`Participant`	`routingOrderMetadata(PropertyMetadata routingOrderMetadata)`	routingOrderMetadata.
`Participant`	`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`	`setAllowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)`	setAllowSystemOverrideForLockedRecipient.
`void`	`setAutoRespondedReason(String autoRespondedReason)`	setAutoRespondedReason.
`void`	`setBulkSendV2Recipient(String bulkSendV2Recipient)`	setBulkSendV2Recipient.
`void`	`setClientUserId(String clientUserId)`	setClientUserId.
`void`	`setCompletedCount(String completedCount)`	setCompletedCount.
`void`	`setConsentDetailsList(List<ConsentDetails> consentDetailsList)`	setConsentDetailsList.
`void`	`setCustomFields(List<String> customFields)`	setCustomFields.
`void`	`setDeclinedDateTime(String declinedDateTime)`	setDeclinedDateTime.
`void`	`setDeclinedReason(String declinedReason)`	setDeclinedReason.
`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`	`setDocumentTemplateId(String documentTemplateId)`	setDocumentTemplateId.
`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`	`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`	`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`	`setNote(String note)`	setNote.
`void`	`setNoteMetadata(PropertyMetadata noteMetadata)`	setNoteMetadata.
`void`	`setParticipateFor(String participateFor)`	setParticipateFor.
`void`	`setParticipateForGuid(String participateForGuid)`	setParticipateForGuid.
`void`	`setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)`	setPhoneAuthentication.
`void`	`setPhoneNumber(RecipientPhoneNumber phoneNumber)`	setPhoneNumber.
`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`	`setRecipientType(String recipientType)`	setRecipientType.
`void`	`setRecipientTypeMetadata(PropertyMetadata recipientTypeMetadata)`	setRecipientTypeMetadata.
`void`	`setRequireIdLookup(String requireIdLookup)`	setRequireIdLookup.
`void`	`setRequireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)`	setRequireIdLookupMetadata.
`void`	`setRoleName(String roleName)`	setRoleName.
`void`	`setRoutingOrder(String routingOrder)`	setRoutingOrder.
`void`	`setRoutingOrderMetadata(PropertyMetadata routingOrderMetadata)`	setRoutingOrderMetadata.
`void`	`setSentDateTime(String sentDateTime)`	setSentDateTime.
`void`	`setSignedDateTime(String signedDateTime)`	setSignedDateTime.
`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`	`setTemplateLocked(String templateLocked)`	setTemplateLocked.
`void`	`setTemplateRequired(String templateRequired)`	setTemplateRequired.
`void`	`setTotalTabCount(String totalTabCount)`	setTotalTabCount.
`void`	`setUserId(String userId)`	setUserId.
`void`	`setWebFormRecipientViewId(String webFormRecipientViewId)`	setWebFormRecipientViewId.
`Participant`	`signedDateTime(String signedDateTime)`	signedDateTime.
`Participant`	`signingGroupId(String signingGroupId)`	signingGroupId.
`Participant`	`signingGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)`	signingGroupIdMetadata.
`Participant`	`signingGroupName(String signingGroupName)`	signingGroupName.
`Participant`	`signingGroupUsers(List<UserInfo> signingGroupUsers)`	signingGroupUsers.
`Participant`	`smsAuthentication(RecipientSMSAuthentication smsAuthentication)`	smsAuthentication.
`Participant`	`socialAuthentications(List<SocialAuthentication> socialAuthentications)`	socialAuthentications.
`Participant`	`status(String status)`	status.
`Participant`	`statusCode(String statusCode)`	statusCode.
`Participant`	`suppressEmails(String suppressEmails)`	suppressEmails.
`Participant`	`templateLocked(String templateLocked)`	templateLocked.
`Participant`	`templateRequired(String templateRequired)`	templateRequired.
`String`	`toString()`	Converts the given object to string.
`Participant`	`totalTabCount(String totalTabCount)`	totalTabCount.
`Participant`	`userId(String userId)`	userId.
`Participant`	`webFormRecipientViewId(String webFormRecipientViewId)`	webFormRecipientViewId.

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

- Constructor Detail
  - Participant
```
public Participant()
```
- Method Detail
  - accessCode
```
public Participant accessCode(String accessCode)
```
    accessCode.
    
    Returns:
    
    Participant
  - 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 Participant accessCodeMetadata(PropertyMetadata accessCodeMetadata)
```
    accessCodeMetadata.
    
    Returns:
    
    Participant
  - getAccessCodeMetadata
```
public PropertyMetadata getAccessCodeMetadata()
```
    .
    
    Returns:
    
    accessCodeMetadata
  - setAccessCodeMetadata
```
public void setAccessCodeMetadata(PropertyMetadata accessCodeMetadata)
```
    setAccessCodeMetadata.
  - addAccessCodeToEmail
```
public Participant addAccessCodeToEmail(String addAccessCodeToEmail)
```
    addAccessCodeToEmail.
    
    Returns:
    
    Participant
  - 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 Participant additionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)
```
    additionalNotifications.
    
    Returns:
    
    Participant
  - addAdditionalNotificationsItem
```
public Participant addAdditionalNotificationsItem(RecipientAdditionalNotification additionalNotificationsItem)
```
    addAdditionalNotificationsItem.
    
    Returns:
    
    Participant
  - getAdditionalNotifications
```
public List<RecipientAdditionalNotification> getAdditionalNotifications()
```
    .
    
    Returns:
    
    additionalNotifications
  - setAdditionalNotifications
```
public void setAdditionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)
```
    setAdditionalNotifications.
  - allowSystemOverrideForLockedRecipient
```
public Participant allowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)
```
    allowSystemOverrideForLockedRecipient.
    
    Returns:
    
    Participant
  - getAllowSystemOverrideForLockedRecipient
```
public String getAllowSystemOverrideForLockedRecipient()
```
    .
    
    Returns:
    
    allowSystemOverrideForLockedRecipient
  - setAllowSystemOverrideForLockedRecipient
```
public void setAllowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)
```
    setAllowSystemOverrideForLockedRecipient.
  - autoRespondedReason
```
public Participant autoRespondedReason(String autoRespondedReason)
```
    autoRespondedReason.
    
    Returns:
    
    Participant
  - getAutoRespondedReason
```
public String getAutoRespondedReason()
```
    .
    
    Returns:
    
    autoRespondedReason
  - setAutoRespondedReason
```
public void setAutoRespondedReason(String autoRespondedReason)
```
    setAutoRespondedReason.
  - bulkSendV2Recipient
```
public Participant bulkSendV2Recipient(String bulkSendV2Recipient)
```
    bulkSendV2Recipient.
    
    Returns:
    
    Participant
  - getBulkSendV2Recipient
```
public String getBulkSendV2Recipient()
```
    .
    
    Returns:
    
    bulkSendV2Recipient
  - setBulkSendV2Recipient
```
public void setBulkSendV2Recipient(String bulkSendV2Recipient)
```
    setBulkSendV2Recipient.
  - clientUserId
```
public Participant clientUserId(String clientUserId)
```
    clientUserId.
    
    Returns:
    
    Participant
  - 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 Participant completedCount(String completedCount)
```
    completedCount.
    
    Returns:
    
    Participant
  - getCompletedCount
```
public String getCompletedCount()
```
    .
    
    Returns:
    
    completedCount
  - setCompletedCount
```
public void setCompletedCount(String completedCount)
```
    setCompletedCount.
  - consentDetailsList
```
public Participant consentDetailsList(List<ConsentDetails> consentDetailsList)
```
    consentDetailsList.
    
    Returns:
    
    Participant
  - addConsentDetailsListItem
```
public Participant addConsentDetailsListItem(ConsentDetails consentDetailsListItem)
```
    addConsentDetailsListItem.
    
    Returns:
    
    Participant
  - getConsentDetailsList
```
public List<ConsentDetails> getConsentDetailsList()
```
    .
    
    Returns:
    
    consentDetailsList
  - setConsentDetailsList
```
public void setConsentDetailsList(List<ConsentDetails> consentDetailsList)
```
    setConsentDetailsList.
  - customFields
```
public Participant customFields(List<String> customFields)
```
    customFields.
    
    Returns:
    
    Participant
  - addCustomFieldsItem
```
public Participant addCustomFieldsItem(String customFieldsItem)
```
    addCustomFieldsItem.
    
    Returns:
    
    Participant
  - 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 Participant declinedDateTime(String declinedDateTime)
```
    declinedDateTime.
    
    Returns:
    
    Participant
  - getDeclinedDateTime
```
public String getDeclinedDateTime()
```
    The date and time the recipient declined the document..
    
    Returns:
    
    declinedDateTime
  - setDeclinedDateTime
```
public void setDeclinedDateTime(String declinedDateTime)
```
    setDeclinedDateTime.
  - declinedReason
```
public Participant declinedReason(String declinedReason)
```
    declinedReason.
    
    Returns:
    
    Participant
  - getDeclinedReason
```
public String getDeclinedReason()
```
    The reason the recipient declined the document..
    
    Returns:
    
    declinedReason
  - setDeclinedReason
```
public void setDeclinedReason(String declinedReason)
```
    setDeclinedReason.
  - deliveredDateTime
```
public Participant deliveredDateTime(String deliveredDateTime)
```
    deliveredDateTime.
    
    Returns:
    
    Participant
  - getDeliveredDateTime
```
public String getDeliveredDateTime()
```
    Reserved: For DocuSign use only..
    
    Returns:
    
    deliveredDateTime
  - setDeliveredDateTime
```
public void setDeliveredDateTime(String deliveredDateTime)
```
    setDeliveredDateTime.
  - deliveryMethod
```
public Participant deliveryMethod(String deliveryMethod)
```
    deliveryMethod.
    
    Returns:
    
    Participant
  - getDeliveryMethod
```
public String getDeliveryMethod()
```
    Reserved: For DocuSign use only..
    
    Returns:
    
    deliveryMethod
  - setDeliveryMethod
```
public void setDeliveryMethod(String deliveryMethod)
```
    setDeliveryMethod.
  - deliveryMethodMetadata
```
public Participant deliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)
```
    deliveryMethodMetadata.
    
    Returns:
    
    Participant
  - getDeliveryMethodMetadata
```
public PropertyMetadata getDeliveryMethodMetadata()
```
    .
    
    Returns:
    
    deliveryMethodMetadata
  - setDeliveryMethodMetadata
```
public void setDeliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)
```
    setDeliveryMethodMetadata.
  - designatorId
```
public Participant designatorId(String designatorId)
```
    designatorId.
    
    Returns:
    
    Participant
  - getDesignatorId
```
public String getDesignatorId()
```
    .
    
    Returns:
    
    designatorId
  - setDesignatorId
```
public void setDesignatorId(String designatorId)
```
    setDesignatorId.
  - designatorIdGuid
```
public Participant designatorIdGuid(String designatorIdGuid)
```
    designatorIdGuid.
    
    Returns:
    
    Participant
  - getDesignatorIdGuid
```
public String getDesignatorIdGuid()
```
    .
    
    Returns:
    
    designatorIdGuid
  - setDesignatorIdGuid
```
public void setDesignatorIdGuid(String designatorIdGuid)
```
    setDesignatorIdGuid.
  - documentTemplateId
```
public Participant documentTemplateId(String documentTemplateId)
```
    documentTemplateId.
    
    Returns:
    
    Participant
  - getDocumentTemplateId
```
public String getDocumentTemplateId()
```
    .
    
    Returns:
    
    documentTemplateId
  - setDocumentTemplateId
```
public void setDocumentTemplateId(String documentTemplateId)
```
    setDocumentTemplateId.
  - documentVisibility
```
public Participant documentVisibility(List<DocumentVisibility> documentVisibility)
```
    documentVisibility.
    
    Returns:
    
    Participant
  - addDocumentVisibilityItem
```
public Participant addDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)
```
    addDocumentVisibilityItem.
    
    Returns:
    
    Participant
  - getDocumentVisibility
```
public List<DocumentVisibility> getDocumentVisibility()
```
    .
    
    Returns:
    
    documentVisibility
  - setDocumentVisibility
```
public void setDocumentVisibility(List<DocumentVisibility> documentVisibility)
```
    setDocumentVisibility.
  - email
```
public Participant email(String email)
```
    email.
    
    Returns:
    
    Participant
  - getEmail
```
public String getEmail()
```
    .
    
    Returns:
    
    email
  - setEmail
```
public void setEmail(String email)
```
    setEmail.
  - emailMetadata
```
public Participant emailMetadata(PropertyMetadata emailMetadata)
```
    emailMetadata.
    
    Returns:
    
    Participant
  - getEmailMetadata
```
public PropertyMetadata getEmailMetadata()
```
    .
    
    Returns:
    
    emailMetadata
  - setEmailMetadata
```
public void setEmailMetadata(PropertyMetadata emailMetadata)
```
    setEmailMetadata.
  - emailNotification
```
public Participant emailNotification(RecipientEmailNotification emailNotification)
```
    emailNotification.
    
    Returns:
    
    Participant
  - 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 Participant emailRecipientPostSigningURL(String emailRecipientPostSigningURL)
```
    emailRecipientPostSigningURL.
    
    Returns:
    
    Participant
  - getEmailRecipientPostSigningURL
```
public String getEmailRecipientPostSigningURL()
```
    .
    
    Returns:
    
    emailRecipientPostSigningURL
  - setEmailRecipientPostSigningURL
```
public void setEmailRecipientPostSigningURL(String emailRecipientPostSigningURL)
```
    setEmailRecipientPostSigningURL.
  - embeddedRecipientStartURL
```
public Participant embeddedRecipientStartURL(String embeddedRecipientStartURL)
```
    embeddedRecipientStartURL.
    
    Returns:
    
    Participant
  - 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 Participant errorDetails(ErrorDetails errorDetails)
```
    errorDetails.
    
    Returns:
    
    Participant
  - getErrorDetails
```
public ErrorDetails getErrorDetails()
```
    Array or errors..
    
    Returns:
    
    errorDetails
  - setErrorDetails
```
public void setErrorDetails(ErrorDetails errorDetails)
```
    setErrorDetails.
  - faxNumber
```
public Participant faxNumber(String faxNumber)
```
    faxNumber.
    
    Returns:
    
    Participant
  - getFaxNumber
```
public String getFaxNumber()
```
    Reserved:.
    
    Returns:
    
    faxNumber
  - setFaxNumber
```
public void setFaxNumber(String faxNumber)
```
    setFaxNumber.
  - faxNumberMetadata
```
public Participant faxNumberMetadata(PropertyMetadata faxNumberMetadata)
```
    faxNumberMetadata.
    
    Returns:
    
    Participant
  - getFaxNumberMetadata
```
public PropertyMetadata getFaxNumberMetadata()
```
    .
    
    Returns:
    
    faxNumberMetadata
  - setFaxNumberMetadata
```
public void setFaxNumberMetadata(PropertyMetadata faxNumberMetadata)
```
    setFaxNumberMetadata.
  - firstName
```
public Participant firstName(String firstName)
```
    firstName.
    
    Returns:
    
    Participant
  - getFirstName
```
public String getFirstName()
```
    The user's first name. Maximum Length: 50 characters..
    
    Returns:
    
    firstName
  - setFirstName
```
public void setFirstName(String firstName)
```
    setFirstName.
  - firstNameMetadata
```
public Participant firstNameMetadata(PropertyMetadata firstNameMetadata)
```
    firstNameMetadata.
    
    Returns:
    
    Participant
  - getFirstNameMetadata
```
public PropertyMetadata getFirstNameMetadata()
```
    .
    
    Returns:
    
    firstNameMetadata
  - setFirstNameMetadata
```
public void setFirstNameMetadata(PropertyMetadata firstNameMetadata)
```
    setFirstNameMetadata.
  - fullName
```
public Participant fullName(String fullName)
```
    fullName.
    
    Returns:
    
    Participant
  - getFullName
```
public String getFullName()
```
    .
    
    Returns:
    
    fullName
  - setFullName
```
public void setFullName(String fullName)
```
    setFullName.
  - fullNameMetadata
```
public Participant fullNameMetadata(PropertyMetadata fullNameMetadata)
```
    fullNameMetadata.
    
    Returns:
    
    Participant
  - getFullNameMetadata
```
public PropertyMetadata getFullNameMetadata()
```
    .
    
    Returns:
    
    fullNameMetadata
  - setFullNameMetadata
```
public void setFullNameMetadata(PropertyMetadata fullNameMetadata)
```
    setFullNameMetadata.
  - idCheckConfigurationName
```
public Participant idCheckConfigurationName(String idCheckConfigurationName)
```
    idCheckConfigurationName.
    
    Returns:
    
    Participant
  - 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 Participant idCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)
```
    idCheckConfigurationNameMetadata.
    
    Returns:
    
    Participant
  - getIdCheckConfigurationNameMetadata
```
public PropertyMetadata getIdCheckConfigurationNameMetadata()
```
    .
    
    Returns:
    
    idCheckConfigurationNameMetadata
  - setIdCheckConfigurationNameMetadata
```
public void setIdCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)
```
    setIdCheckConfigurationNameMetadata.
  - idCheckInformationInput
```
public Participant idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
```
    idCheckInformationInput.
    
    Returns:
    
    Participant
  - getIdCheckInformationInput
```
public IdCheckInformationInput getIdCheckInformationInput()
```
    .
    
    Returns:
    
    idCheckInformationInput
  - setIdCheckInformationInput
```
public void setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
```
    setIdCheckInformationInput.
  - identityVerification
```
public Participant identityVerification(RecipientIdentityVerification identityVerification)
```
    identityVerification.
    
    Returns:
    
    Participant
  - getIdentityVerification
```
public RecipientIdentityVerification getIdentityVerification()
```
    .
    
    Returns:
    
    identityVerification
  - setIdentityVerification
```
public void setIdentityVerification(RecipientIdentityVerification identityVerification)
```
    setIdentityVerification.
  - inheritEmailNotificationConfiguration
```
public Participant inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)
```
    inheritEmailNotificationConfiguration.
    
    Returns:
    
    Participant
  - 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.
  - lastName
```
public Participant lastName(String lastName)
```
    lastName.
    
    Returns:
    
    Participant
  - getLastName
```
public String getLastName()
```
    .
    
    Returns:
    
    lastName
  - setLastName
```
public void setLastName(String lastName)
```
    setLastName.
  - lastNameMetadata
```
public Participant lastNameMetadata(PropertyMetadata lastNameMetadata)
```
    lastNameMetadata.
    
    Returns:
    
    Participant
  - getLastNameMetadata
```
public PropertyMetadata getLastNameMetadata()
```
    .
    
    Returns:
    
    lastNameMetadata
  - setLastNameMetadata
```
public void setLastNameMetadata(PropertyMetadata lastNameMetadata)
```
    setLastNameMetadata.
  - lockedRecipientPhoneAuthEditable
```
public Participant lockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)
```
    lockedRecipientPhoneAuthEditable.
    
    Returns:
    
    Participant
  - getLockedRecipientPhoneAuthEditable
```
public String getLockedRecipientPhoneAuthEditable()
```
    .
    
    Returns:
    
    lockedRecipientPhoneAuthEditable
  - setLockedRecipientPhoneAuthEditable
```
public void setLockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)
```
    setLockedRecipientPhoneAuthEditable.
  - lockedRecipientSmsEditable
```
public Participant lockedRecipientSmsEditable(String lockedRecipientSmsEditable)
```
    lockedRecipientSmsEditable.
    
    Returns:
    
    Participant
  - getLockedRecipientSmsEditable
```
public String getLockedRecipientSmsEditable()
```
    .
    
    Returns:
    
    lockedRecipientSmsEditable
  - setLockedRecipientSmsEditable
```
public void setLockedRecipientSmsEditable(String lockedRecipientSmsEditable)
```
    setLockedRecipientSmsEditable.
  - name
```
public Participant name(String name)
```
    name.
    
    Returns:
    
    Participant
  - getName
```
public String getName()
```
    .
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
    setName.
  - nameMetadata
```
public Participant nameMetadata(PropertyMetadata nameMetadata)
```
    nameMetadata.
    
    Returns:
    
    Participant
  - getNameMetadata
```
public PropertyMetadata getNameMetadata()
```
    .
    
    Returns:
    
    nameMetadata
  - setNameMetadata
```
public void setNameMetadata(PropertyMetadata nameMetadata)
```
    setNameMetadata.
  - note
```
public Participant note(String note)
```
    note.
    
    Returns:
    
    Participant
  - 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 Participant noteMetadata(PropertyMetadata noteMetadata)
```
    noteMetadata.
    
    Returns:
    
    Participant
  - getNoteMetadata
```
public PropertyMetadata getNoteMetadata()
```
    .
    
    Returns:
    
    noteMetadata
  - setNoteMetadata
```
public void setNoteMetadata(PropertyMetadata noteMetadata)
```
    setNoteMetadata.
  - participateFor
```
public Participant participateFor(String participateFor)
```
    participateFor.
    
    Returns:
    
    Participant
  - getParticipateFor
```
public String getParticipateFor()
```
    .
    
    Returns:
    
    participateFor
  - setParticipateFor
```
public void setParticipateFor(String participateFor)
```
    setParticipateFor.
  - participateForGuid
```
public Participant participateForGuid(String participateForGuid)
```
    participateForGuid.
    
    Returns:
    
    Participant
  - getParticipateForGuid
```
public String getParticipateForGuid()
```
    .
    
    Returns:
    
    participateForGuid
  - setParticipateForGuid
```
public void setParticipateForGuid(String participateForGuid)
```
    setParticipateForGuid.
  - phoneAuthentication
```
public Participant phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
```
    phoneAuthentication.
    
    Returns:
    
    Participant
  - getPhoneAuthentication
```
public RecipientPhoneAuthentication getPhoneAuthentication()
```
    .
    
    Returns:
    
    phoneAuthentication
  - setPhoneAuthentication
```
public void setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
```
    setPhoneAuthentication.
  - phoneNumber
```
public Participant phoneNumber(RecipientPhoneNumber phoneNumber)
```
    phoneNumber.
    
    Returns:
    
    Participant
  - getPhoneNumber
```
public RecipientPhoneNumber getPhoneNumber()
```
    .
    
    Returns:
    
    phoneNumber
  - setPhoneNumber
```
public void setPhoneNumber(RecipientPhoneNumber phoneNumber)
```
    setPhoneNumber.
  - recipientAttachments
```
public Participant recipientAttachments(List<RecipientAttachment> recipientAttachments)
```
    recipientAttachments.
    
    Returns:
    
    Participant
  - addRecipientAttachmentsItem
```
public Participant addRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)
```
    addRecipientAttachmentsItem.
    
    Returns:
    
    Participant
  - getRecipientAttachments
```
public List<RecipientAttachment> getRecipientAttachments()
```
    Reserved:.
    
    Returns:
    
    recipientAttachments
  - setRecipientAttachments
```
public void setRecipientAttachments(List<RecipientAttachment> recipientAttachments)
```
    setRecipientAttachments.
  - recipientAuthenticationStatus
```
public Participant recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
```
    recipientAuthenticationStatus.
    
    Returns:
    
    Participant
  - getRecipientAuthenticationStatus
```
public AuthenticationStatus getRecipientAuthenticationStatus()
```
    .
    
    Returns:
    
    recipientAuthenticationStatus
  - setRecipientAuthenticationStatus
```
public void setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
```
    setRecipientAuthenticationStatus.
  - recipientFeatureMetadata
```
public Participant recipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)
```
    recipientFeatureMetadata.
    
    Returns:
    
    Participant
  - addRecipientFeatureMetadataItem
```
public Participant addRecipientFeatureMetadataItem(FeatureAvailableMetadata recipientFeatureMetadataItem)
```
    addRecipientFeatureMetadataItem.
    
    Returns:
    
    Participant
  - getRecipientFeatureMetadata
```
public List<FeatureAvailableMetadata> getRecipientFeatureMetadata()
```
    .
    
    Returns:
    
    recipientFeatureMetadata
  - setRecipientFeatureMetadata
```
public void setRecipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)
```
    setRecipientFeatureMetadata.
  - recipientId
```
public Participant recipientId(String recipientId)
```
    recipientId.
    
    Returns:
    
    Participant
  - 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 Participant recipientIdGuid(String recipientIdGuid)
```
    recipientIdGuid.
    
    Returns:
    
    Participant
  - getRecipientIdGuid
```
public String getRecipientIdGuid()
```
    .
    
    Returns:
    
    recipientIdGuid
  - setRecipientIdGuid
```
public void setRecipientIdGuid(String recipientIdGuid)
```
    setRecipientIdGuid.
  - recipientType
```
public Participant recipientType(String recipientType)
```
    recipientType.
    
    Returns:
    
    Participant
  - getRecipientType
```
public String getRecipientType()
```
    .
    
    Returns:
    
    recipientType
  - setRecipientType
```
public void setRecipientType(String recipientType)
```
    setRecipientType.
  - recipientTypeMetadata
```
public Participant recipientTypeMetadata(PropertyMetadata recipientTypeMetadata)
```
    recipientTypeMetadata.
    
    Returns:
    
    Participant
  - getRecipientTypeMetadata
```
public PropertyMetadata getRecipientTypeMetadata()
```
    .
    
    Returns:
    
    recipientTypeMetadata
  - setRecipientTypeMetadata
```
public void setRecipientTypeMetadata(PropertyMetadata recipientTypeMetadata)
```
    setRecipientTypeMetadata.
  - requireIdLookup
```
public Participant requireIdLookup(String requireIdLookup)
```
    requireIdLookup.
    
    Returns:
    
    Participant
  - 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 Participant requireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)
```
    requireIdLookupMetadata.
    
    Returns:
    
    Participant
  - getRequireIdLookupMetadata
```
public PropertyMetadata getRequireIdLookupMetadata()
```
    .
    
    Returns:
    
    requireIdLookupMetadata
  - setRequireIdLookupMetadata
```
public void setRequireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)
```
    setRequireIdLookupMetadata.
  - roleName
```
public Participant roleName(String roleName)
```
    roleName.
    
    Returns:
    
    Participant
  - 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 Participant routingOrder(String routingOrder)
```
    routingOrder.
    
    Returns:
    
    Participant
  - 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 Participant routingOrderMetadata(PropertyMetadata routingOrderMetadata)
```
    routingOrderMetadata.
    
    Returns:
    
    Participant
  - getRoutingOrderMetadata
```
public PropertyMetadata getRoutingOrderMetadata()
```
    .
    
    Returns:
    
    routingOrderMetadata
  - setRoutingOrderMetadata
```
public void setRoutingOrderMetadata(PropertyMetadata routingOrderMetadata)
```
    setRoutingOrderMetadata.
  - sentDateTime
```
public Participant sentDateTime(String sentDateTime)
```
    sentDateTime.
    
    Returns:
    
    Participant
  - getSentDateTime
```
public String getSentDateTime()
```
    The date and time the envelope was sent..
    
    Returns:
    
    sentDateTime
  - setSentDateTime
```
public void setSentDateTime(String sentDateTime)
```
    setSentDateTime.
  - signedDateTime
```
public Participant signedDateTime(String signedDateTime)
```
    signedDateTime.
    
    Returns:
    
    Participant
  - getSignedDateTime
```
public String getSignedDateTime()
```
    Reserved: For DocuSign use only. .
    
    Returns:
    
    signedDateTime
  - setSignedDateTime
```
public void setSignedDateTime(String signedDateTime)
```
    setSignedDateTime.
  - signingGroupId
```
public Participant signingGroupId(String signingGroupId)
```
    signingGroupId.
    
    Returns:
    
    Participant
  - 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 Participant signingGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)
```
    signingGroupIdMetadata.
    
    Returns:
    
    Participant
  - getSigningGroupIdMetadata
```
public PropertyMetadata getSigningGroupIdMetadata()
```
    .
    
    Returns:
    
    signingGroupIdMetadata
  - setSigningGroupIdMetadata
```
public void setSigningGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)
```
    setSigningGroupIdMetadata.
  - signingGroupName
```
public Participant signingGroupName(String signingGroupName)
```
    signingGroupName.
    
    Returns:
    
    Participant
  - 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 Participant signingGroupUsers(List<UserInfo> signingGroupUsers)
```
    signingGroupUsers.
    
    Returns:
    
    Participant
  - addSigningGroupUsersItem
```
public Participant addSigningGroupUsersItem(UserInfo signingGroupUsersItem)
```
    addSigningGroupUsersItem.
    
    Returns:
    
    Participant
  - 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 Participant smsAuthentication(RecipientSMSAuthentication smsAuthentication)
```
    smsAuthentication.
    
    Returns:
    
    Participant
  - getSmsAuthentication
```
public RecipientSMSAuthentication getSmsAuthentication()
```
    .
    
    Returns:
    
    smsAuthentication
  - setSmsAuthentication
```
public void setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)
```
    setSmsAuthentication.
  - socialAuthentications
```
public Participant socialAuthentications(List<SocialAuthentication> socialAuthentications)
```
    socialAuthentications.
    
    Returns:
    
    Participant
  - addSocialAuthenticationsItem
```
public Participant addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)
```
    addSocialAuthenticationsItem.
    
    Returns:
    
    Participant
  - 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 Participant status(String status)
```
    status.
    
    Returns:
    
    Participant
  - 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 Participant statusCode(String statusCode)
```
    statusCode.
    
    Returns:
    
    Participant
  - getStatusCode
```
public String getStatusCode()
```
    .
    
    Returns:
    
    statusCode
  - setStatusCode
```
public void setStatusCode(String statusCode)
```
    setStatusCode.
  - suppressEmails
```
public Participant suppressEmails(String suppressEmails)
```
    suppressEmails.
    
    Returns:
    
    Participant
  - getSuppressEmails
```
public String getSuppressEmails()
```
    .
    
    Returns:
    
    suppressEmails
  - setSuppressEmails
```
public void setSuppressEmails(String suppressEmails)
```
    setSuppressEmails.
  - templateLocked
```
public Participant templateLocked(String templateLocked)
```
    templateLocked.
    
    Returns:
    
    Participant
  - 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 Participant templateRequired(String templateRequired)
```
    templateRequired.
    
    Returns:
    
    Participant
  - 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 Participant totalTabCount(String totalTabCount)
```
    totalTabCount.
    
    Returns:
    
    Participant
  - getTotalTabCount
```
public String getTotalTabCount()
```
    .
    
    Returns:
    
    totalTabCount
  - setTotalTabCount
```
public void setTotalTabCount(String totalTabCount)
```
    setTotalTabCount.
  - userId
```
public Participant userId(String userId)
```
    userId.
    
    Returns:
    
    Participant
  - getUserId
```
public String getUserId()
```
    .
    
    Returns:
    
    userId
  - setUserId
```
public void setUserId(String userId)
```
    setUserId.
  - webFormRecipientViewId
```
public Participant webFormRecipientViewId(String webFormRecipientViewId)
```
    webFormRecipientViewId.
    
    Returns:
    
    Participant
  - getWebFormRecipientViewId
```
public String getWebFormRecipientViewId()
```
    .
    
    Returns:
    
    webFormRecipientViewId
  - setWebFormRecipientViewId
```
public void setWebFormRecipientViewId(String webFormRecipientViewId)
```
    setWebFormRecipientViewId.
  - 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 Participant

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Participant

Method Detail

accessCode

getAccessCode

setAccessCode

accessCodeMetadata

getAccessCodeMetadata

setAccessCodeMetadata

addAccessCodeToEmail

getAddAccessCodeToEmail

setAddAccessCodeToEmail

additionalNotifications

addAdditionalNotificationsItem

getAdditionalNotifications

setAdditionalNotifications

allowSystemOverrideForLockedRecipient

getAllowSystemOverrideForLockedRecipient

setAllowSystemOverrideForLockedRecipient

autoRespondedReason

getAutoRespondedReason

setAutoRespondedReason

bulkSendV2Recipient

getBulkSendV2Recipient

setBulkSendV2Recipient

clientUserId

getClientUserId

setClientUserId

completedCount

getCompletedCount

setCompletedCount

consentDetailsList

addConsentDetailsListItem

getConsentDetailsList

setConsentDetailsList

customFields

addCustomFieldsItem

getCustomFields

setCustomFields

declinedDateTime

getDeclinedDateTime

setDeclinedDateTime

declinedReason

getDeclinedReason

setDeclinedReason

deliveredDateTime

getDeliveredDateTime

setDeliveredDateTime

deliveryMethod

getDeliveryMethod

setDeliveryMethod

deliveryMethodMetadata

getDeliveryMethodMetadata

setDeliveryMethodMetadata

designatorId

getDesignatorId

setDesignatorId

designatorIdGuid

getDesignatorIdGuid

setDesignatorIdGuid

documentTemplateId

getDocumentTemplateId

setDocumentTemplateId

documentVisibility

addDocumentVisibilityItem

getDocumentVisibility

setDocumentVisibility

email

getEmail

setEmail

emailMetadata

getEmailMetadata

setEmailMetadata

emailNotification

getEmailNotification

setEmailNotification