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

The "Prefix" value that will be used to deterimine for which List Categories to return the results or "ALL" to return for all Prefix Categories.

 string

None.
returnAllPrefixMatches

Determines whether all "Prefix" matches will be returned in the response instead of a single "Prefix" [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. This feature will only be enabled when set to "Yes" and when no matches are returned [Yes or No (default)].

 SLYesNoEnum

None.