ListFieldOptionality service

You use this service to list the fields and show which are mandatory, optional and not needed for a specific process configuration. To run this service, you must supply either the process configuration ID or name.

This service returns:

GroupName - the name of the data group
FieldName - the name of the field
Optionality - this is one of:

Mandatory - you must supply this field
Optional - you can supply this field, and if you do it will be checked
Not Used- you do not need to supply this field and this information is not checked.

SOAP messages

Request

<soapenv:Body>

<ns:ListFieldOptionality>

<eih:EIHHeader>

<eih:ClientUser>User</eih:ClientUser>

<eih:ReferenceId>123</eih:ReferenceId>

</eih:EIHHeader>

<ns:ProcessConfigReference>

<!-This example supplies the Process Configuration ID-->

<ns:ProcessConfigId>62910219-63f1-4936-ba2e-ce9558913ef6</ns:ProcessConfigId>

</ns:ProcessConfigReference>

</ns:ListFieldOptionality>

</soapenv:Body>

Response

<SOAP-ENV:Body>

<eih:ListOptionalityResponse>

<header:EIHHeader>

<header:ClientUser>User</header:ClientUser>

<header:ReferenceId>123</header:ReferenceId>

</header:EIHHeader>

<eih:return>

<eih:group name="ExecuteRequest" optionality="Mandatory">

<eih:field name="ResponseType" optionality="Mandatory"/>

<eih:field name="Consent" optionality="Mandatory"/>

<eih:group name="ProcessConfigReference[@ProcessConfigName='Name' or @ProcessConfigId='ID']" optionality="Mandatory">

<eih:field name="ProcessConfigName" optionality="Mandatory" value="Name"/>

<eih:field name="ProcessConfigId" optionality="Mandatory" value="ID"/>

</eih:group>

<eih:group name="PersonalData" optionality="Optional">

<eih:field name="Gender" optionality="Mandatory"/>

<eih:field name="BirthDate" optionality="Mandatory"/>

<eih:field name="MothersMaidenName" optionality="Not Used"/>

<eih:field name="MaritalStatus" optionality="Not Used"/>

<eih:field name="ResidentialStatus" optionality="Not Used"/>

<eih:field name="CountryOfBirth" optionality="Not Used"/>

<eih:field name="NumberOfDependants" optionality="Not Used"/>

<eih:field name="PlaceOfBirth" optionality="Not Used"/>

<eih:group name="Name" optionality="Not Used">

<eih:field name="Title" optionality="Mandatory"/>

<eih:field name="Forename" optionality="Mandatory"/>

<eih:field name="MiddleName" optionality="Optional"/>

<eih:field name="Surname" optionality="Mandatory"/>

<eih:field name="SurnameAtBirth" optionality="Not Used"/>

<eih:field name="MaidenName" optionality="Not Used"/>

<eih:field name="Suffix" optionality="Optional"/>

</eih:group>

<eih:group name="Alias" optionality="Optional">

...

</eih:group>

<eih:group name="Addresses" optionality="Mandatory">

<eih:group name="Address[@TypeOfAddress='Current']" optionality="Optional">

<eih:field name="TypeOfAddress" optionality="Not Used"/>

<eih:field name="AddressStatus" optionality="Optional" value="Current"/>

<eih:field name="ResidentFrom" optionality="Optional"/>

<eih:field name="ResidentTo" optionality="Optional"/>

<eih:group name="AddressDetail" optionality="Mandatory">

<eih:field name="FlatOrApartmentNumber" optionality="Optional"/>

<eih:field name="HouseName" optionality="Optional"/>

<eih:field name="HouseNumber" optionality="Optional"/>

<eih:field name="Address1" optionality="Mandatory"/>

<eih:field name="Address2" optionality="Optional"/>

<eih:field name="Address3" optionality="Mandatory"/>

<eih:field name="Address4" optionality="Optional"/>

<eih:field name="Address5" optionality="Not Used"/>

<eih:field name="Address6" optionality="Not Used"/>

