Sanctions Search API: v1

GetListSearches

Sanctions

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

**GetListSearches** Parameters:
Name	Parameter	Data Type	Required
Authentication	body	Authentication	No
Page	body	int	No
SortOrder	body	string	No
NameSearch	body	string	No

**Authentication** Parameters:
Name	Parameter	Data Type	Required	Description
ApiUserId	form	string	Yes	The API User ID that will authenticate your request
ApiUserKey	form	string	Yes	The API User Key that will authenticate your request

**GetListSearchesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	GetListSearchesData	No

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

**ResponseStatus** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StackTrace	form	string	No
Errors	form	ArrayOfResponseError	No

**ResponseError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
FieldName	form	string	No
Message	form	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
NumOfResults	form	int	No
ClientInResults	form	bool	No
ClientNotInResults	form	bool	No
AffectedByUpdate	form	bool	No
SearchCriteria	form	SearchCriteria	No

**SearchCriteria** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
DateOfBirth	form	string	No
CountryOfBirth	form	string	No
Nationality	form	string	No
Address	form	string	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 /searches/list HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Authentication":{"ApiUserId":"String","ApiUserKey":"String"},"Page":0,"SortOrder":"String","NameSearch":"String"}

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

{"Data":{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]},"TotalSearchRecords":0,"CurrentPageNum":0,"MaxPageNum":0,"SearchRecords":[{"Id":0,"SearchType":"String","DateSearched":"\/Date(-62135596800000-0000)\/","DateUpdated":"\/Date(-62135596800000-0000)\/","NumOfResults":0,"ClientInResults":false,"ClientNotInResults":false,"AffectedByUpdate":false,"SearchCriteria":{"Name":"String","DateOfBirth":"String","CountryOfBirth":"String","Nationality":"String","Address":"String"}}]}}