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

All Implemented Interfaces:

Serializable
```
public class InPersonSigner
extends Object
implements Serializable
```
Contains information about an in-person recipient. This is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer. To learn about the fields used for the eNotary feature, see the [recipients resource][resource]. [resource]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#in-person-signer-recipient .

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

InPersonSigner()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`InPersonSigner`	`accessCode(String accessCode)`	accessCode.
`InPersonSigner`	`accessCodeMetadata(PropertyMetadata accessCodeMetadata)`	accessCodeMetadata.
`InPersonSigner`	`addAccessCodeToEmail(String addAccessCodeToEmail)`	addAccessCodeToEmail.
`InPersonSigner`	`addCustomFieldsItem(String customFieldsItem)`	addCustomFieldsItem.
`InPersonSigner`	`addDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)`	addDocumentVisibilityItem.
`InPersonSigner`	`addExcludedDocumentsItem(String excludedDocumentsItem)`	addExcludedDocumentsItem.
`InPersonSigner`	`addRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)`	addRecipientAttachmentsItem.
`InPersonSigner`	`addRecipientFeatureMetadataItem(FeatureAvailableMetadata recipientFeatureMetadataItem)`	addRecipientFeatureMetadataItem.
`InPersonSigner`	`addRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)`	addRecipientSignatureProvidersItem.
`InPersonSigner`	`addSigningGroupUsersItem(UserInfo signingGroupUsersItem)`	addSigningGroupUsersItem.
`InPersonSigner`	`addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)`	addSocialAuthenticationsItem.
`InPersonSigner`	`allowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)`	allowSystemOverrideForLockedRecipient.
`InPersonSigner`	`autoNavigation(String autoNavigation)`	autoNavigation.
`InPersonSigner`	`autoRespondedReason(String autoRespondedReason)`	autoRespondedReason.
`InPersonSigner`	`bulkSendV2Recipient(String bulkSendV2Recipient)`	bulkSendV2Recipient.
`InPersonSigner`	`canSignOffline(String canSignOffline)`	canSignOffline.
`InPersonSigner`	`clientUserId(String clientUserId)`	clientUserId.
`InPersonSigner`	`completedCount(String completedCount)`	completedCount.
`InPersonSigner`	`creationReason(String creationReason)`	creationReason.
`InPersonSigner`	`customFields(List<String> customFields)`	customFields.
`InPersonSigner`	`declinedDateTime(String declinedDateTime)`	declinedDateTime.
`InPersonSigner`	`declinedReason(String declinedReason)`	declinedReason.
`InPersonSigner`	`defaultRecipient(String defaultRecipient)`	defaultRecipient.
`InPersonSigner`	`deliveredDateTime(String deliveredDateTime)`	deliveredDateTime.
`InPersonSigner`	`deliveryMethod(String deliveryMethod)`	deliveryMethod.
`InPersonSigner`	`deliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)`	deliveryMethodMetadata.
`InPersonSigner`	`designatorId(String designatorId)`	designatorId.
`InPersonSigner`	`designatorIdGuid(String designatorIdGuid)`	designatorIdGuid.
`InPersonSigner`	`documentVisibility(List<DocumentVisibility> documentVisibility)`	documentVisibility.
`InPersonSigner`	`email(String email)`	email.
`InPersonSigner`	`emailMetadata(PropertyMetadata emailMetadata)`	emailMetadata.
`InPersonSigner`	`emailNotification(RecipientEmailNotification emailNotification)`	emailNotification.
`InPersonSigner`	`embeddedRecipientStartURL(String embeddedRecipientStartURL)`	embeddedRecipientStartURL.
`boolean`	`equals(Object o)`	Compares objects.
`InPersonSigner`	`errorDetails(ErrorDetails errorDetails)`	errorDetails.
`InPersonSigner`	`excludedDocuments(List<String> excludedDocuments)`	excludedDocuments.
`InPersonSigner`	`faxNumber(String faxNumber)`	faxNumber.
`InPersonSigner`	`faxNumberMetadata(PropertyMetadata faxNumberMetadata)`	faxNumberMetadata.
`String`	`getAccessCode()`	If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
`PropertyMetadata`	`getAccessCodeMetadata()`	Metadata that indicates whether the `accessCode` property is editable.
`String`	`getAddAccessCodeToEmail()`	This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient..
`String`	`getAllowSystemOverrideForLockedRecipient()`	.
`String`	`getAutoNavigation()`	.
`String`	`getAutoRespondedReason()`	.
`String`	`getBulkSendV2Recipient()`	.
`String`	`getCanSignOffline()`	When set to true, specifies that the signer can perform the signing ceremony offline..
`String`	`getClientUserId()`	Specifies whether the recipient is embedded or remote.
`String`	`getCompletedCount()`	.
`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..
`PropertyMetadata`	`getDeliveryMethodMetadata()`	Reserved for DocuSign..
`String`	`getDesignatorId()`	.
`String`	`getDesignatorIdGuid()`	.
`List<DocumentVisibility>`	`getDocumentVisibility()`	.
`String`	`getEmail()`	.
`PropertyMetadata`	`getEmailMetadata()`	Metadata that indicates whether the `email` property is editable.
`RecipientEmailNotification`	`getEmailNotification()`	A complex type that contains information sets the language of the recipient's email information.
`String`	`getEmbeddedRecipientStartURL()`	Specifies a sender provided valid URL string for redirecting an embedded recipient.
`ErrorDetails`	`getErrorDetails()`	Array or errors..
`List<String>`	`getExcludedDocuments()`	Specifies the documents that are not visible to this recipient.
`String`	`getFaxNumber()`	Reserved:.
`PropertyMetadata`	`getFaxNumberMetadata()`	Reserved for DocuSign..
`String`	`getHostEmail()`	.
`PropertyMetadata`	`getHostEmailMetadata()`	Metadata that indicates whether the `hostEmail` property is editable..
`String`	`getHostName()`	Specifies the name of the signing host.
`PropertyMetadata`	`getHostNameMetadata()`	Metadata that indicates whether the `hostName` property is editable..
`String`	`getIdCheckConfigurationName()`	Specifies authentication check by name.
`PropertyMetadata`	`getIdCheckConfigurationNameMetadata()`	Metadata that indicates whether the `idCheckConfigurationName` property is editable.
`IdCheckInformationInput`	`getIdCheckInformationInput()`	An object that contains input information related to a recipient ID check..
`RecipientIdentityVerification`	`getIdentityVerification()`	Specifies the ID Verification workflow applied on an envelope by workflow ID.
`String`	`getInheritEmailNotificationConfiguration()`	When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
`String`	`getInPersonSigningType()`	.
`PropertyMetadata`	`getInPersonSigningTypeMetadata()`	Metadata that indicates whether the `inPersonSigningType` property is editable..
`String`	`getLockedRecipientPhoneAuthEditable()`	.
`String`	`getLockedRecipientSmsEditable()`	.
`String`	`getName()`	.
`PropertyMetadata`	`getNameMetadata()`	Metadata that indicates whether the `name` property is editable.
`NotaryHost`	`getNotaryHost()`	Information about the notary host.
`String`	`getNotaryId()`	.
`String`	`getNote()`	Specifies a note that is unique to this recipient.
`PropertyMetadata`	`getNoteMetadata()`	Metadata that indicates whether the `note` property is editable.
`OfflineAttributes`	`getOfflineAttributes()`	Reserved for DocuSign..
`RecipientPhoneAuthentication`	`getPhoneAuthentication()`	When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details.
`List<RecipientAttachment>`	`getRecipientAttachments()`	Reserved:.
`AuthenticationStatus`	`getRecipientAuthenticationStatus()`	Information about the recipient's authentication status.
`List<FeatureAvailableMetadata>`	`getRecipientFeatureMetadata()`	.
`String`	`getRecipientId()`	Unique for the recipient.
`String`	`getRecipientIdGuid()`	.
`List<RecipientSignatureProvider>`	`getRecipientSignatureProviders()`	.
`String`	`getRecipientSuppliesTabs()`	.
`String`	`getRecipientType()`	.
`PropertyMetadata`	`getRecipientTypeMetadata()`	Metadata that indicates whether the `recipientType` property is editable.
`String`	`getRequireIdLookup()`	When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
`PropertyMetadata`	`getRequireIdLookupMetadata()`	Metadata that indicates whether the `requireIdLookup` property is editable.
`String`	`getRequireSignerCertificate()`	.
`String`	`getRequireSignOnPaper()`	.
`String`	`getRequireUploadSignature()`	.
`String`	`getRoleName()`	Optional element.
`String`	`getRoutingOrder()`	Specifies the routing order of the recipient in the envelope.
`PropertyMetadata`	`getRoutingOrderMetadata()`	Metadata that indicates whether the `routingOrder` property is editable.
`String`	`getSentDateTime()`	The date and time the envelope was sent..
`RecipientSignatureInformation`	`getSignatureInfo()`	Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.
`String`	`getSignedDateTime()`	Reserved: For DocuSign use only.
`String`	`getSignerEmail()`	The email address for an InPersonSigner recipient Type.
`PropertyMetadata`	`getSignerEmailMetadata()`	Metadata that indicates if the sender can edit the in-person signer's email address..
`String`	`getSignerFirstName()`	.
`PropertyMetadata`	`getSignerFirstNameMetadata()`	Metadata that indicates if the `signerFirstName` property is editable..
`String`	`getSignerLastName()`	.
`PropertyMetadata`	`getSignerLastNameMetadata()`	Metadata that indicates whether the `signerLastName` property is editable..
`String`	`getSignerName()`	Required.
`PropertyMetadata`	`getSignerNameMetadata()`	Metadata that indicates whether the `signerName` property is editable..
`String`	`getSignInEachLocation()`	When set to true, specifies that the signer must sign in all locations..
`PropertyMetadata`	`getSignInEachLocationMetadata()`	Metadata that indicates whether the `signInEachLocation` property is editable.
`String`	`getSigningGroupId()`	When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once)..
`PropertyMetadata`	`getSigningGroupIdMetadata()`	Not applicable..
`String`	`getSigningGroupName()`	The display name for the signing group.
`List<UserInfo>`	`getSigningGroupUsers()`	A complex type that contains information about users in the signing group..
`RecipientSMSAuthentication`	`getSmsAuthentication()`	When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details.
`List<SocialAuthentication>`	`getSocialAuthentications()`	Lists the social ID type that can be used for recipient authentication..
`String`	`getStatus()`	Indicates the envelope status.
`String`	`getStatusCode()`	.
`String`	`getSuppressEmails()`	.
`Tabs`	`getTabs()`	A list of tabs, which are represented graphically as symbols on documents at the time of signing.
`String`	`getTemplateLocked()`	When set to true, the sender cannot change any attributes of the recipient.
`String`	`getTemplateRequired()`	When set to true, the sender may not remove the recipient.
`String`	`getTotalTabCount()`	.
`String`	`getUserId()`	.
`int`	`hashCode()`	Returns the HashCode.
`InPersonSigner`	`hostEmail(String hostEmail)`	hostEmail.
`InPersonSigner`	`hostEmailMetadata(PropertyMetadata hostEmailMetadata)`	hostEmailMetadata.
`InPersonSigner`	`hostName(String hostName)`	hostName.
`InPersonSigner`	`hostNameMetadata(PropertyMetadata hostNameMetadata)`	hostNameMetadata.
`InPersonSigner`	`idCheckConfigurationName(String idCheckConfigurationName)`	idCheckConfigurationName.
`InPersonSigner`	`idCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)`	idCheckConfigurationNameMetadata.
`InPersonSigner`	`idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)`	idCheckInformationInput.
`InPersonSigner`	`identityVerification(RecipientIdentityVerification identityVerification)`	identityVerification.
`InPersonSigner`	`inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)`	inheritEmailNotificationConfiguration.
`InPersonSigner`	`inPersonSigningType(String inPersonSigningType)`	inPersonSigningType.
`InPersonSigner`	`inPersonSigningTypeMetadata(PropertyMetadata inPersonSigningTypeMetadata)`	inPersonSigningTypeMetadata.
`InPersonSigner`	`lockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)`	lockedRecipientPhoneAuthEditable.
`InPersonSigner`	`lockedRecipientSmsEditable(String lockedRecipientSmsEditable)`	lockedRecipientSmsEditable.
`InPersonSigner`	`name(String name)`	name.
`InPersonSigner`	`nameMetadata(PropertyMetadata nameMetadata)`	nameMetadata.
`InPersonSigner`	`notaryHost(NotaryHost notaryHost)`	notaryHost.
`InPersonSigner`	`notaryId(String notaryId)`	notaryId.
`InPersonSigner`	`note(String note)`	note.
`InPersonSigner`	`noteMetadata(PropertyMetadata noteMetadata)`	noteMetadata.
`InPersonSigner`	`offlineAttributes(OfflineAttributes offlineAttributes)`	offlineAttributes.
`InPersonSigner`	`phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)`	phoneAuthentication.
`InPersonSigner`	`recipientAttachments(List<RecipientAttachment> recipientAttachments)`	recipientAttachments.
`InPersonSigner`	`recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)`	recipientAuthenticationStatus.
`InPersonSigner`	`recipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)`	recipientFeatureMetadata.
`InPersonSigner`	`recipientId(String recipientId)`	recipientId.
`InPersonSigner`	`recipientIdGuid(String recipientIdGuid)`	recipientIdGuid.
`InPersonSigner`	`recipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)`	recipientSignatureProviders.
`InPersonSigner`	`recipientSuppliesTabs(String recipientSuppliesTabs)`	recipientSuppliesTabs.
`InPersonSigner`	`recipientType(String recipientType)`	recipientType.
`InPersonSigner`	`recipientTypeMetadata(PropertyMetadata recipientTypeMetadata)`	recipientTypeMetadata.
`InPersonSigner`	`requireIdLookup(String requireIdLookup)`	requireIdLookup.
`InPersonSigner`	`requireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)`	requireIdLookupMetadata.
`InPersonSigner`	`requireSignerCertificate(String requireSignerCertificate)`	requireSignerCertificate.
`InPersonSigner`	`requireSignOnPaper(String requireSignOnPaper)`	requireSignOnPaper.
`InPersonSigner`	`requireUploadSignature(String requireUploadSignature)`	requireUploadSignature.
`InPersonSigner`	`roleName(String roleName)`	roleName.
`InPersonSigner`	`routingOrder(String routingOrder)`	routingOrder.
`InPersonSigner`	`routingOrderMetadata(PropertyMetadata routingOrderMetadata)`	routingOrderMetadata.
`InPersonSigner`	`sentDateTime(String sentDateTime)`	sentDateTime.
`void`	`setAccessCode(String accessCode)`	setAccessCode.
`void`	`setAccessCodeMetadata(PropertyMetadata accessCodeMetadata)`	setAccessCodeMetadata.
`void`	`setAddAccessCodeToEmail(String addAccessCodeToEmail)`	setAddAccessCodeToEmail.
`void`	`setAllowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)`	setAllowSystemOverrideForLockedRecipient.
`void`	`setAutoNavigation(String autoNavigation)`	setAutoNavigation.
`void`	`setAutoRespondedReason(String autoRespondedReason)`	setAutoRespondedReason.
`void`	`setBulkSendV2Recipient(String bulkSendV2Recipient)`	setBulkSendV2Recipient.
`void`	`setCanSignOffline(String canSignOffline)`	setCanSignOffline.
`void`	`setClientUserId(String clientUserId)`	setClientUserId.
`void`	`setCompletedCount(String completedCount)`	setCompletedCount.
`void`	`setCreationReason(String creationReason)`	setCreationReason.
`void`	`setCustomFields(List<String> customFields)`	setCustomFields.
`void`	`setDeclinedDateTime(String declinedDateTime)`	setDeclinedDateTime.
`void`	`setDeclinedReason(String declinedReason)`	setDeclinedReason.
`void`	`setDefaultRecipient(String defaultRecipient)`	setDefaultRecipient.
`void`	`setDeliveredDateTime(String deliveredDateTime)`	setDeliveredDateTime.
`void`	`setDeliveryMethod(String deliveryMethod)`	setDeliveryMethod.
`void`	`setDeliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)`	setDeliveryMethodMetadata.
`void`	`setDesignatorId(String designatorId)`	setDesignatorId.
`void`	`setDesignatorIdGuid(String designatorIdGuid)`	setDesignatorIdGuid.
`void`	`setDocumentVisibility(List<DocumentVisibility> documentVisibility)`	setDocumentVisibility.
`void`	`setEmail(String email)`	setEmail.
`void`	`setEmailMetadata(PropertyMetadata emailMetadata)`	setEmailMetadata.
`void`	`setEmailNotification(RecipientEmailNotification emailNotification)`	setEmailNotification.
`void`	`setEmbeddedRecipientStartURL(String embeddedRecipientStartURL)`	setEmbeddedRecipientStartURL.
`void`	`setErrorDetails(ErrorDetails errorDetails)`	setErrorDetails.
`void`	`setExcludedDocuments(List<String> excludedDocuments)`	setExcludedDocuments.
`void`	`setFaxNumber(String faxNumber)`	setFaxNumber.
`void`	`setFaxNumberMetadata(PropertyMetadata faxNumberMetadata)`	setFaxNumberMetadata.
`void`	`setHostEmail(String hostEmail)`	setHostEmail.
`void`	`setHostEmailMetadata(PropertyMetadata hostEmailMetadata)`	setHostEmailMetadata.
`void`	`setHostName(String hostName)`	setHostName.
`void`	`setHostNameMetadata(PropertyMetadata hostNameMetadata)`	setHostNameMetadata.
`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`	`setInPersonSigningType(String inPersonSigningType)`	setInPersonSigningType.
`void`	`setInPersonSigningTypeMetadata(PropertyMetadata inPersonSigningTypeMetadata)`	setInPersonSigningTypeMetadata.
`void`	`setLockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)`	setLockedRecipientPhoneAuthEditable.
`void`	`setLockedRecipientSmsEditable(String lockedRecipientSmsEditable)`	setLockedRecipientSmsEditable.
`void`	`setName(String name)`	setName.
`void`	`setNameMetadata(PropertyMetadata nameMetadata)`	setNameMetadata.
`void`	`setNotaryHost(NotaryHost notaryHost)`	setNotaryHost.
`void`	`setNotaryId(String notaryId)`	setNotaryId.
`void`	`setNote(String note)`	setNote.
`void`	`setNoteMetadata(PropertyMetadata noteMetadata)`	setNoteMetadata.
`void`	`setOfflineAttributes(OfflineAttributes offlineAttributes)`	setOfflineAttributes.
`void`	`setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)`	setPhoneAuthentication.
`void`	`setRecipientAttachments(List<RecipientAttachment> recipientAttachments)`	setRecipientAttachments.
`void`	`setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)`	setRecipientAuthenticationStatus.
`void`	`setRecipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)`	setRecipientFeatureMetadata.
`void`	`setRecipientId(String recipientId)`	setRecipientId.
`void`	`setRecipientIdGuid(String recipientIdGuid)`	setRecipientIdGuid.
`void`	`setRecipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)`	setRecipientSignatureProviders.
`void`	`setRecipientSuppliesTabs(String recipientSuppliesTabs)`	setRecipientSuppliesTabs.
`void`	`setRecipientType(String recipientType)`	setRecipientType.
`void`	`setRecipientTypeMetadata(PropertyMetadata recipientTypeMetadata)`	setRecipientTypeMetadata.
`void`	`setRequireIdLookup(String requireIdLookup)`	setRequireIdLookup.
`void`	`setRequireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)`	setRequireIdLookupMetadata.
`void`	`setRequireSignerCertificate(String requireSignerCertificate)`	setRequireSignerCertificate.
`void`	`setRequireSignOnPaper(String requireSignOnPaper)`	setRequireSignOnPaper.
`void`	`setRequireUploadSignature(String requireUploadSignature)`	setRequireUploadSignature.
`void`	`setRoleName(String roleName)`	setRoleName.
`void`	`setRoutingOrder(String routingOrder)`	setRoutingOrder.
`void`	`setRoutingOrderMetadata(PropertyMetadata routingOrderMetadata)`	setRoutingOrderMetadata.
`void`	`setSentDateTime(String sentDateTime)`	setSentDateTime.
`void`	`setSignatureInfo(RecipientSignatureInformation signatureInfo)`	setSignatureInfo.
`void`	`setSignedDateTime(String signedDateTime)`	setSignedDateTime.
`void`	`setSignerEmail(String signerEmail)`	setSignerEmail.
`void`	`setSignerEmailMetadata(PropertyMetadata signerEmailMetadata)`	setSignerEmailMetadata.
`void`	`setSignerFirstName(String signerFirstName)`	setSignerFirstName.
`void`	`setSignerFirstNameMetadata(PropertyMetadata signerFirstNameMetadata)`	setSignerFirstNameMetadata.
`void`	`setSignerLastName(String signerLastName)`	setSignerLastName.
`void`	`setSignerLastNameMetadata(PropertyMetadata signerLastNameMetadata)`	setSignerLastNameMetadata.
`void`	`setSignerName(String signerName)`	setSignerName.
`void`	`setSignerNameMetadata(PropertyMetadata signerNameMetadata)`	setSignerNameMetadata.
`void`	`setSignInEachLocation(String signInEachLocation)`	setSignInEachLocation.
`void`	`setSignInEachLocationMetadata(PropertyMetadata signInEachLocationMetadata)`	setSignInEachLocationMetadata.
`void`	`setSigningGroupId(String signingGroupId)`	setSigningGroupId.
`void`	`setSigningGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)`	setSigningGroupIdMetadata.
`void`	`setSigningGroupName(String signingGroupName)`	setSigningGroupName.
`void`	`setSigningGroupUsers(List<UserInfo> signingGroupUsers)`	setSigningGroupUsers.
`void`	`setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)`	setSmsAuthentication.
`void`	`setSocialAuthentications(List<SocialAuthentication> socialAuthentications)`	setSocialAuthentications.
`void`	`setStatus(String status)`	setStatus.
`void`	`setStatusCode(String statusCode)`	setStatusCode.
`void`	`setSuppressEmails(String suppressEmails)`	setSuppressEmails.
`void`	`setTabs(Tabs tabs)`	setTabs.
`void`	`setTemplateLocked(String templateLocked)`	setTemplateLocked.
`void`	`setTemplateRequired(String templateRequired)`	setTemplateRequired.
`void`	`setTotalTabCount(String totalTabCount)`	setTotalTabCount.
`void`	`setUserId(String userId)`	setUserId.
`InPersonSigner`	`signatureInfo(RecipientSignatureInformation signatureInfo)`	signatureInfo.
`InPersonSigner`	`signedDateTime(String signedDateTime)`	signedDateTime.
`InPersonSigner`	`signerEmail(String signerEmail)`	signerEmail.
`InPersonSigner`	`signerEmailMetadata(PropertyMetadata signerEmailMetadata)`	signerEmailMetadata.
`InPersonSigner`	`signerFirstName(String signerFirstName)`	signerFirstName.
`InPersonSigner`	`signerFirstNameMetadata(PropertyMetadata signerFirstNameMetadata)`	signerFirstNameMetadata.
`InPersonSigner`	`signerLastName(String signerLastName)`	signerLastName.
`InPersonSigner`	`signerLastNameMetadata(PropertyMetadata signerLastNameMetadata)`	signerLastNameMetadata.
`InPersonSigner`	`signerName(String signerName)`	signerName.
`InPersonSigner`	`signerNameMetadata(PropertyMetadata signerNameMetadata)`	signerNameMetadata.
`InPersonSigner`	`signInEachLocation(String signInEachLocation)`	signInEachLocation.
`InPersonSigner`	`signInEachLocationMetadata(PropertyMetadata signInEachLocationMetadata)`	signInEachLocationMetadata.
`InPersonSigner`	`signingGroupId(String signingGroupId)`	signingGroupId.
`InPersonSigner`	`signingGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)`	signingGroupIdMetadata.
`InPersonSigner`	`signingGroupName(String signingGroupName)`	signingGroupName.
`InPersonSigner`	`signingGroupUsers(List<UserInfo> signingGroupUsers)`	signingGroupUsers.
`InPersonSigner`	`smsAuthentication(RecipientSMSAuthentication smsAuthentication)`	smsAuthentication.
`InPersonSigner`	`socialAuthentications(List<SocialAuthentication> socialAuthentications)`	socialAuthentications.
`InPersonSigner`	`status(String status)`	status.
`InPersonSigner`	`statusCode(String statusCode)`	statusCode.
`InPersonSigner`	`suppressEmails(String suppressEmails)`	suppressEmails.
`InPersonSigner`	`tabs(Tabs tabs)`	tabs.
`InPersonSigner`	`templateLocked(String templateLocked)`	templateLocked.
`InPersonSigner`	`templateRequired(String templateRequired)`	templateRequired.
`String`	`toString()`	Converts the given object to string.
`InPersonSigner`	`totalTabCount(String totalTabCount)`	totalTabCount.
`InPersonSigner`	`userId(String userId)`	userId.

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

- Constructor Detail
  - InPersonSigner
```
public InPersonSigner()
```
- Method Detail
  - accessCode
```
public InPersonSigner accessCode(String accessCode)
```
    accessCode.
    
    Returns:
    
    InPersonSigner
  - 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 InPersonSigner accessCodeMetadata(PropertyMetadata accessCodeMetadata)
```
    accessCodeMetadata.
    
    Returns:
    
    InPersonSigner
  - getAccessCodeMetadata
