POST wrapper/clients/update

(SLUpdateClient) Update the information for a Client Record

Request Information

URI Parameters

None.

Body Parameters

Wrapper Update Client Request LSTServicesUpdateClientRequest

LSTServicesUpdateClientRequest
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.
newApplicationId

Populate this field if you wish to change the Client Record's Application ID.

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

Populate this field if you wish to change the unique and permanent ID for the Client Record.

 string

None.
clientStatus

The Current Status of the Client [Active or Inactive].

 SLClientStatusEnum

None.
gender

The Gender of the Client [Male, Female or Unknown].

 SLGenderEnum

None.
isOrganization

The Client is an Organization [Yes or No].

 SLYesNoEnum

None.
nameLine

The Client's Name.

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

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

 SLYesNoEnum

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

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

 SLYesNoEnum

None.
knownIndividual

Determines whether the record will be known to be an individual and not determined by FinScan.

 SLYesNoEnum

None.

Request Formats

application/json, text/json

Sample: 
{
  "organizationName": "sample string 1",
  "userName": "sample string 2",
  "password": "sample string 3",
  "applicationId": "sample string 4",
  "newApplicationId": "sample string 5",
  "clientId": "sample string 6",
  "newClientId": "sample string 7",
  "clientStatus": 0,
  "gender": 0,
  "isOrganization": 0,
  "nameLine": "sample string 8",
  "alternateNames": [
    {
      "nameLine": "sample string 1",
      "clientSearchCode": 0
    },
    {
      "nameLine": "sample string 1",
      "clientSearchCode": 0
    }
  ],
  "addressLine1": "sample string 9",
  "addressLine2": "sample string 10",
  "addressLine3": "sample string 11",
  "addressLine4": "sample string 12",
  "addressLine5": "sample string 13",
  "addressLine6": "sample string 14",
  "addressLine7": "sample string 15",
  "updateUserFields": 0,
  "userField1Label": "sample string 16",
  "userField1Value": "sample string 17",
  "userField2Label": "sample string 18",
  "userField2Value": "sample string 19",
  "userField3Label": "sample string 20",
  "userField3Value": "sample string 21",
  "userField4Label": "sample string 22",
  "userField4Value": "sample string 23",
  "userField5Label": "sample string 24",
  "userField5Value": "sample string 25",
  "userField6Label": "sample string 26",
  "userField6Value": "sample string 27",
  "userField7Label": "sample string 28",
  "userField7Value": "sample string 29",
  "userField8Label": "sample string 30",
  "userField8Value": "sample string 31",
  "userField9Label": "sample string 32",
  "userField9Value": "sample string 33",
  "userField10Label": "sample string 34",
  "userField10Value": "sample string 35",
  "userField11Label": "sample string 36",
  "userField11Value": "sample string 37",
  "userField12Label": "sample string 38",
  "userField12Value": "sample string 39",
  "userField13Label": "sample string 40",
  "userField13Value": "sample string 41",
  "userField14Label": "sample string 42",
  "userField14Value": "sample string 43",
  "userField15Label": "sample string 44",
  "userField15Value": "sample string 45",
  "userField16Label": "sample string 46",
  "userField16Value": "sample string 47",
  "userField17Label": "sample string 48",
  "userField17Value": "sample string 49",
  "userField18Label": "sample string 50",
  "userField18Value": "sample string 51",
  "userField19Label": "sample string 52",
  "userField19Value": "sample string 53",
  "userField20Label": "sample string 54",
  "userField20Value": "sample string 55",
  "comment": "sample string 56",
  "passthrough": "sample string 57",
  "overwritePassthrough": 0,
  "knownIndividual": 0
}

application/xml, text/xml