<eih:field name="PostCode" optionality="Optional"/>

<eih:field name="Country" optionality="Optional"/>

<eih:field name="POBox" optionality="Optional"/>

</eih:group>

<eih:group name="Address[@TypeOfAddress!='Current']" optionality="Optional">

...

</eih:group>

<eih:group name="EmployerInformation" optionality="Optional">

<eih:group name="TimeWithEmployer" optionality="Optional">

<eih:field name="Years" optionality="Not Used"/>

<eih:field name="Months" optionality="Not Used"/>

</eih:group>

<eih:group name="Telephones" optionality="Optional">

<eih:group name="Telephone[@TypeOfTelephone='Work']" optionality="Optional">

<eih:field name="Code" optionality="Optional"/>

<eih:field name="Number" optionality="Optional"/>

<eih:field name="TypeOfTelephone" optionality="Optional" value="Work"/>

</eih:group>

<eih:group name="Telephone[@TypeOfTelephone='Home']" optionality="Mandatory">

...

</eih:group>

<eih:group name="BankInformation" optionality="Mandatory">

<eih:field name="AccountSetupDate" optionality="Optional"/>

<eih:field name="CheckContext" optionality="Mandatory"/>

<eih:field name="RollNumber" optionality="Optional"/>

<eih:field name="OwnerType" optionality="Optional"/>

<eih:group name="AccountReference[@TypeOfReference='Bank Branch Code']" optionality="Mandatory">

<eih:field name="ReferenceIndex" optionality="Not Used" value="1"/>

<eih:field name="Reference" optionality="Mandatory"/>

<eih:field name="TypeOfReference" optionality="Not Used" value="Bank Branch Code"/>

</eih:group>

<eih:group name="AccountReference[@TypeOfReference='Account Number']" optionality="Mandatory">

...

</eih:group>

<eih:group name="AccountReference[@TypeOfReference!='Bank Branch Code' and @TypeOfReference!='Account Number']" optionality="Not Used">

...

</eih:group>

<eih:group name="ReferenceNumbers" optionality="Not Used">

<eih:group name="ReferenceNumber[@ReferenceNumberSource='Passport']" optionality="Not Used">

<eih:field name="Number" optionality="Not Used"/>

<eih:field name="ReferenceNumberSource" optionality="Not Used" value="Passport"/>

</eih:group>

<eih:group name="ReferenceNumber[@ReferenceNumberSource='Drivers Licence']" optionality="Not Used">

<eih:field name="Number" optionality="Not Used"/>

<eih:field name="ReferenceNumberSource" optionality="Not Used" value="Drivers Licence"/>

</eih:group>

<eih:group name="ReferenceNumber[@ReferenceNumberSource='Bill Reference']" optionality="Not Used">

...

</eih:group>

<eih:group name="Other" optionality="Not Used">

<eih:field name="Email" optionality="Not Used"/>

<eih:field name="IPAddress" optionality="Not Used"/>

<eih:field name="DeviceId" optionality="Not Used"/>

<eih:field name="ChannelOfCapture" optionality="Not Used"/>

<eih:field name="ChannelOfProduct" optionality="Not Used"/>

<eih:field name="ValueOfProduct" optionality="Not Used"/>

<eih:field name="DescriptionOfCapture" optionality="Not Used"/>

<eih:field name="OwnCustomerIdNumber" optionality="Not Used"/>

<eih:field name="Profession" optionality="Not Used"/>

</eih:group>

<eih:group name="Card" optionality="Not Used">

<eih:field name="CardNumber" optionality="Not Used"/>

<eih:field name="CardStartDate" optionality="Not Used"/>

<eih:field name="CardExpireDate" optionality="Not Used"/>

<eih:field name="CardSecurityCode" optionality="Not Used"/>

<eih:field name="TypeOfCardType" optionality="Not Used"/>

<eih:field name="CardIssueNumber" optionality="Not Used"/>

</eih:group>

</eih:return>

</eih:ListOptionalityResponse>

</SOAP-ENV:Body>