```
public PropertyMetadata getAccessCodeMetadata()
```
    Metadata that indicates whether the `accessCode` property is editable. This property is read-only..
    
    Returns:
    
    accessCodeMetadata
  - setAccessCodeMetadata
```
public void setAccessCodeMetadata(PropertyMetadata accessCodeMetadata)
```
    setAccessCodeMetadata.
  - addAccessCodeToEmail
```
public InPersonSigner addAccessCodeToEmail(String addAccessCodeToEmail)
```
    addAccessCodeToEmail.
    
    Returns:
    
    InPersonSigner
  - 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.
  - allowSystemOverrideForLockedRecipient
```
public InPersonSigner allowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)
```
    allowSystemOverrideForLockedRecipient.
    
    Returns:
    
    InPersonSigner
  - getAllowSystemOverrideForLockedRecipient
```
public String getAllowSystemOverrideForLockedRecipient()
```
    .
    
    Returns:
    
    allowSystemOverrideForLockedRecipient
  - setAllowSystemOverrideForLockedRecipient
```
public void setAllowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)
```
    setAllowSystemOverrideForLockedRecipient.
  - autoNavigation
```
public InPersonSigner autoNavigation(String autoNavigation)
```
    autoNavigation.
    
    Returns:
    
    InPersonSigner
  - getAutoNavigation
