Sanctions Search API: v2

GetSearches

Sanctions

The following routes are available for this service:
POST	/sanctions/list	Get all sanctions searches

**GetSearches** Parameters:
Name	Parameter	Data Type	Required	Description
Request	body	GetSearchesRequest	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Authentication	header, body	Authentication	Yes	The authentication credentials

**Authentication** Parameters:
Name	Parameter	Data Type	Required	Description
ApiUserId	header, body	string	Yes	The API User ID provided by us when you signed up to use our API
ApiUserKey	header, body	string	Yes	The API User Key provided by us when you signed up to use our API

**GetSearchesRequest** Parameters:
Name	Parameter	Data Type	Required	Description
SubUserName	form	string	No	If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view
ListUnresolvedSearches	form	bool?	No
ListUpdatedSearches	form	bool?	No
ListArchivedSearches	form	bool	No
Page	form	int	No
SortOrder	form	string	No
NameSearch	form	string	No
NameSearchExact	form	bool	No
FilterReference	form	string	No
FilterType	form	string	No
FilterDateFrom	form	DateTime?	No
FilterDateTo	form	DateTime?	No
FilterUserName	form	string	No	If set, will only return searches created by the user
IncludeSearchSourcesFull	form	bool	No

**GetSearchesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	GetSearchesData	No

**GetSearchesData** Parameters:
Name	Parameter	Data Type	Required
TotalSearchRecords	form	int	No
CurrentPageNum	form	int	No
MaxPageNum	form	int	No
SearchRecords	form	ArrayOfSearchListItem	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No	The status of the response

**ResponseStatus** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StackTrace	form	string	No
Errors	form	ArrayOfResponseError	No
Meta	form	Dictionary<string, string>	No

**ResponseError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
FieldName	form	string	No
Message	form	string	No
Meta	form	Dictionary<string, string>	No

**SearchListItem** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
SearchType	form	string	No
DateSearched	form	DateTime	No
DateUpdated	form	DateTime	No
DateArchived	form	DateTime?	No
IsArchived	form	bool	No
NumOfResults	form	int	No
ClientInResults	form	bool	No
ClientNotInResults	form	bool	No
AffectedByUpdate	form	bool	No
SearchCriteria	form	SearchCriteria	No
SearchSources	form	List<SearchSource>	No

**SearchCriteria** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Address	form	string	No
Country	form	string	No
DateOfBirth	form	string	No
Nationality	form	string	No
Reference	form	string	No

**SearchSource** Parameters:
Name	Parameter	Data Type	Required
ListId	form	string	No
ListName	form	string	No
ListShortName	form	string	No
IsAffectedByListUpdate	form	bool?	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /sanctions/list HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"subUserName":"String","listUnresolvedSearches":false,"listUpdatedSearches":false,"listArchivedSearches":false,"page":0,"sortOrder":"String","nameSearch":"String","nameSearchExact":false,"filterReference":"String","filterType":"String","filterDateFrom":"\/Date(-62135596800000-0000)\/","filterDateTo":"\/Date(-62135596800000-0000)\/","filterUserName":"String","includeSearchSourcesFull":false},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"data":{"totalSearchRecords":0,"currentPageNum":0,"maxPageNum":0,"searchRecords":[{"id":0,"searchType":"String","dateSearched":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","dateArchived":"\/Date(-62135596800000-0000)\/","isArchived":false,"numOfResults":0,"clientInResults":false,"clientNotInResults":false,"affectedByUpdate":false,"searchCriteria":{"name":"String","address":"String","country":"String","dateOfBirth":"String","nationality":"String","reference":"String"},"searchSources":[{"listId":"String","listName":"String","listShortName":"String","isAffectedByListUpdate":false}]}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}