NameDescriptionTypeAdditional information
organizationName

The User's Organization Name.

string

None.

userName

The User's Name.

string

None.

password

The User's Password.

string

None.

applicationId

The ID for the Application where the Client should be saved/accessed (Required).

string

None.

searchType

The Type of Search to use [Individual, Organization, SpecificElement, Individual_Both or Organization_Both].

SLSearchTypeEnum

None.

clientId

The unique and permanent ID for the Client Record. The Client ID is used by FinScan to uniquely identify a Client record within an Application.

string

None.

clientSearchCode

The Code for the Search being performed: [FullName, EqualWithWildcardedInitials, PartialOnly, SoundexOnly or PartialAndSoundex].

SLClientSearchCodeEnum

None.

lists

An array of Lists/Categories to Search against.

Collection of SLComplianceList

None.

returnSearchComplianceRecords

Determines whether the full Compliance List record data is returned for matches found in Search [Yes or No (default)]. Setting this option to Yes will make an additional call to retrieve the full Compliance List record data for each match that is found, increasing the time required to complete the request.

SLYesNoEnum

None.

returnComplianceRecords

Determines whether the full Compliance List record data is returned for matches in Review [Yes or No]. Setting this option to Yes will make an additional call to retrieve the full Compliance List record data for each match that is found, increasing the time required to complete the request.

SLYesNoEnum

None.

addClient

Determines whether a Client Record will be created within FinScan if a match is not found [Yes or No].

SLYesNoEnum

None.

sendToReview

Determines whether the matches found (if any) are sent to Review [Yes or No].

SLYesNoEnum

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.

updateUserFields

Determines whether to update existing the User Fields or to retain the current values for this client [Yes or No].

SLYesNoEnum

None.

returnCategory

Determines whether the FinScan Categories will be returned with the Compliance Records [Yes or No].

SLYesNoEnum

None.

returnSourceLists

Determines whether the Source List (List or Keyword) will be returned with the Compliance Records [Yes or No].

SLYesNoEnum

None.

returnSearchDetails

Selects a slower processing option which returns additional details in the Search results [Yes or No (default)].

SLYesNoEnum

None.

processUBO

Determines whether to additionally screen against the UBO Database [Yes or No].

SLYesNoEnum

None.

searchUBOMembers

Determines whether to screen the generated UBO Network Members.

SLYesNoEnum

None.

overwritePassthrough

Determines whether the Passthrough field will be prepended or overwritten [Yes (overwrite) or No (default - prepend)]. Previous versions would always insert the new value before the existing value.

SLYesNoEnum

None.

processFinScanPremium

Determines whether to additionally call the FinScan Premium function in order to find previously existing Clients (duplicates) and/or additional Clients in the request. This feature is not active in the current release.

SLYesNoEnum

None.