```
public String getAutoNavigation()
```
    .
    
    Returns:
    
    autoNavigation
  - setAutoNavigation
```
public void setAutoNavigation(String autoNavigation)
```
    setAutoNavigation.
  - autoRespondedReason
```
public InPersonSigner autoRespondedReason(String autoRespondedReason)
```
    autoRespondedReason.
    
    Returns:
    
    InPersonSigner
  - getAutoRespondedReason
```
public String getAutoRespondedReason()
```
    .
    
    Returns:
    
    autoRespondedReason
  - setAutoRespondedReason
```
public void setAutoRespondedReason(String autoRespondedReason)
```
    setAutoRespondedReason.
  - bulkSendV2Recipient
```
public InPersonSigner bulkSendV2Recipient(String bulkSendV2Recipient)
```
    bulkSendV2Recipient.
    
    Returns:
    
    InPersonSigner
  - getBulkSendV2Recipient
```
public String getBulkSendV2Recipient()
```
    .
    
    Returns:
    
    bulkSendV2Recipient
  - setBulkSendV2Recipient
```
public void setBulkSendV2Recipient(String bulkSendV2Recipient)
```
    setBulkSendV2Recipient.
  - canSignOffline
```
public InPersonSigner canSignOffline(String canSignOffline)
```
    canSignOffline.
    
    Returns:
    
    InPersonSigner
  - getCanSignOffline
