DocuSign.eSign.Model.IdCheckInformationInput Class Reference

A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: * dateOfBirth: Specifies the recipient's date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: * ssn4: Specifies the last four digits of the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: * ssn9: Specifies the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. More...

Inheritance diagram for DocuSign.eSign.Model.IdCheckInformationInput:

Public Member Functions
	IdCheckInformationInput (AddressInformationInput AddressInformationInput=default(AddressInformationInput), DobInformationInput DobInformationInput=default(DobInformationInput), Ssn4InformationInput Ssn4InformationInput=default(Ssn4InformationInput), Ssn9InformationInput Ssn9InformationInput=default(Ssn9InformationInput))
	Initializes a new instance of the IdCheckInformationInput class. More...
override string	ToString ()
	Returns the string presentation of the object More...
string	ToJson ()
	Returns the JSON string presentation of the object More...
override bool	Equals (object obj)
	Returns true if objects are equal More...
bool	Equals (IdCheckInformationInput other)
	Returns true if IdCheckInformationInput instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...
IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
AddressInformationInput	AddressInformationInput [get, set]
	An object that specifies recipient address information and how it is displayed. More...
DobInformationInput	DobInformationInput [get, set]
	An object that specifies recipient date of birth information and how it is displayed. More...
Ssn4InformationInput	Ssn4InformationInput [get, set]
	An object that specifies the last four digits of the recipient's Social Security Number (SSN). More...
Ssn9InformationInput	Ssn9InformationInput [get, set]
	An object that specifies the recipient's Social Security Number (SSN) information. Note that ssn9 information cannot be returned in a response. More...

Detailed Description

A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: * dateOfBirth: Specifies the recipient's date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: * ssn4: Specifies the last four digits of the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: * ssn9: Specifies the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

Constructor & Destructor Documentation

IdCheckInformationInput()

DocuSign.eSign.Model.IdCheckInformationInput.IdCheckInformationInput ( AddressInformationInput  AddressInformationInput = default(AddressInformationInput), DobInformationInput  DobInformationInput = default(DobInformationInput), Ssn4InformationInput  Ssn4InformationInput = default(Ssn4InformationInput), Ssn9InformationInput  Ssn9InformationInput = default(Ssn9InformationInput)  )

inline

Initializes a new instance of the IdCheckInformationInput class.

Parameters

AddressInformationInput	An object that specifies recipient address information and how it is displayed..
DobInformationInput	An object that specifies recipient date of birth information and how it is displayed..
Ssn4InformationInput	An object that specifies the last four digits of the recipient's Social Security Number (SSN)..
Ssn9InformationInput	An object that specifies the recipient's Social Security Number (SSN) information. Note that ssn9 information cannot be returned in a response..

Member Function Documentation

Equals() [1/2]

override bool DocuSign.eSign.Model.IdCheckInformationInput.Equals ( object  obj )

inline

Returns true if objects are equal

Parameters

obj	Object to be compared

Returns

Boolean

Equals() [2/2]

bool DocuSign.eSign.Model.IdCheckInformationInput.Equals ( IdCheckInformationInput  other )

inline

Returns true if IdCheckInformationInput instances are equal

Parameters

other

Instance of IdCheckInformationInput to be compared

Returns

Boolean

GetHashCode()

override int DocuSign.eSign.Model.IdCheckInformationInput.GetHashCode ( )

inline

Gets the hash code

Returns

Hash code

ToJson()

string DocuSign.eSign.Model.IdCheckInformationInput.ToJson ( )

inline

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

override string DocuSign.eSign.Model.IdCheckInformationInput.ToString ( )

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

AddressInformationInput

AddressInformationInput DocuSign.eSign.Model.IdCheckInformationInput.AddressInformationInput

getset

An object that specifies recipient address information and how it is displayed.

An object that specifies recipient address information and how it is displayed.

DobInformationInput

DobInformationInput DocuSign.eSign.Model.IdCheckInformationInput.DobInformationInput

getset

An object that specifies recipient date of birth information and how it is displayed.

An object that specifies recipient date of birth information and how it is displayed.

Ssn4InformationInput

Ssn4InformationInput DocuSign.eSign.Model.IdCheckInformationInput.Ssn4InformationInput

getset

An object that specifies the last four digits of the recipient's Social Security Number (SSN).

An object that specifies the last four digits of the recipient's Social Security Number (SSN).

Ssn9InformationInput

Ssn9InformationInput DocuSign.eSign.Model.IdCheckInformationInput.Ssn9InformationInput

getset

An object that specifies the recipient's Social Security Number (SSN) information. Note that ssn9 information cannot be returned in a response.

An object that specifies the recipient's Social Security Number (SSN) information. Note that ssn9 information cannot be returned in a response.

---

The documentation for this class was generated from the following file:

• sdk/src/DocuSign.eSign/Model/IdCheckInformationInput.cs