Documentation

This method will obtain an array of searches based on the parameters within the method. For example unresolved PEP searches, updated PEP searches, or name filtered searches.

Request Parameters

Parameter	Type	Format	Description
Page Required	Int32		Searches are sorted into pages of 10. This specifies which page to get. You should always start with number 1, and you will receive the maximum page number in the response.
SortOrder	String		How to sort the results. Default sort is "Status". Possible values: Status Status desc Name Name desc Date Date desc
NameSearch	String	Max length 250 characters	The NameSearch parameter used for retrieving previous searches can be handled in 3 different ways: When NameSearchExact is set to false(or not set) then the NameSearch parameter will be used in a Sql CONTAINS Query. The filtered results must contain all of the individual words in the NameSearch parameter. The order of each individual word in the NameSearch parameter or extra white space has no bearing on the results. (unless the next point applies) When NameSearchExact is set to false (or not set) and the NameSearch parameter is encased in single or double quotes it is used to create a Sql LIKE Query. The filtered results must contain this exact NameSearch parameter in any position within the Name property. When NameSearchExact is set to true then the NameSearch parameter will be used in a Sql EQUALS Query. The filtered results must contain the Name property that matches the NameSearch parameter exactly. (Note: you cannot combine this with either points 1 or 2; any characters provided must match exactly)
NameSearchExact	Bool		In combination with NameSearch, if true only returns exact matches.
FilterPepType New	String		Filter the results to the specified type of PEP search. Specify either: "day-one" or "monitor".
FilterType New	String		Filter the results to the specified type of search. Specify either: "entity" or "individual".
FilterReference New	String	Max length 250 characters	Filter the results to those that have a reference that matches the reference specified.
FilterDateFrom New	Nullable DateTime		Filter the results to those that were created after (or equal to) this date (can be combined with FilterDateTo).
FilterDateTo New	Nullable DateTime		Filter the results to those that were created before this date (can be combined with FilterDateFrom).
FilterUserName New	string	Null or max length 50 characters	Filter the results to those that were created by the specified sub user. The main account username can also be provided and it will filter to searches created only by the main account user. This filter allows you to dynamically adjust the results to only those that were created by the specified user account, it can be combined with SubUserName to only show results based on both sub user permissions and who the search was created by. If this is not specified, all searches will be returned.
ListUnresolvedSearches	Bool		If set to true, this will only include searches that are unresolved.
ListUpdatedSearches	Bool		If set to true, this will only include searches that have been affected by a PEP list update. If you set this to true, ListUnresolvedSearches will be set to true regardless of the value you provide.
ListArchivedSearches	Bool		Set to true to list searches that have been archived, if false excludes archived searches (default)
SubUserName New	string	Null or max length 50 characters	Provide a value to only return searches that the specified sub user has permission to access. If this is null or empty, then sub user permissions will not be enforced and all applicable results will be returned.

Response Parameters

Parameter	Type	Format	Description
ResponseStatus	ResponseStatus		Instance of ResponseStatus object (see here)
CurrentPageNum	Int32		The page number of the current response
MaxPageNum	Int32		The maximum page number available for the request
TotalSearchRecords	Int32		The total number of search records
SearchRecords	Array		Array of SearchRecord (PEP) which does not include search results (see here)