```
public String getCanSignOffline()
```
    When set to **true**, specifies that the signer can perform the signing ceremony offline..
    
    Returns:
    
    canSignOffline
  - setCanSignOffline
```
public void setCanSignOffline(String canSignOffline)
```
    setCanSignOffline.
  - clientUserId
```
public InPersonSigner clientUserId(String clientUserId)
```
    clientUserId.
    
    Returns:
    
    InPersonSigner
  - 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 InPersonSigner completedCount(String completedCount)
```
    completedCount.
    
    Returns:
    
    InPersonSigner
  - getCompletedCount
```
public String getCompletedCount()
```
    .
    
    Returns:
    
    completedCount
  - setCompletedCount
```
public void setCompletedCount(String completedCount)
```
    setCompletedCount.
  - creationReason
```
public InPersonSigner creationReason(String creationReason)
```
    creationReason.
    
    Returns:
    
    InPersonSigner
  - getCreationReason
```
public String getCreationReason()
```
    .
    
    Returns:
    
    creationReason
  - setCreationReason
```
public void setCreationReason(String creationReason)
```
    setCreationReason.
  - customFields
```
public InPersonSigner customFields(List<String> customFields)
```
    customFields.
    
    Returns:
    
    InPersonSigner
  - addCustomFieldsItem
```
public InPersonSigner addCustomFieldsItem(String customFieldsItem)
```
    addCustomFieldsItem.
    
    Returns:
    
    InPersonSigner
  - 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 InPersonSigner declinedDateTime(String declinedDateTime)
```
    declinedDateTime.
    
    Returns:
    
    InPersonSigner
  - getDeclinedDateTime
```
public String getDeclinedDateTime()
```
    The date and time the recipient declined the document..
    
    Returns:
    
    declinedDateTime
  - setDeclinedDateTime
```
public void setDeclinedDateTime(String declinedDateTime)
```
    setDeclinedDateTime.
  - declinedReason
```
public InPersonSigner declinedReason(String declinedReason)
```
    declinedReason.
    
    Returns:
    
    InPersonSigner
  - getDeclinedReason
```
public String getDeclinedReason()
```
    The reason the recipient declined the document..
    
    Returns:
    
    declinedReason
  - setDeclinedReason
```
public void setDeclinedReason(String declinedReason)
```
    setDeclinedReason.
  - defaultRecipient
```
public InPersonSigner defaultRecipient(String defaultRecipient)
```
    defaultRecipient.
    
    Returns:
    
    InPersonSigner
  - getDefaultRecipient
```
public String getDefaultRecipient()
```
    .
    
    Returns:
    
    defaultRecipient
  - setDefaultRecipient
```
public void setDefaultRecipient(String defaultRecipient)
```
    setDefaultRecipient.
  - deliveredDateTime
```
public InPersonSigner deliveredDateTime(String deliveredDateTime)
```
    deliveredDateTime.
    
    Returns:
    
    InPersonSigner
  - getDeliveredDateTime
```
public String getDeliveredDateTime()
```
    Reserved: For DocuSign use only..
    
    Returns:
    
    deliveredDateTime
  - setDeliveredDateTime
```
public void setDeliveredDateTime(String deliveredDateTime)
```
    setDeliveredDateTime.
  - deliveryMethod
```
public InPersonSigner deliveryMethod(String deliveryMethod)
```
    deliveryMethod.
    
    Returns:
    
    InPersonSigner
  - getDeliveryMethod
```
public String getDeliveryMethod()
```
    Reserved: For DocuSign use only..
    
    Returns:
    
    deliveryMethod
  - setDeliveryMethod
```
public void setDeliveryMethod(String deliveryMethod)
```
    setDeliveryMethod.
  - deliveryMethodMetadata
```
public InPersonSigner deliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)
```
    deliveryMethodMetadata.
    
    Returns:
    
    InPersonSigner
  - getDeliveryMethodMetadata
```
public PropertyMetadata getDeliveryMethodMetadata()
```
    Reserved for DocuSign..
    
    Returns:
    
    deliveryMethodMetadata
  - setDeliveryMethodMetadata
```
public void setDeliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)
```
    setDeliveryMethodMetadata.
  - designatorId
```
public InPersonSigner designatorId(String designatorId)
```
    designatorId.
    
    Returns:
    
    InPersonSigner
  - getDesignatorId
```
public String getDesignatorId()
```
    .
    
    Returns:
    
    designatorId
  - setDesignatorId
```
public void setDesignatorId(String designatorId)
```
    setDesignatorId.
  - designatorIdGuid
```
public InPersonSigner designatorIdGuid(String designatorIdGuid)
```
    designatorIdGuid.
    
    Returns:
    
    InPersonSigner
  - getDesignatorIdGuid
