POST wrapper/pairs/get
(SLGetUpdatedClients) Returns the Clients with Matches that have been updated within a Time period.
Request Information
URI Parameters
None.
Body Parameters
Wrapper Request LSTServicesGetUpdatedClientsRequest
LSTServicesGetUpdatedClientsRequest| Name | Description | Type | Additional 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 Application ID's for the Transaction being processed. If left blank, all Applications for which the user has access will be returned. |
Collection of string |
None. |
| excludedUsers |
This will exclude Clients with matches that have only been modified by the users specified. Please note that the users specified here may still appear in the results if the Client has matches that were modified by another user. If this field is populated, the includedUsers field will be ignored. |
Collection of string |
None. |
| includedUsers |
This will only include Clients that have been modified by the users specified. Please note that users other than ones specified here may still appear in the results as all matches for the Client will be returned. If the excludedUsers field is populated, this field will be ignored. |
Collection of string |
None. |
| elapsedTime |
The amount of time in minutes you would like for previous updates to be displayed. If this field is non-zero, that value will be used. |
integer |
None. |
| lastGetTime |
The start time for which you would like updates (until the current time). This field will only be used if the elapsedTime is zero. |
date |
None. |
| returnClientRiskRating |
Determines whether the Wrapper will return the Client Risk Rating. Please note that this may require an additional call to me made. |
SLYesNoEnum |
None. |
Request Formats
application/json, text/json
{
"organizationName": "sample string 1",
"userName": "sample string 2",
"password": "sample string 3",
"applicationId": [
"sample string 1",
"sample string 2"
],
"excludedUsers": [
"sample string 1",
"sample string 2"
],
"includedUsers": [
"sample string 1",
"sample string 2"
],
"elapsedTime": 4,
"lastGetTime": "2024-04-11T17:04:59.3445066+00:00",
"returnClientRiskRating": 0
}
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Match information with optional Compliance List Record details
LSTServicesGetUpdatedClientsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| status |
The Current Status of the call [Pass, Pending or Fail]. If potential matches are found, the Status returned will be Pending until all of the potential matches have been reviewed, even if one or more matches are set as a Hit. |
SLResultTypeEnum |
None. |
| message |
Information on the call results including Error details. |
string |
None. |
| version |
The version of the Wrapper. |
string |
None. |
| isiReserved |
A field used to return debugging information. |
string |
None. |
| lastGetTime |
The time the search was performed. |
date |
None. |
| clients |
The Clients that have been updated within the date/time range. There is a limit of 10,000 Client records returned in one call. |
Collection of SLUpdatedClient |
None. |
Response Formats
application/json, text/json
{
"status": 0,
"message": "sample string 1",
"version": "sample string 2",
"isiReserved": "sample string 3",
"lastGetTime": "2024-04-11T17:04:59.3757114+00:00",
"clients": [
{
"applicationId": "sample string 1",
"clientId": "sample string 2",
"clientKey": 3,
"status": 0,
"pairs": [
{
"listId": "sample string 1",
"listProfileId": "sample string 2",
"listProfileKey": 3,
"status": 0,
"pairStatus": "sample string 4",
"pairReason": "sample string 5",
"pairComments": "sample string 6",
"modifyDate": "2024-04-11T17:04:59.3757114+00:00",
"modifiedByUser": "sample string 8",
"initialUser": "sample string 9"
},
{
"listId": "sample string 1",
"listProfileId": "sample string 2",
"listProfileKey": 3,
"status": 0,
"pairStatus": "sample string 4",
"pairReason": "sample string 5",
"pairComments": "sample string 6",
"modifyDate": "2024-04-11T17:04:59.3757114+00:00",
"modifiedByUser": "sample string 8",
"initialUser": "sample string 9"
}
],
"riskDetails": {
"overallClientRiskRating": 0,
"overallClientRiskScore": 1,
"cipRiskScore": 2,
"screeningResultsRiskScore": 3,
"clientExtendedRisk": [
{
"clientRiskSectionMnemonic": "sample string 1",
"clientRiskSubsections": [
{
"clientRiskSubSectionMnemonic": "sample string 1",
"clientRiskExtendedMappings": [
{
"clientRiskFactorMnemonic": "sample string 1",
"riskScore": 2
},
{
"clientRiskFactorMnemonic": "sample string 1",
"riskScore": 2
}
]
},
{
"clientRiskSubSectionMnemonic": "sample string 1",
"clientRiskExtendedMappings": [
{
"clientRiskFactorMnemonic": "sample string 1",
"riskScore": 2
},
{
"clientRiskFactorMnemonic": "sample string 1",
"riskScore": 2
}
]
}
]
},
{
"clientRiskSectionMnemonic": "sample string 1",
"clientRiskSubsections": [
{
"clientRiskSubSectionMnemonic": "sample string 1",
"clientRiskExtendedMappings": [
{
"clientRiskFactorMnemonic": "sample string 1",
"riskScore": 2
},
{
"clientRiskFactorMnemonic": "sample string 1",
"riskScore": 2
}
]
},
{
"clientRiskSubSectionMnemonic": "sample string 1",
"clientRiskExtendedMappings": [
{
"clientRiskFactorMnemonic": "sample string 1",
"riskScore": 2
},
{
"clientRiskFactorMnemonic": "sample string 1",
"riskScore": 2
}
]
}
]
}
],
"clientRiskHistory": [
{
"overallClientRiskRating": 0,
"overallClientRiskScore": 1,
"cipRiskScore": 2,
"screeningResultsRiskScore": 3,
"modifyDate": "2024-04-11T17:04:59.3757114+00:00"
},
{
"overallClientRiskRating": 0,
"overallClientRiskScore": 1,
"cipRiskScore": 2,
"screeningResultsRiskScore": 3,
"modifyDate": "2024-04-11T17:04:59.3757114+00:00"
}
]
}
},
{
"applicationId": "sample string 1",
"clientId": "sample string 2",
"clientKey": 3,
"status": 0,
"pairs": [
{
"listId": "sample string 1",
"listProfileId": "sample string 2",
"listProfileKey": 3,
"status": 0,
"pairStatus": "sample string 4",
"pairReason": "sample string 5",
"pairComments": "sample string 6",
"modifyDate": "2024-04-11T17:04:59.3757114+00:00",
"modifiedByUser": "sample string 8",
"initialUser": "sample string 9"
},
{
"listId": "sample string 1",
"listProfileId": "sample string 2",
"listProfileKey": 3,
"status": 0,
"pairStatus": "sample string 4",
"pairReason": "sample string 5",
"pairComments": "sample string 6",
"modifyDate": "2024-04-11T17:04:59.3757114+00:00",
"modifiedByUser": "sample string 8",
"initialUser": "sample string 9"
}
],
"riskDetails": {
"overallClientRiskRating": 0,
"overallClientRiskScore": 1,
"cipRiskScore": 2,
"screeningResultsRiskScore": 3,
"clientExtendedRisk": [
{
"clientRiskSectionMnemonic": "sample string 1",
"clientRiskSubsections": [
{
"clientRiskSubSectionMnemonic": "sample string 1",
"clientRiskExtendedMappings": [
{
"clientRiskFactorMnemonic": "sample string 1",
"riskScore": 2
},
{
"clientRiskFactorMnemonic": "sample string 1",
"riskScore": 2
}
]
},
{
"clientRiskSubSectionMnemonic": "sample string 1",
"clientRiskExtendedMappings": [
{
"clientRiskFactorMnemonic": "sample string 1",
"riskScore": 2
},
{
"clientRiskFactorMnemonic": "sample string 1",
"riskScore": 2
}
]
}
]
},
{
"clientRiskSectionMnemonic": "sample string 1",
"clientRiskSubsections": [
{
"clientRiskSubSectionMnemonic": "sample string 1",
"clientRiskExtendedMappings": [
{
"clientRiskFactorMnemonic": "sample string 1",
"riskScore": 2
},
{
"clientRiskFactorMnemonic": "sample string 1",
"riskScore": 2
}
]
},
{
"clientRiskSubSectionMnemonic": "sample string 1",
"clientRiskExtendedMappings": [
{
"clientRiskFactorMnemonic": "sample string 1",
"riskScore": 2
},
{
"clientRiskFactorMnemonic": "sample string 1",
"riskScore": 2
}
]
}
]
}
],
"clientRiskHistory": [
{
"overallClientRiskRating": 0,
"overallClientRiskScore": 1,
"cipRiskScore": 2,
"screeningResultsRiskScore": 3,
"modifyDate": "2024-04-11T17:04:59.3757114+00:00"
},
{
"overallClientRiskRating": 0,
"overallClientRiskScore": 1,
"cipRiskScore": 2,
"screeningResultsRiskScore": 3,
"modifyDate": "2024-04-11T17:04:59.3757114+00:00"
}
]
}
}
]
}