NameDescriptionTypeAdditional information
addClient

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

SLYesNoEnum

None.

sendToReview

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

SLYesNoEnum

None.

returnCategory

Determines whether the FinScan Categories will be returned with the Compliance Records [Yes or No (default)]. Setting to Yes will result in increased time to complete the request. Please note, this option is no longer needed as the FinScan Categories are now returned in the fnsCategories field and is only here for backwards compatibility.

SLYesNoEnum

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 (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.

returnSourceLists

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

SLYesNoEnum

None.

returnSearchDetails

Selects whether the FinScan Categories and Dynamic Fields are returned in the search. Setting to Yes will result in increased time to complete the request [Yes or No (default)].

SLYesNoEnum

None.

generateclientId

Determines whether a Client ID will be generated for the Client Record created within FinScan [Yes or No (default)].

SLYesNoEnum

None.

updateUserFields

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

SLYesNoEnum

None.

skipSearch

Determines whether the Search step will be skipped and will return the current Match details [Yes or No (default)].

SLYesNoEnum

None.

skipClientUpdate

Determines whether the Client Update step will be skipped [Yes or No (default)].

SLYesNoEnum

None.

processUBO

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

SLYesNoEnum

None.

searchUBOMembers

Determines whether to screen the generated UBO Network Members [Yes or No (default)].

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 [Yes or No (default)]. Please Note: if this option is selected, it will override the addClient option (if set to No) so that the generated Client Records/Networks will be created.

SLYesNoEnum

None.

disablePremiumNameSplit

Determines whether the FinScan Premium processing will create new Client Records from Joint names found in the Name Line (e.g. John and Mary Smith) [Yes or No (default)].

SLYesNoEnum

None.

disablePremiumAddressLineClientGeneration

Determines whether the FinScan Premium processing will generate new Client Records from names found in Address Lines[Yes or No (default)].

SLYesNoEnum

None.

disablePremiumCrossApplicationMatching

Determines whether the FinScan Premium processing will match Client Records across all Applications (No) or only within a single Application (Yes) [Yes or No (default)].

SLYesNoEnum

None.

returnClientRiskRating

Determines whether the Wrapper will return the Client Risk Rating [Yes or No (default)]. Please note that this may require an additional call to be made.

SLYesNoEnum

None.

returnSearchAudit

Returns the Audit details for the Search [Yes or No (default)].

SLYesNoEnum

None.

checkScreeningHistory

Determines whether an additional call will be made when no matches are found to retrieve the Screening History for a Client in order to determine whether or not the client has been Screened and that the "PASS" being returned is not because it has not yet been screened. In this case, it will return the value NOT_SCREENED instead of PASS [Yes or No (default)]. This feature will only be available when a search is not performed (skipSearch = Yes) or when returnAllPrefixMatches = Yes.

SLYesNoEnum

None.