POST wrapper/client/get

(SLClientGet) Retrieves the details for a Client Record

Request Information

URI Parameters

None.

Body Parameters

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 ID for the Application where the Client should be saved/accessed. Either the Client Key or combination of the Client ID/Application ID is Required. The Client ID/Application ID will only be used if a Client Key of 0 is provided.	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. Either the Client Key or combination of the Client ID/Application ID is Required. The Client ID/Application ID will only be used if a Client Key of 0 is provided.	string	None.
clientKey	The unique Key within FinScan, used for accessing certain Reports. Either the Client Key or combination of the Client ID/Application ID is Required. The Client Key will be used if a non-zero value is provided.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "organizationName": "sample string 1",
  "userName": "sample string 2",
  "password": "sample string 3",
  "applicationId": "sample string 4",
  "clientId": "sample string 5",
  "clientKey": 6
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LSTServicesClientGetResponse

Name	Description	Type	Additional information
clientKey		integer	None.
clientId		string	None.
enterpriseClientId		string	None.
applicationId		string	None.
applicationDisplayName		string	None.
isOrganizationFlag		SLYesNoEnum	None.
gender		string	None.
version		string	None.
clientStatus		string	None.
modifyDate		date	None.
clientNameAddressLines		Collection of string	None.
clientUserFieldValues		Collection of SLUserField	None.
clientExtendedFieldValues		Collection of SLExtendedField	None.
comment		string	None.
passThrough		string	None.
pairs		Collection of SLPair	None.
documents		Collection of SLClientDocument	None.
networks		Collection of SLClientNetwork	None.
clearProfiles		Collection of SLClearResult	None.
clearHasHistory		SLYesNoEnum	None.
uboLastSearchDate		date	None.
knownIndividual		SLYesNoEnum	None.
status	The Current Status of the Client matches within FinScan [Pass, Pending, Fail, Error or Duplicate].	SLResultTypeEnum	None.
message	String containing information on the Search status/results including Error details.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "status": 0,
  "message": "sample string 1",
  "clientKey": 1,
  "clientId": "sample string 2",
  "enterpriseClientId": "sample string 3",
  "applicationId": "sample string 4",
  "applicationDisplayName": "sample string 5",
  "isOrganizationFlag": 0,
  "gender": "sample string 6",
  "version": "sample string 7",
  "clientStatus": "sample string 8",
  "modifyDate": "2024-04-11T13:07:18.6256743+00:00",
  "clientNameAddressLines": [
    "sample string 1",
    "sample string 2"
  ],
  "clientUserFieldValues": [
    {
      "fieldName": 0,
      "userLabel": "sample string 1",
      "isStringFlag": 0,
      "stringValue": "sample string 2",
      "dateValue": "2024-04-11T13:07:18.6256743+00:00",
      "readOnlyFlag": 0,
      "countryFlag": 0,
      "validCountryFlag": 0
    },
    {
      "fieldName": 0,
      "userLabel": "sample string 1",
      "isStringFlag": 0,
      "stringValue": "sample string 2",
      "dateValue": "2024-04-11T13:07:18.6256743+00:00",
      "readOnlyFlag": 0,
      "countryFlag": 0,
      "validCountryFlag": 0
    }
  ],
  "clientExtendedFieldValues": [
    {
      "userLabel": "sample string 1",
      "fieldValues": [
        "sample string 1",
        "sample string 2"
      ],
      "readOnlyFlag": 0
    },
    {
      "userLabel": "sample string 1",
      "fieldValues": [
        "sample string 1",
        "sample string 2"
      ],
      "readOnlyFlag": 0
    }
  ],
  "comment": "sample string 10",
  "passThrough": "sample string 11",
  "pairs": [
    {
      "applicationId": "sample string 1",
      "applicationDisplayName": "sample string 2",
      "clientId": "sample string 3",
      "clientKey": 4,
      "clientFullName": "sample string 5",
      "clientRiskRating": 0,
      "listKey": 6,
      "listName": "sample string 7",
      "listId": "sample string 8",
      "listVersion": "sample string 9",
      "listModifyDate": "2024-04-11T13:07:18.6256743+00:00",
      "listProfileId": "sample string 11",
      "listProfileKey": 12,
      "linkSingleStringName": "sample string 13",
      "listParentSingleStringName": "sample string 14",
      "listCategory": "sample string 15",
      "listPEPCategory": "sample string 16",
      "listDOBs": "sample string 17",
      "listCountries": "sample string 18",
      "listSingleStringType": "sample string 19",
      "listGender": "sample string 20",
      "listAliases": "sample string 21",
      "listCitizenships": "sample string 22",
      "listNationalIds": "sample string 23",
      "listPassports": "sample string 24",
      "fnsCategories": "sample string 25",
      "rankScore": 26.1,
      "rankString": "sample string 27",
      "rankType": 0,
      "rankWeight": "sample string 28",
      "rankLabel1": "sample string 29",
      "rankLabel2": "sample string 30",
      "rankLabel3": "sample string 31",
      "rankLabel4": "sample string 32",
      "rankLabel5": "sample string 33",
      "rankLabel6": "sample string 34",
      "rankLabel7": "sample string 35",
      "rankLabel8": "sample string 36",
      "rankLabel9": "sample string 37",
      "rankLabel10": "sample string 38",
      "rankLabel11": "sample string 39",
      "rankLabel12": "sample string 40",
      "rankLabel13": "sample string 41",
      "pairStatus": "sample string 42",
      "pairReason": "sample string 43",
      "pairComments": "sample string 44",
      "pairLoadDate": "2024-04-11T13:07:18.6462495+00:00",
      "eAddressTo": "sample string 46",
      "eAddressCC": "sample string 47",
      "origin": 0,
      "secondsViewed": 48,
      "initialUser": "sample string 49",
      "isPairParent": 0,
      "pairReportType": 0,
      "pairMetSearchCriteria": 0,
      "editableDueToAssignment": 0,
      "lockedByDifferentUser": 0,
      "modifyDate": "2024-04-11T13:07:18.6462495+00:00",
      "modifiedByUser": "sample string 51"
    },
    {
      "applicationId": "sample string 1",
      "applicationDisplayName": "sample string 2",
      "clientId": "sample string 3",
      "clientKey": 4,
      "clientFullName": "sample string 5",
      "clientRiskRating": 0,
      "listKey": 6,
      "listName": "sample string 7",
      "listId": "sample string 8",
      "listVersion": "sample string 9",
      "listModifyDate": "2024-04-11T13:07:18.6256743+00:00",
      "listProfileId": "sample string 11",
      "listProfileKey": 12,
      "linkSingleStringName": "sample string 13",
      "listParentSingleStringName": "sample string 14",
      "listCategory": "sample string 15",
      "listPEPCategory": "sample string 16",
      "listDOBs": "sample string 17",
      "listCountries": "sample string 18",
      "listSingleStringType": "sample string 19",
      "listGender": "sample string 20",
      "listAliases": "sample string 21",
      "listCitizenships": "sample string 22",
      "listNationalIds": "sample string 23",
      "listPassports": "sample string 24",
      "fnsCategories": "sample string 25",
      "rankScore": 26.1,
      "rankString": "sample string 27",
      "rankType": 0,
      "rankWeight": "sample string 28",
      "rankLabel1": "sample string 29",
      "rankLabel2": "sample string 30",
      "rankLabel3": "sample string 31",
      "rankLabel4": "sample string 32",
      "rankLabel5": "sample string 33",
      "rankLabel6": "sample string 34",
      "rankLabel7": "sample string 35",
      "rankLabel8": "sample string 36",
      "rankLabel9": "sample string 37",
      "rankLabel10": "sample string 38",
      "rankLabel11": "sample string 39",
      "rankLabel12": "sample string 40",
      "rankLabel13": "sample string 41",
      "pairStatus": "sample string 42",
      "pairReason": "sample string 43",
      "pairComments": "sample string 44",
      "pairLoadDate": "2024-04-11T13:07:18.6462495+00:00",
      "eAddressTo": "sample string 46",
      "eAddressCC": "sample string 47",
      "origin": 0,
      "secondsViewed": 48,
      "initialUser": "sample string 49",
      "isPairParent": 0,
      "pairReportType": 0,
      "pairMetSearchCriteria": 0,
      "editableDueToAssignment": 0,
      "lockedByDifferentUser": 0,
      "modifyDate": "2024-04-11T13:07:18.6462495+00:00",
      "modifiedByUser": "sample string 51"
    }
  ],
  "documents": [
    {
      "documentKey": 1,
      "documentName": "sample string 2",
      "documentCategory": "sample string 3",
      "description": "sample string 4",
      "fullyQualifiedFileNameURL": "sample string 5",
      "isURL": 0,
      "isIDCDocument": 0,
      "mimeType": "sample string 6",
      "documentExtension": "sample string 7",
      "listProfileId": "sample string 8",
      "listProfileKey": 9,
      "modifyDate": "2024-04-11T13:07:18.656894+00:00",
      "modifyUser": "sample string 11"
    },
    {
      "documentKey": 1,
      "documentName": "sample string 2",
      "documentCategory": "sample string 3",
      "description": "sample string 4",
      "fullyQualifiedFileNameURL": "sample string 5",
      "isURL": 0,
      "isIDCDocument": 0,
      "mimeType": "sample string 6",
      "documentExtension": "sample string 7",
      "listProfileId": "sample string 8",
      "listProfileKey": 9,
      "modifyDate": "2024-04-11T13:07:18.656894+00:00",
      "modifyUser": "sample string 11"
    }
  ],
  "networks": [
    {
      "networkKey": 1,
      "networkTypeCD": "sample string 2",
      "networkTypeMnemonic": "sample string 3",
      "networkOwner": "sample string 4",
      "myRelationship": "sample string 5"
    },
    {
      "networkKey": 1,
      "networkTypeCD": "sample string 2",
      "networkTypeMnemonic": "sample string 3",
      "networkOwner": "sample string 4",
      "myRelationship": "sample string 5"
    }
  ],
  "clearProfiles": [
    {
      "dominantFields": "sample string 1",
      "fullName": "sample string 2",
      "retrievalDate": "2024-04-11T13:07:18.656894+00:00",
      "clearProfileKey": 4,
      "entityIdExists": 0
    },
    {
      "dominantFields": "sample string 1",
      "fullName": "sample string 2",
      "retrievalDate": "2024-04-11T13:07:18.656894+00:00",
      "clearProfileKey": 4,
      "entityIdExists": 0
    }
  ],
  "clearHasHistory": 0,
  "uboLastSearchDate": "2024-04-11T13:07:18.656894+00:00",
  "knownIndividual": 0
}