```
public String getDesignatorIdGuid()
```
    .
    
    Returns:
    
    designatorIdGuid
  - setDesignatorIdGuid
```
public void setDesignatorIdGuid(String designatorIdGuid)
```
    setDesignatorIdGuid.
  - documentVisibility
```
public InPersonSigner documentVisibility(List<DocumentVisibility> documentVisibility)
```
    documentVisibility.
    
    Returns:
    
    InPersonSigner
  - addDocumentVisibilityItem
```
public InPersonSigner addDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)
```
    addDocumentVisibilityItem.
    
    Returns:
    
    InPersonSigner
  - getDocumentVisibility
```
public List<DocumentVisibility> getDocumentVisibility()
```
    .
    
    Returns:
    
    documentVisibility
  - setDocumentVisibility
```
public void setDocumentVisibility(List<DocumentVisibility> documentVisibility)
```
    setDocumentVisibility.
  - email
```
public InPersonSigner email(String email)
```
    email.
    
    Returns:
    
    InPersonSigner
  - getEmail
```
public String getEmail()
```
    .
    
    Returns:
    
    email
  - setEmail
```
public void setEmail(String email)
```
    setEmail.
  - emailMetadata
```
public InPersonSigner emailMetadata(PropertyMetadata emailMetadata)
```
    emailMetadata.
    
    Returns:
    
    InPersonSigner
  - getEmailMetadata
```
public PropertyMetadata getEmailMetadata()
```
    Metadata that indicates whether the `email` property is editable. This property is read-only..
    
    Returns:
    
    emailMetadata
  - setEmailMetadata
```
public void setEmailMetadata(PropertyMetadata emailMetadata)
```
    setEmailMetadata.
  - emailNotification
```
public InPersonSigner emailNotification(RecipientEmailNotification emailNotification)
```
    emailNotification.
    
    Returns:
    
    InPersonSigner
  - 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.
  - embeddedRecipientStartURL
```
public InPersonSigner embeddedRecipientStartURL(String embeddedRecipientStartURL)
```
    embeddedRecipientStartURL.
    
    Returns:
    
    InPersonSigner
  - 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 InPersonSigner errorDetails(ErrorDetails errorDetails)
```
    errorDetails.
    
    Returns:
    
    InPersonSigner
  - getErrorDetails
```
public ErrorDetails getErrorDetails()
```
    Array or errors..
    
    Returns:
    
    errorDetails
  - setErrorDetails
```
public void setErrorDetails(ErrorDetails errorDetails)
```
    setErrorDetails.
  - excludedDocuments
```
public InPersonSigner excludedDocuments(List<String> excludedDocuments)
```
    excludedDocuments.
    
    Returns:
    
    InPersonSigner
  - addExcludedDocumentsItem
```
public InPersonSigner addExcludedDocumentsItem(String excludedDocumentsItem)
```
    addExcludedDocumentsItem.
    
    Returns:
    
    InPersonSigner
  - getExcludedDocuments
```
public List<String> getExcludedDocuments()
```
    Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent..
    
    Returns:
    
    excludedDocuments
  - setExcludedDocuments
```
public void setExcludedDocuments(List<String> excludedDocuments)
```
    setExcludedDocuments.
  - faxNumber
```
public InPersonSigner faxNumber(String faxNumber)
```
    faxNumber.
    
    Returns:
    
    InPersonSigner
  - getFaxNumber
```
public String getFaxNumber()
```
    Reserved:.
    
    Returns:
    
    faxNumber
  - setFaxNumber
```
public void setFaxNumber(String faxNumber)
```
    setFaxNumber.
  - faxNumberMetadata
```
public InPersonSigner faxNumberMetadata(PropertyMetadata faxNumberMetadata)
```
    faxNumberMetadata.
    
    Returns:
    
    InPersonSigner
  - getFaxNumberMetadata
```
public PropertyMetadata getFaxNumberMetadata()
```
    Reserved for DocuSign..
    
    Returns:
    
    faxNumberMetadata
  - setFaxNumberMetadata
```
public void setFaxNumberMetadata(PropertyMetadata faxNumberMetadata)
```
    setFaxNumberMetadata.
  - hostEmail
```
public InPersonSigner hostEmail(String hostEmail)
```
    hostEmail.
    
    Returns:
    
    InPersonSigner
  - getHostEmail
```
public String getHostEmail()
```
    .
    
    Returns:
    
    hostEmail
  - setHostEmail
```
public void setHostEmail(String hostEmail)
```
    setHostEmail.
  - hostEmailMetadata
```
public InPersonSigner hostEmailMetadata(PropertyMetadata hostEmailMetadata)
```
    hostEmailMetadata.
    
    Returns:
    
    InPersonSigner
  - getHostEmailMetadata
```
public PropertyMetadata getHostEmailMetadata()
```
    Metadata that indicates whether the `hostEmail` property is editable..
    
    Returns:
    
    hostEmailMetadata
  - setHostEmailMetadata
```
public void setHostEmailMetadata(PropertyMetadata hostEmailMetadata)
```
    setHostEmailMetadata.
  - hostName
```
public InPersonSigner hostName(String hostName)
```
    hostName.
    
    Returns:
    
    InPersonSigner
  - getHostName
```
public String getHostName()
```
    Specifies the name of the signing host. It is a required element for In Person Signers recipient Type. Maximum Length: 100 characters..
    
    Returns:
    
    hostName
  - setHostName
```
public void setHostName(String hostName)
```
    setHostName.
  - hostNameMetadata
```
public InPersonSigner hostNameMetadata(PropertyMetadata hostNameMetadata)
```
    hostNameMetadata.
    
    Returns:
    
    InPersonSigner
  - getHostNameMetadata
```
public PropertyMetadata getHostNameMetadata()
```
    Metadata that indicates whether the `hostName` property is editable..
    
    Returns:
    
    hostNameMetadata
  - setHostNameMetadata
```
public void setHostNameMetadata(PropertyMetadata hostNameMetadata)
```
    setHostNameMetadata.
  - idCheckConfigurationName
```
public InPersonSigner idCheckConfigurationName(String idCheckConfigurationName)
```
    idCheckConfigurationName.
    
    Returns:
    
    InPersonSigner
  - 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 InPersonSigner idCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)
```
    idCheckConfigurationNameMetadata.
    
    Returns:
    
    InPersonSigner
  - getIdCheckConfigurationNameMetadata
```
public PropertyMetadata getIdCheckConfigurationNameMetadata()
```
    Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only..
    
    Returns:
    
    idCheckConfigurationNameMetadata
  - setIdCheckConfigurationNameMetadata
```
public void setIdCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)
```
    setIdCheckConfigurationNameMetadata.
  - idCheckInformationInput
```
public InPersonSigner idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
```
    idCheckInformationInput.
    
    Returns:
    
    InPersonSigner
  - getIdCheckInformationInput
```
public IdCheckInformationInput getIdCheckInformationInput()
```
    An object that contains input information related to a recipient ID check..
    
    Returns:
    
    idCheckInformationInput
  - setIdCheckInformationInput
```
public void setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
```
    setIdCheckInformationInput.
  - identityVerification
```
public InPersonSigner identityVerification(RecipientIdentityVerification identityVerification)
```
    identityVerification.
    
    Returns:
    
    InPersonSigner
  - getIdentityVerification
```
public RecipientIdentityVerification getIdentityVerification()
```
    Specifies the ID Verification workflow applied on an envelope by workflow ID.
    See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account.
    This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
    Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)..
    
    Returns:
    
    identityVerification
  - setIdentityVerification
```
public void setIdentityVerification(RecipientIdentityVerification identityVerification)
```
    setIdentityVerification.
  - inheritEmailNotificationConfiguration
```
public InPersonSigner inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)
```
    inheritEmailNotificationConfiguration.
    
    Returns:
    
    InPersonSigner
  - 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.
  - inPersonSigningType
```
public InPersonSigner inPersonSigningType(String inPersonSigningType)
```
    inPersonSigningType.
    
    Returns:
    
    InPersonSigner
  - getInPersonSigningType
```
public String getInPersonSigningType()
```
    .
    
    Returns:
    
    inPersonSigningType
  - setInPersonSigningType
