new module:model/IdCheckInformationInput()
- Source:
Constructs a new IdCheckInformationInput.
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.
Members
(inner) addressInformationInput :module:model/AddressInformationInput
- Source:
An object that specifies recipient address information and how it is displayed.
Type:
(inner) dobInformationInput :module:model/DobInformationInput
- Source:
An object that specifies recipient date of birth information and how it is displayed.
Type:
(inner) ssn4InformationInput :module:model/Ssn4InformationInput
- Source:
An object that specifies the last four digits of the recipient's Social Security Number (SSN).
Type:
(inner) ssn9InformationInput :module:model/Ssn9InformationInput
- Source:
An object that specifies the recipient's Social Security Number (SSN) information. Note that ssn9 information cannot be returned in a response.
Type:
Methods
(static) constructFromObject(data, obj) → {module:model/IdCheckInformationInput}
- Source:
Constructs a IdCheckInformationInput from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:model/IdCheckInformationInput | Optional instance to populate. |
Returns:
The populated IdCheckInformationInput instance.