Sample: 
<LSTServicesUpdateClientRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookup">
  <addressLine1>sample string 9</addressLine1>
  <addressLine2>sample string 10</addressLine2>
  <addressLine3>sample string 11</addressLine3>
  <addressLine4>sample string 12</addressLine4>
  <addressLine5>sample string 13</addressLine5>
  <addressLine6>sample string 14</addressLine6>
  <addressLine7>sample string 15</addressLine7>
  <alternateNames>
    <SLAlternateName>
      <clientSearchCode>FullName</clientSearchCode>
      <nameLine>sample string 1</nameLine>
    </SLAlternateName>
    <SLAlternateName>
      <clientSearchCode>FullName</clientSearchCode>
      <nameLine>sample string 1</nameLine>
    </SLAlternateName>
  </alternateNames>
  <applicationId>sample string 4</applicationId>
  <clientId>sample string 6</clientId>
  <clientStatus>Active</clientStatus>
  <comment>sample string 56</comment>
  <gender>Male</gender>
  <isOrganization>No</isOrganization>
  <knownIndividual>No</knownIndividual>
  <nameLine>sample string 8</nameLine>
  <newApplicationId>sample string 5</newApplicationId>
  <newClientId>sample string 7</newClientId>
  <organizationName>sample string 1</organizationName>
  <overwritePassthrough>No</overwritePassthrough>
  <passthrough>sample string 57</passthrough>
  <password>sample string 3</password>
  <updateUserFields>No</updateUserFields>
  <userField10Label>sample string 34</userField10Label>
  <userField10Value>sample string 35</userField10Value>
  <userField11Label>sample string 36</userField11Label>
  <userField11Value>sample string 37</userField11Value>
  <userField12Label>sample string 38</userField12Label>
  <userField12Value>sample string 39</userField12Value>
  <userField13Label>sample string 40</userField13Label>
  <userField13Value>sample string 41</userField13Value>
  <userField14Label>sample string 42</userField14Label>
  <userField14Value>sample string 43</userField14Value>
  <userField15Label>sample string 44</userField15Label>
  <userField15Value>sample string 45</userField15Value>
  <userField16Label>sample string 46</userField16Label>
  <userField16Value>sample string 47</userField16Value>
  <userField17Label>sample string 48</userField17Label>
  <userField17Value>sample string 49</userField17Value>
  <userField18Label>sample string 50</userField18Label>
  <userField18Value>sample string 51</userField18Value>
  <userField19Label>sample string 52</userField19Label>
  <userField19Value>sample string 53</userField19Value>
  <userField1Label>sample string 16</userField1Label>
  <userField1Value>sample string 17</userField1Value>
  <userField20Label>sample string 54</userField20Label>
  <userField20Value>sample string 55</userField20Value>
  <userField2Label>sample string 18</userField2Label>
  <userField2Value>sample string 19</userField2Value>
  <userField3Label>sample string 20</userField3Label>
  <userField3Value>sample string 21</userField3Value>
  <userField4Label>sample string 22</userField4Label>
  <userField4Value>sample string 23</userField4Value>
  <userField5Label>sample string 24</userField5Label>
  <userField5Value>sample string 25</userField5Value>
  <userField6Label>sample string 26</userField6Label>
  <userField6Value>sample string 27</userField6Value>
  <userField7Label>sample string 28</userField7Label>
  <userField7Value>sample string 29</userField7Value>
  <userField8Label>sample string 30</userField8Label>
  <userField8Value>sample string 31</userField8Value>
  <userField9Label>sample string 32</userField9Label>
  <userField9Value>sample string 33</userField9Value>
  <userName>sample string 2</userName>
</LSTServicesUpdateClientRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Client Details

LSTServicesUpdateClientResponse
NameDescriptionTypeAdditional information
status

The Current Status of the Client matches within FinScan [Pass, Pending, Fail, Error or Duplicate].

 SLResultTypeEnum

None.
code

A Code Value for the Status/Message returned.

 SLWrapperCodes

None.
message

String containing information on the Search status/results including Error details.

 string

None.
version

The version of the Wrapper.

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

The previous unique and permanent ID for the Client Record (before update).

 string

None.
clientKey

The unique Key within FinScan, used for accessing certain Reports.

 integer

None.
applicationId

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

 string

None.
oldApplicationId

The previous permanent ID for the Client Record.

 string

None.
isiReserved

A field used to return debugging information.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "status": 0,
  "code": 0,
  "message": "sample string 1",
  "version": "sample string 2",
  "clientId": "sample string 3",
  "oldClientId": "sample string 4",
  "clientKey": 5,
  "applicationId": "sample string 6",
  "oldApplicationId": "sample string 7",
  "isiReserved": "sample string 8"
}

application/xml, text/xml

Sample: 
<LSTServicesUpdateClientResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookup">
  <applicationId>sample string 6</applicationId>
  <clientId>sample string 3</clientId>
  <clientKey>5</clientKey>
  <code>SUCCESS</code>
  <isiReserved>sample string 8</isiReserved>
  <message>sample string 1</message>
  <oldApplicationId>sample string 7</oldApplicationId>
  <oldClientId>sample string 4</oldClientId>
  <status>PASS</status>
  <version>sample string 2</version>
</LSTServicesUpdateClientResponse>