```
public void setInPersonSigningType(String inPersonSigningType)
```
    setInPersonSigningType.
  - inPersonSigningTypeMetadata
```
public InPersonSigner inPersonSigningTypeMetadata(PropertyMetadata inPersonSigningTypeMetadata)
```
    inPersonSigningTypeMetadata.
    
    Returns:
    
    InPersonSigner
  - getInPersonSigningTypeMetadata
```
public PropertyMetadata getInPersonSigningTypeMetadata()
```
    Metadata that indicates whether the `inPersonSigningType` property is editable..
    
    Returns:
    
    inPersonSigningTypeMetadata
  - setInPersonSigningTypeMetadata
```
public void setInPersonSigningTypeMetadata(PropertyMetadata inPersonSigningTypeMetadata)
```
    setInPersonSigningTypeMetadata.
  - lockedRecipientPhoneAuthEditable
```
public InPersonSigner lockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)
```
    lockedRecipientPhoneAuthEditable.
    
    Returns:
    
    InPersonSigner
  - getLockedRecipientPhoneAuthEditable
```
public String getLockedRecipientPhoneAuthEditable()
```
    .
    
    Returns:
    
    lockedRecipientPhoneAuthEditable
  - setLockedRecipientPhoneAuthEditable
```
public void setLockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)
```
    setLockedRecipientPhoneAuthEditable.
  - lockedRecipientSmsEditable
```
public InPersonSigner lockedRecipientSmsEditable(String lockedRecipientSmsEditable)
```
    lockedRecipientSmsEditable.
    
    Returns:
    
    InPersonSigner
  - getLockedRecipientSmsEditable
```
public String getLockedRecipientSmsEditable()
```
    .
    
    Returns:
    
    lockedRecipientSmsEditable
  - setLockedRecipientSmsEditable
```
public void setLockedRecipientSmsEditable(String lockedRecipientSmsEditable)
```
    setLockedRecipientSmsEditable.
  - name
```
public InPersonSigner name(String name)
```
    name.
    
    Returns:
    
    InPersonSigner
  - getName
```
public String getName()
```
    .
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
    setName.
  - nameMetadata
```
public InPersonSigner nameMetadata(PropertyMetadata nameMetadata)
```
    nameMetadata.
    
    Returns:
    
    InPersonSigner
  - getNameMetadata
```
public PropertyMetadata getNameMetadata()
```
    Metadata that indicates whether the `name` property is editable. This property is read-only..
    
    Returns:
    
    nameMetadata
  - setNameMetadata
```
public void setNameMetadata(PropertyMetadata nameMetadata)
```
    setNameMetadata.
  - notaryHost
```
public InPersonSigner notaryHost(NotaryHost notaryHost)
```
    notaryHost.
    
    Returns:
    
    InPersonSigner
  - getNotaryHost
```
public NotaryHost getNotaryHost()
```
    Information about the notary host. The following information is required when using the eNotary in-person signing flow: - `name`: The name of the notary. - `email`: The email address of the notary. - `recipientId`: A unique ID number for the notary signing host..
    
    Returns:
    
    notaryHost
  - setNotaryHost
```
public void setNotaryHost(NotaryHost notaryHost)
```
    setNotaryHost.
  - notaryId
```
public InPersonSigner notaryId(String notaryId)
```
    notaryId.
    
    Returns:
    
    InPersonSigner
  - getNotaryId
```
public String getNotaryId()
```
    .
    
    Returns:
    
    notaryId
  - setNotaryId
```
public void setNotaryId(String notaryId)
```
    setNotaryId.
  - note
```
public InPersonSigner note(String note)
```
    note.
    
    Returns:
    
    InPersonSigner
  - 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 InPersonSigner noteMetadata(PropertyMetadata noteMetadata)
```
    noteMetadata.
    
    Returns:
    
    InPersonSigner
  - getNoteMetadata
```
public PropertyMetadata getNoteMetadata()
```
    Metadata that indicates whether the `note` property is editable. This property is read-only..
    
    Returns:
    
    noteMetadata
  - setNoteMetadata
```
public void setNoteMetadata(PropertyMetadata noteMetadata)
```
    setNoteMetadata.
  - offlineAttributes
```
public InPersonSigner offlineAttributes(OfflineAttributes offlineAttributes)
```
    offlineAttributes.
    
    Returns:
    
    InPersonSigner
  - getOfflineAttributes
```
public OfflineAttributes getOfflineAttributes()
```
    Reserved for DocuSign..
    
    Returns:
    
    offlineAttributes
  - setOfflineAttributes
```
public void setOfflineAttributes(OfflineAttributes offlineAttributes)
```
    setOfflineAttributes.
  - phoneAuthentication
```
public InPersonSigner phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
```
    phoneAuthentication.
    
    Returns:
    
    InPersonSigner
  - getPhoneAuthentication
```
public RecipientPhoneAuthentication getPhoneAuthentication()
```
    When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign. .
    
    Returns:
    
    phoneAuthentication
  - setPhoneAuthentication
```
public void setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
```
    setPhoneAuthentication.
  - recipientAttachments
```
public InPersonSigner recipientAttachments(List<RecipientAttachment> recipientAttachments)
```
    recipientAttachments.
    
    Returns:
    
    InPersonSigner
  - addRecipientAttachmentsItem
```
public InPersonSigner addRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)
```
    addRecipientAttachmentsItem.
    
    Returns:
    
    InPersonSigner
  - getRecipientAttachments
```
public List<RecipientAttachment> getRecipientAttachments()
```
    Reserved:.
    
    Returns:
    
    recipientAttachments
  - setRecipientAttachments
```
public void setRecipientAttachments(List<RecipientAttachment> recipientAttachments)
```
    setRecipientAttachments.
  - recipientAuthenticationStatus
```
public InPersonSigner recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
```
    recipientAuthenticationStatus.
    
    Returns:
    
    InPersonSigner
  - getRecipientAuthenticationStatus
```
public AuthenticationStatus getRecipientAuthenticationStatus()
```
    Information about the recipient's authentication status. This property is read-only..
    
    Returns:
    
    recipientAuthenticationStatus
  - setRecipientAuthenticationStatus
```
public void setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
```
    setRecipientAuthenticationStatus.
  - recipientFeatureMetadata
```
public InPersonSigner recipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)
```
    recipientFeatureMetadata.
    
    Returns:
    
    InPersonSigner
  - addRecipientFeatureMetadataItem
```
public InPersonSigner addRecipientFeatureMetadataItem(FeatureAvailableMetadata recipientFeatureMetadataItem)
```
    addRecipientFeatureMetadataItem.
    
    Returns:
    
    InPersonSigner
  - getRecipientFeatureMetadata
```
public List<FeatureAvailableMetadata> getRecipientFeatureMetadata()
```
    .
    
    Returns:
    
    recipientFeatureMetadata
  - setRecipientFeatureMetadata
```
public void setRecipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)
```
    setRecipientFeatureMetadata.
  - recipientId
```
public InPersonSigner recipientId(String recipientId)
```
    recipientId.
    
    Returns:
    
    InPersonSigner
  - 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 InPersonSigner recipientIdGuid(String recipientIdGuid)
```
    recipientIdGuid.
    
    Returns:
    
    InPersonSigner
  - getRecipientIdGuid
```
public String getRecipientIdGuid()
```
    .
    
    Returns:
    
    recipientIdGuid
  - setRecipientIdGuid
```
public void setRecipientIdGuid(String recipientIdGuid)
```
    setRecipientIdGuid.
  - recipientSignatureProviders
```
public InPersonSigner recipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)
```
    recipientSignatureProviders.
    
    Returns:
    
    InPersonSigner
  - addRecipientSignatureProvidersItem
```
public InPersonSigner addRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)
```
    addRecipientSignatureProvidersItem.
    
    Returns:
    
    InPersonSigner
  - getRecipientSignatureProviders
```
public List<RecipientSignatureProvider> getRecipientSignatureProviders()
```
    .
    
    Returns:
    
    recipientSignatureProviders
  - setRecipientSignatureProviders
```
public void setRecipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)
```
    setRecipientSignatureProviders.
  - recipientSuppliesTabs
```
public InPersonSigner recipientSuppliesTabs(String recipientSuppliesTabs)
```
    recipientSuppliesTabs.
    
    Returns:
    
    InPersonSigner
  - getRecipientSuppliesTabs
