Name | Description | Type | Additional information |
---|---|---|---|
organizationName |
The User's Organization Name (Required). |
string |
None. |
userName |
The User's Name (Required). |
string |
None. |
password |
The User's Password (Required). |
string |
None. |
applicationId |
The ID for the Application where the Client should be saved/accessed (Required). |
string |
None. |
lists |
An array of Lists/Categories to Search against. |
Collection of SLComplianceList |
None. |
searchType |
The Type of Search to use [Individual (default), Organization, SpecificElement, Individual_Both, Organization_Both, Individual_SpecificElement, Organization_SpecificElement, Individual_All or Organization_All]. |
SLSearchTypeEnum |
None. |
clientId |
The unique and permanent ID for the Client Record (Required, unless generateclientId switch is set to Yes). |
string |
None. |
clientStatus |
The Current Status of the Client [Active (default) or Inactive]. |
SLClientStatusEnum |
None. |
gender |
The Gender of the Client [Male (default), Female or Unknown]. |
SLGenderEnum |
None. |
nameLine |
The Client's Name (Required). |
string |
None. |
alternateNames |
Alternate Names for the client (such as native character script). Both the primary name |
Collection of SLAlternateName |
None. |
addressLine1 |
The first address line for the client, leave blank if not available. |
string |
None. |
addressLine2 |
The second address line for the client, leave blank if not available. |
string |
None. |
addressLine3 |
The third address line for the client, leave blank if not available. |
string |
None. |
addressLine4 |
The fourth address line for the client, leave blank if not available. |
string |
None. |
addressLine5 |
The fifth address line for the client, leave blank if not available. |
string |
None. |
addressLine6 |
The sixth address line for the client, leave blank if not available. |
string |
None. |
addressLine7 |
The seventh address line for the client, leave blank if not available. |
string |
None. |
specificElement |
The value used for searching against a Specific Element List such as a Country or Currency List. |
Collection of string |
None. |
clientSearchCode |
The Code for the Search being performed [FullName (default), EqualWithWildcardedInitials, PartialOnly, SoundexOnly or PartialAndSoundex] |
SLClientSearchCodeEnum |
None. |
userFieldsSearch |
Determines whether to perform a search specific to the User Fields. The User Field search will match any record that matches that User Field, regardless of the other fields, including Name, so be sure not to use a Country or other common field as that may generate thousands of matches. Takes an array of Integers as the parameter with each integer representing a specific User Field (e.g. {1, 3} would mean User Field 1 and User Field 3 would be used for the User Field match). |
Collection of integer |
None. |
userField1Label |
The Label for the first User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField1Value |
The Value for the first User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField2Label |
The Label for the second User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField2Value |
The Value for the second User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField3Label |
The Label for the third User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField3Value |
The Value for the third User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField4Label |
The Label for the fourth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField4Value |
The Value for the fourth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField5Label |
The Label for the fifth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField5Value |
The Value for the fifth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField6Label |
The Label for the sixth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField6Value |
The Value for the sixth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField7Label |
The Label for the seventh User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField7Value |
The Value for the seventh User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField8Label |
The Label for the eighth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField8Value |
The Value for the eighth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField9Label |
The Label for the ninth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField9Value |
The Value for the ninth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField10Label |
The Label for the tenth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField10Value |
The Value for the tenth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField11Label |
The Label for the eleventh User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField11Value |
The Value for the eleventh User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField12Label |
The Label for the twelfth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField12Value |
The Value for the twelfth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField13Label |
The Label for the thirteenth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField13Value |
The Value for the thirteenth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField14Label |
The Label for the fourteenth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField14Value |
The Value for the fourteenth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField15Label |
The Label for the fifteenth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField15Value |
The Value for the fifteenth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField16Label |
The Label for the sixteenth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField16Value |
The Value for the sixteenth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField17Label |
The Label for the seventeenth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField17Value |
The Value for the seventeenth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField18Label |
The Label for the eighteenth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField18Value |
The Value for the eighteenth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField19Label |
The Label for the nineteenth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField19Value |
The Value for the nineteenth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField20Label |
The Label for the twentieth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
userField20Value |
The Value for the twentieth User Field. User Fields are designed to contain information such as Country or Date of Birth. Contact your Professional Services Consultant for details on User Fields. |
string |
None. |
comment |
A comment to be added to the Client/Match record. |
string |
None. |
passthrough |
Data to be passed through to the Client/Match record. |
string |
None. |
options |
Contains the Options for the search |
SLLookupOptions |
None. |
UBO_Id |
The Unique VAT ID by Country. |
string |
None. |
userFieldsCountry |
Determines whether to standardize ISO Country Codes to the Standard Country names used within FinScan. Takes an array of Integers as the parameter with each integer representing a specific User Field that should be standardized (e.g. {1, 3} would mean User Field 1 and User Field 3 would be standardized). Using the value 21 will standardize the specificElement Field(s) for a Specific Element Search. |
Collection of integer |
None. |
generateSearchReports |
Determines whether to generate a Search Report. This is now limited to return a maximum of 50 total records. If you need more, you will need to repeat the Search/Report within the Case Tool. |
SLSearchReportTypeEnum |
None. |
reportTypeCode |
Determines the format of the generated Report (Only used if generateSearchReports is not "None"). |
SLSearchReportTypeCodeEnum |
None. |
premiumFields |
Contains the User Field where the Country, Date of Birth, etc. are contained. This feature is not active in the current release. |
SLFinScanPremiumFields |
None. |
prefixValue |
The "Prefix" value that will be used to deterimine which List Categories to screen against or "ALL" to screen against all Prefix Categories. |
string |
None. |
returnAllPrefixMatches |
Determines whether all "Prefix" matches will be returned in the response instead of a single "Prefix" |
SLYesNoEnum |
None. |