```
public String getRecipientSuppliesTabs()
```
    .
    
    Returns:
    
    recipientSuppliesTabs
  - setRecipientSuppliesTabs
```
public void setRecipientSuppliesTabs(String recipientSuppliesTabs)
```
    setRecipientSuppliesTabs.
  - recipientType
```
public InPersonSigner recipientType(String recipientType)
```
    recipientType.
    
    Returns:
    
    InPersonSigner
  - getRecipientType
```
public String getRecipientType()
```
    .
    
    Returns:
    
    recipientType
  - setRecipientType
```
public void setRecipientType(String recipientType)
```
    setRecipientType.
  - recipientTypeMetadata
```
public InPersonSigner recipientTypeMetadata(PropertyMetadata recipientTypeMetadata)
```
    recipientTypeMetadata.
    
    Returns:
    
    InPersonSigner
  - getRecipientTypeMetadata
```
public PropertyMetadata getRecipientTypeMetadata()
```
    Metadata that indicates whether the `recipientType` property is editable. This property is read-only..
    
    Returns:
    
    recipientTypeMetadata
  - setRecipientTypeMetadata
```
public void setRecipientTypeMetadata(PropertyMetadata recipientTypeMetadata)
```
    setRecipientTypeMetadata.
  - requireIdLookup
```
public InPersonSigner requireIdLookup(String requireIdLookup)
```
    requireIdLookup.
    
    Returns:
    
    InPersonSigner
  - 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 InPersonSigner requireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)
```
    requireIdLookupMetadata.
    
    Returns:
    
    InPersonSigner
  - getRequireIdLookupMetadata
```
public PropertyMetadata getRequireIdLookupMetadata()
```
    Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only..
    
    Returns:
    
    requireIdLookupMetadata
  - setRequireIdLookupMetadata
```
public void setRequireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)
```
    setRequireIdLookupMetadata.
  - requireSignerCertificate
```
public InPersonSigner requireSignerCertificate(String requireSignerCertificate)
```
    requireSignerCertificate.
    
    Returns:
    
    InPersonSigner
  - getRequireSignerCertificate
```
public String getRequireSignerCertificate()
```
    .
    
    Returns:
    
    requireSignerCertificate
  - setRequireSignerCertificate
```
public void setRequireSignerCertificate(String requireSignerCertificate)
```
    setRequireSignerCertificate.
  - requireSignOnPaper
```
public InPersonSigner requireSignOnPaper(String requireSignOnPaper)
```
    requireSignOnPaper.
    
    Returns:
    
    InPersonSigner
  - getRequireSignOnPaper
```
public String getRequireSignOnPaper()
```
    .
    
    Returns:
    
    requireSignOnPaper
  - setRequireSignOnPaper
```
public void setRequireSignOnPaper(String requireSignOnPaper)
```
    setRequireSignOnPaper.
  - requireUploadSignature
```
public InPersonSigner requireUploadSignature(String requireUploadSignature)
```
    requireUploadSignature.
    
    Returns:
    
    InPersonSigner
  - getRequireUploadSignature
```
public String getRequireUploadSignature()
```
    .
    
    Returns:
    
    requireUploadSignature
  - setRequireUploadSignature
```
public void setRequireUploadSignature(String requireUploadSignature)
```
    setRequireUploadSignature.
  - roleName
```
public InPersonSigner roleName(String roleName)
```
    roleName.
    
    Returns:
    
    InPersonSigner
  - 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 InPersonSigner routingOrder(String routingOrder)
```
    routingOrder.
    
    Returns:
    
    InPersonSigner
  - 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 InPersonSigner routingOrderMetadata(PropertyMetadata routingOrderMetadata)
```
    routingOrderMetadata.
    
    Returns:
    
    InPersonSigner
  - getRoutingOrderMetadata
```
public PropertyMetadata getRoutingOrderMetadata()
```
    Metadata that indicates whether the `routingOrder` property is editable. This property is read-only..
    
    Returns:
    
    routingOrderMetadata
  - setRoutingOrderMetadata
```
public void setRoutingOrderMetadata(PropertyMetadata routingOrderMetadata)
```
    setRoutingOrderMetadata.
  - sentDateTime
```
public InPersonSigner sentDateTime(String sentDateTime)
```
    sentDateTime.
    
    Returns:
    
    InPersonSigner
  - getSentDateTime
```
public String getSentDateTime()
```
    The date and time the envelope was sent..
    
    Returns:
    
    sentDateTime
  - setSentDateTime
```
public void setSentDateTime(String sentDateTime)
```
    setSentDateTime.
  - signatureInfo
```
public InPersonSigner signatureInfo(RecipientSignatureInformation signatureInfo)
```
    signatureInfo.
    
    Returns:
    
    InPersonSigner
  - getSignatureInfo
```
public RecipientSignatureInformation getSignatureInfo()
```
    Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers..
    
    Returns:
    
    signatureInfo
  - setSignatureInfo
```
public void setSignatureInfo(RecipientSignatureInformation signatureInfo)
```
    setSignatureInfo.
  - signedDateTime
```
public InPersonSigner signedDateTime(String signedDateTime)
```
    signedDateTime.
    
    Returns:
    
    InPersonSigner
  - getSignedDateTime
```
public String getSignedDateTime()
```
    Reserved: For DocuSign use only. .
    
    Returns:
    
    signedDateTime
  - setSignedDateTime
```
public void setSignedDateTime(String signedDateTime)
```
    setSignedDateTime.
  - signerEmail
```
public InPersonSigner signerEmail(String signerEmail)
```
    signerEmail.
    
    Returns:
    
    InPersonSigner
  - getSignerEmail
```
public String getSignerEmail()
```
    The email address for an InPersonSigner recipient Type. Maximum Length: 100 characters. .
    
    Returns:
    
    signerEmail
  - setSignerEmail
```
public void setSignerEmail(String signerEmail)
```
    setSignerEmail.
  - signerEmailMetadata
```
public InPersonSigner signerEmailMetadata(PropertyMetadata signerEmailMetadata)
```
    signerEmailMetadata.
    
    Returns:
    
    InPersonSigner
  - getSignerEmailMetadata
```
public PropertyMetadata getSignerEmailMetadata()
```
    Metadata that indicates if the sender can edit the in-person signer's email address..
    
    Returns:
    
    signerEmailMetadata
  - setSignerEmailMetadata
```
public void setSignerEmailMetadata(PropertyMetadata signerEmailMetadata)
```
    setSignerEmailMetadata.
  - signerFirstName
```
public InPersonSigner signerFirstName(String signerFirstName)
```
    signerFirstName.
    
    Returns:
    
    InPersonSigner
  - getSignerFirstName
```
public String getSignerFirstName()
```
    .
    
    Returns:
    
    signerFirstName
  - setSignerFirstName
```
public void setSignerFirstName(String signerFirstName)
```
    setSignerFirstName.
  - signerFirstNameMetadata
```
public InPersonSigner signerFirstNameMetadata(PropertyMetadata signerFirstNameMetadata)
```
    signerFirstNameMetadata.
    
    Returns:
    
    InPersonSigner
  - getSignerFirstNameMetadata
```
public PropertyMetadata getSignerFirstNameMetadata()
```
    Metadata that indicates if the `signerFirstName` property is editable..
    
    Returns:
    
    signerFirstNameMetadata
  - setSignerFirstNameMetadata
```
public void setSignerFirstNameMetadata(PropertyMetadata signerFirstNameMetadata)
```
    setSignerFirstNameMetadata.
  - signerLastName
```
public InPersonSigner signerLastName(String signerLastName)
```
    signerLastName.
    
    Returns:
    
    InPersonSigner
  - getSignerLastName
```
public String getSignerLastName()
```
    .
    
    Returns:
    
    signerLastName
  - setSignerLastName
```
public void setSignerLastName(String signerLastName)
```
    setSignerLastName.
  - signerLastNameMetadata
```
public InPersonSigner signerLastNameMetadata(PropertyMetadata signerLastNameMetadata)
```
    signerLastNameMetadata.
    
    Returns:
    
    InPersonSigner
  - getSignerLastNameMetadata
```
public PropertyMetadata getSignerLastNameMetadata()
```
    Metadata that indicates whether the `signerLastName` property is editable..
    
    Returns:
    
    signerLastNameMetadata
  - setSignerLastNameMetadata
```
public void setSignerLastNameMetadata(PropertyMetadata signerLastNameMetadata)
```
    setSignerLastNameMetadata.
  - signerName
```
public InPersonSigner signerName(String signerName)
```
    signerName.
    
    Returns:
    
    InPersonSigner
  - getSignerName
```
public String getSignerName()
```
    Required. The full legal name of a signer for the envelope. Maximum Length: 100 characters. .
    
    Returns:
    
    signerName
  - setSignerName
```
public void setSignerName(String signerName)
```
    setSignerName.
  - signerNameMetadata
```
public InPersonSigner signerNameMetadata(PropertyMetadata signerNameMetadata)
```
    signerNameMetadata.
    
    Returns:
    
    InPersonSigner
  - getSignerNameMetadata
```
public PropertyMetadata getSignerNameMetadata()
```
    Metadata that indicates whether the `signerName` property is editable..
    
    Returns:
    
    signerNameMetadata
  - setSignerNameMetadata
```
public void setSignerNameMetadata(PropertyMetadata signerNameMetadata)
```
    setSignerNameMetadata.
  - signInEachLocation
```
public InPersonSigner signInEachLocation(String signInEachLocation)
```
    signInEachLocation.
    
    Returns:
    
    InPersonSigner
  - getSignInEachLocation
```
public String getSignInEachLocation()
```
    When set to **true**, specifies that the signer must sign in all locations..
    
    Returns:
    
    signInEachLocation
  - setSignInEachLocation
```
public void setSignInEachLocation(String signInEachLocation)
```
    setSignInEachLocation.
  - signInEachLocationMetadata
```
public InPersonSigner signInEachLocationMetadata(PropertyMetadata signInEachLocationMetadata)
```
    signInEachLocationMetadata.
    
    Returns:
    
    InPersonSigner
  - getSignInEachLocationMetadata
```
public PropertyMetadata getSignInEachLocationMetadata()
```
    Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only..
    
    Returns:
    
    signInEachLocationMetadata
  - setSignInEachLocationMetadata
```
public void setSignInEachLocationMetadata(PropertyMetadata signInEachLocationMetadata)
```
    setSignInEachLocationMetadata.
  - signingGroupId
```
public InPersonSigner signingGroupId(String signingGroupId)
```
    signingGroupId.
    
    Returns:
    
    InPersonSigner
  - 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 InPersonSigner signingGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)
```
    signingGroupIdMetadata.
    
    Returns:
    
    InPersonSigner
  - getSigningGroupIdMetadata
```
public PropertyMetadata getSigningGroupIdMetadata()
```
    Not applicable..
    
    Returns:
    
    signingGroupIdMetadata
  - setSigningGroupIdMetadata
```
public void setSigningGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)
```
    setSigningGroupIdMetadata.
  - signingGroupName
```
public InPersonSigner signingGroupName(String signingGroupName)
```
    signingGroupName.
    
    Returns:
    
    InPersonSigner
  - 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 InPersonSigner signingGroupUsers(List<UserInfo> signingGroupUsers)
```
    signingGroupUsers.
    
    Returns:
    
    InPersonSigner
  - addSigningGroupUsersItem
```
public InPersonSigner addSigningGroupUsersItem(UserInfo signingGroupUsersItem)
```
    addSigningGroupUsersItem.
    
    Returns:
    
    InPersonSigner
  - 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 InPersonSigner smsAuthentication(RecipientSMSAuthentication smsAuthentication)
```
    smsAuthentication.
    
    Returns:
    
    InPersonSigner
  - getSmsAuthentication
```
public RecipientSMSAuthentication getSmsAuthentication()
```
    When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. .
    
    Returns:
    
    smsAuthentication
  - setSmsAuthentication
```
public void setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)
```
    setSmsAuthentication.
  - socialAuthentications
```
public InPersonSigner socialAuthentications(List<SocialAuthentication> socialAuthentications)
```
    socialAuthentications.
    
    Returns:
    
    InPersonSigner
  - addSocialAuthenticationsItem
```
public InPersonSigner addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)
```
    addSocialAuthenticationsItem.
    
    Returns:
    
    InPersonSigner
  - 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 InPersonSigner status(String status)
```
    status.
    
    Returns:
    
    InPersonSigner
  - 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 InPersonSigner statusCode(String statusCode)
```
    statusCode.
    
    Returns:
    
    InPersonSigner
  - getStatusCode
```
public String getStatusCode()
```
    .
    
    Returns:
    
    statusCode
  - setStatusCode
```
public void setStatusCode(String statusCode)
```
    setStatusCode.
  - suppressEmails
```
public InPersonSigner suppressEmails(String suppressEmails)
```
    suppressEmails.
    
    Returns:
    
    InPersonSigner
  - getSuppressEmails
```
public String getSuppressEmails()
```
    .
    
    Returns:
    
    suppressEmails
  - setSuppressEmails
```
public void setSuppressEmails(String suppressEmails)
```
    setSuppressEmails.
  - tabs
```
public InPersonSigner tabs(Tabs tabs)
```
    tabs.
    
    Returns:
    
    InPersonSigner
  - getTabs
```
public Tabs getTabs()
```
    A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients..
    
    Returns:
    
    tabs
  - setTabs
```
public void setTabs(Tabs tabs)
```
    setTabs.
  - templateLocked
```
public InPersonSigner templateLocked(String templateLocked)
```
    templateLocked.
    
    Returns:
    
    InPersonSigner
  - 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 InPersonSigner templateRequired(String templateRequired)
```
    templateRequired.
    
    Returns:
    
    InPersonSigner
  - 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 InPersonSigner totalTabCount(String totalTabCount)
```
    totalTabCount.
    
    Returns:
    
    InPersonSigner
  - getTotalTabCount
```
public String getTotalTabCount()
```
    .
    
    Returns:
    
    totalTabCount
  - setTotalTabCount
```
public void setTotalTabCount(String totalTabCount)
```
    setTotalTabCount.
  - userId
```
public InPersonSigner userId(String userId)
```
    userId.
    
    Returns:
    
    InPersonSigner
  - getUserId
```
public String getUserId()
```
    .
    
    Returns:
    
    userId
  - setUserId
```
public void setUserId(String userId)
```
    setUserId.
  - equals
```
public boolean equals(Object o)
```
    Compares objects.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true or false depending on comparison result.
  - hashCode
```
public int hashCode()
```
    Returns the HashCode.
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Converts the given object to string.
    
    Overrides:
    
    toString in class Object

Class InPersonSigner

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InPersonSigner

Method Detail

accessCode

getAccessCode

setAccessCode

accessCodeMetadata

getAccessCodeMetadata

setAccessCodeMetadata

addAccessCodeToEmail

getAddAccessCodeToEmail

setAddAccessCodeToEmail

allowSystemOverrideForLockedRecipient

getAllowSystemOverrideForLockedRecipient

setAllowSystemOverrideForLockedRecipient

autoNavigation

getAutoNavigation

setAutoNavigation

autoRespondedReason

getAutoRespondedReason

setAutoRespondedReason

bulkSendV2Recipient

getBulkSendV2Recipient

setBulkSendV2Recipient

canSignOffline

getCanSignOffline

setCanSignOffline

clientUserId

getClientUserId

setClientUserId

completedCount

getCompletedCount

setCompletedCount

creationReason

getCreationReason

setCreationReason

customFields

addCustomFieldsItem

getCustomFields

setCustomFields

declinedDateTime

getDeclinedDateTime

setDeclinedDateTime

declinedReason

getDeclinedReason

setDeclinedReason

defaultRecipient

getDefaultRecipient

setDefaultRecipient

deliveredDateTime

getDeliveredDateTime

setDeliveredDateTime

deliveryMethod

getDeliveryMethod

setDeliveryMethod

deliveryMethodMetadata

getDeliveryMethodMetadata

setDeliveryMethodMetadata

designatorId

getDesignatorId

setDesignatorId

designatorIdGuid

getDesignatorIdGuid

setDesignatorIdGuid

documentVisibility

addDocumentVisibilityItem

getDocumentVisibility

setDocumentVisibility

email

getEmail

setEmail

emailMetadata

getEmailMetadata

setEmailMetadata

emailNotification

getEmailNotification