Sanctions Search API: v2

GetSearch

Sanctions

The following routes are available for this service:
POST	/sanctions/get	Get a sanctions search

**GetSearch** Parameters:
Name	Parameter	Data Type	Required	Description
Request	body	GetSearchRequest	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. Can be provided in the request body, or as a header parameter (X-Api-User)
ApiUserKey	header, body	string	Yes	The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)
UserId	header, body	string	No	The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).

**GetSearchRequest** Parameters:
Name	Parameter	Data Type	Required	Description
SubUserName	form	string	No	If the search is being accessed by a sub user, specify their username here to validate they have permissions to view it
OnlyShowUnresolvedResults	form	bool	No	If set to true, the response will exclude resolved search results, it will only include unresolved results
Id	form	long	No

**GetSearchResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	GetSearchData	No

**GetSearchData** Parameters:
Name	Parameter	Data Type	Required	Description
LinkedTo	form	ArrayOfLinkedTo	No
SearchRecord	form	SearchRecord	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

**LinkedTo** Parameters:
Name	Parameter	Data Type	Required
ClientId	form	int?	No
Id	form	long?	No
Type	form	string	No
Subtype	form	string	No
Status	form	string	No
Description	form	string	No
IsArchived	form	bool?	No
Name	form	string	No
Date	form	DateTime?	No

**SearchRecord** 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
SearchResults	form	SearchResults	No
SearchSources	form	List<SearchSource>	No
ListSearchResults	form	ArrayOfSearchResultEntries	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

**SearchResults** Parameters:
Name	Parameter	Data Type	Required
EuResults	form	List<SearchResultEu>	No
HMTResults	form	List<SearchResultHmTreasury>	No
HMTUkraineResults	form	List<SearchResultHmTreasury>	No
OfacResults	form	List<SearchResultOfac>	No
OfacConsolidatedResults	form	List<SearchResultOfac>	No
DfatResults	form	List<SearchResultDfat>	No
OsfiResults	form	List<SearchResultOsfi>	No
CanadianJusticeResults	form	List<SearchResultCanadianJustice>	No
CanadianSemaResults	form	List<SearchResultCanadianSema>	No
SwissSecoResults	form	List<SearchResultEntry>	No

**SearchResultEu** Parameters:
Name	Parameter	Data Type	Required
ResultStrength	form	int	No
ResultSimilarity	form	decimal	No
ResultResolved	form	bool	No
ResultType	form	string	No
DateUpdated	form	DateTime	No
Addresses	form	List<SearchResultEuAddress>	No
Births	form	List<SearchResultEuBirth>	No
Citizenships	form	List<SearchResultOfacEuCitizenship>	No
Names	form	List<SearchResultEuName>	No
Passports	form	List<SearchResultEuPassport>	No

**SearchResultEuAddress** Parameters:
Name	Parameter	Data Type	Required
Street	form	string	No
City	form	string	No
Country	form	string	No
PostCode	form	string	No
Other	form	string	No

**SearchResultEuBirth** Parameters:
Name	Parameter	Data Type	Required
Date	form	string	No
Place	form	string	No
Country	form	string	No

**SearchResultOfacEuCitizenship** Parameters:
Name	Parameter	Data Type	Required	Description
Country	form	string	No

**SearchResultEuName** Parameters:
Name	Parameter	Data Type	Required	Description
FullName	form	string	No
Gender	form	string	No

**SearchResultEuPassport** Parameters:
Name	Parameter	Data Type	Required	Description
Number	form	string	No
Country	form	string	No

**SearchResultHmTreasury** Parameters:
Name	Parameter	Data Type	Required
ResultStrength	form	int	No
ResultSimilarity	form	decimal	No
ResultResolved	form	bool	No
ResultType	form	string	No
DateListed	form	DateTime	No
DateUpdated	form	DateTime	No
Name1	form	string	No
Name2	form	string	No
Name3	form	string	No
Name4	form	string	No
Name5	form	string	No
Name6	form	string	No
DateOfBirth	form	string	No
CountryOfBirth	form	string	No
Nationality	form	string	No
Address1	form	string	No
Address2	form	string	No
Address3	form	string	No
Address4	form	string	No
Address5	form	string	No
Address6	form	string	No
PostCode	form	string	No
Country	form	string	No

**SearchResultOfac** Parameters:
Name	Parameter	Data Type	Required
ResultStrength	form	int	No
ResultSimilarity	form	decimal	No
ResultResolved	form	bool	No
ResultType	form	string	No
DateUpdated	form	DateTime	No
FirstName	form	string	No
LastName	form	string	No
Addresses	form	List<SearchResultOfacAddress>	No
Akas	form	List<SearchResultOfacAka>	No
DateOfBirths	form	List<SearchResultOfacDateOfBirth>	No
Nationalities	form	List<SearchResultOfacNationality>	No
PlaceOfBirths	form	List<SearchResultOfacPlaceOfBirth>	No

**SearchResultOfacAddress** Parameters:
Name	Parameter	Data Type	Required
Address1	form	string	No
Address2	form	string	No
Address3	form	string	No
City	form	string	No
State	form	string	No
PostCode	form	string	No
Country	form	string	No

**SearchResultOfacAka** Parameters:
Name	Parameter	Data Type	Required
FirstName	form	string	No
LastName	form	string	No
Type	form	string	No
Strength	form	string	No

**SearchResultOfacDateOfBirth** Parameters:
Name	Parameter	Data Type	Required	Description
DateOfBirth	form	string	No

**SearchResultOfacNationality** Parameters:
Name	Parameter	Data Type	Required	Description
Country	form	string	No

**SearchResultOfacPlaceOfBirth** Parameters:
Name	Parameter	Data Type	Required	Description
PlaceOfBirth	form	string	No

**SearchResultDfat** Parameters:
Name	Parameter	Data Type	Required
ResultStrength	form	int	No
ResultSimilarity	form	decimal	No
ResultResolved	form	bool	No
ResultType	form	string	No
DateUpdated	form	DateTime	No
FullName	form	string	No
Address	form	string	No
DateOfBirth	form	string	No
PlaceOfBirth	form	string	No
Nationality	form	string	No

**SearchResultOsfi** Parameters:
Name	Parameter	Data Type	Required
ResultStrength	form	int	No
ResultSimilarity	form	decimal	No
ResultResolved	form	bool	No
ResultType	form	string	No
DateUpdated	form	DateTime	No
FullName	form	string	No
Address	form	string	No
DateOfBirth	form	string	No
PlaceOfBirth	form	string	No
Nationality	form	string	No

**SearchResultCanadianJustice** Parameters:
Name	Parameter	Data Type	Required
ResultStrength	form	int	No
ResultSimilarity	form	decimal	No
ResultResolved	form	bool	No
ResultType	form	string	No
DateUpdated	form	DateTime	No
Name	form	string	No
DateOfBirth	form	string	No
Country	form	string	No
RefId	form	int	No

**SearchResultCanadianSema** Parameters:
Name	Parameter	Data Type	Required
ResultStrength	form	int	No
ResultSimilarity	form	decimal	No
ResultResolved	form	bool	No
ResultType	form	string	No
DateUpdated	form	DateTime	No
Name	form	string	No
DateOfBirth	form	string	No
Country	form	string	No
Schedule	form	string	No
Item	form	string	No

**SearchResultEntry** Parameters:
Name	Parameter	Data Type	Required
SearchResultId	form	long	No
ResultStrength	form	int	No
ResultSimilarity	form	decimal	No
ResultResolved	form	bool	No
ResultType	form	string	No
DateUpdated	form	DateTime?	No
SanctionsListId	form	string	No
SanctionsListName	form	string	No
Addresses	form	List<SearchResultAddress>	No
DatesOfBirth	form	List<SearchResultDateOfBirth>	No
Names	form	List<SearchResultName>	No
Nationalities	form	List<SearchResultNationality>	No
PlacesOfBirth	form	List<SearchResultPlaceOfBirth>	No
Remarks	form	List<SearchResultRemark>	No

**SearchResultAddress** Parameters:
Name	Parameter	Data Type	Required
SearchResultAddressId	form	long	No
Type	form	string	No
Address1	form	string	No
Address2	form	string	No
Address3	form	string	No
City	form	string	No
County	form	string	No
PostCode	form	string	No
Country	form	string	No

**SearchResultDateOfBirth** Parameters:
Name	Parameter	Data Type	Required
SearchResultDateOfBirthId	form	long	No
DateOfBirth	form	string	No
Year	form	short?	No
Month	form	byte?	No
Day	form	byte?	No
Type	form	string	No

**SearchResultName** Parameters:
Name	Parameter	Data Type	Required
SearchResultNameId	form	long	No
Type	form	string	No
Title	form	string	No
FullName	form	string	No
ResultSimilarity	form	decimal	No

**SearchResultNationality** Parameters:
Name	Parameter	Data Type	Required	Description
SearchResultNationalityId	form	long	No
Nationality	form	string	No

**SearchResultPlaceOfBirth** Parameters:
Name	Parameter	Data Type	Required
SearchResultPlaceOfBirthId	form	long	No
PlaceOfBirth	form	string	No
CountryOfBirth	form	string	No

**SearchResultRemark** Parameters:
Name	Parameter	Data Type	Required
SearchResultRemarkId	form	long	No
Name	form	string	No
Description	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/get HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"subUserName":"String","onlyShowUnresolvedResults":false,"id":0},"authentication":{"apiUserId":"String","apiUserKey":"String","userId":"String"}}

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

{"data":{"linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}],"searchRecord":{"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"},"searchResults":{"euResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","addresses":[{"street":"String","city":"String","country":"String","postCode":"String","other":"String"}],"births":[{"date":"String","place":"String","country":"String"}],"citizenships":[{"country":"String"}],"names":[{"fullName":"String","gender":"String"}],"passports":[{"number":"String","country":"String"}]}],"hmtResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateListed":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","name1":"String","name2":"String","name3":"String","name4":"String","name5":"String","name6":"String","dateOfBirth":"String","countryOfBirth":"String","nationality":"String","address1":"String","address2":"String","address3":"String","address4":"String","address5":"String","address6":"String","postCode":"String","country":"String"}],"hmtUkraineResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateListed":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","name1":"String","name2":"String","name3":"String","name4":"String","name5":"String","name6":"String","dateOfBirth":"String","countryOfBirth":"String","nationality":"String","address1":"String","address2":"String","address3":"String","address4":"String","address5":"String","address6":"String","postCode":"String","country":"String"}],"ofacResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","firstName":"String","lastName":"String","addresses":[{"address1":"String","address2":"String","address3":"String","city":"String","state":"String","postCode":"String","country":"String"}],"akas":[{"firstName":"String","lastName":"String","type":"String","strength":"String"}],"dateOfBirths":[{"dateOfBirth":"String"}],"nationalities":[{"country":"String"}],"placeOfBirths":[{"placeOfBirth":"String"}]}],"ofacConsolidatedResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","firstName":"String","lastName":"String","addresses":[{"address1":"String","address2":"String","address3":"String","city":"String","state":"String","postCode":"String","country":"String"}],"akas":[{"firstName":"String","lastName":"String","type":"String","strength":"String"}],"dateOfBirths":[{"dateOfBirth":"String"}],"nationalities":[{"country":"String"}],"placeOfBirths":[{"placeOfBirth":"String"}]}],"dfatResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","fullName":"String","address":"String","dateOfBirth":"String","placeOfBirth":"String","nationality":"String"}],"osfiResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","fullName":"String","address":"String","dateOfBirth":"String","placeOfBirth":"String","nationality":"String"}],"canadianJusticeResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","name":"String","dateOfBirth":"String","country":"String","refId":0}],"canadianSemaResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","name":"String","dateOfBirth":"String","country":"String","schedule":"String","item":"String"}],"swissSecoResults":[{"searchResultId":0,"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","sanctionsListId":"String","sanctionsListName":"String","addresses":[{"searchResultAddressId":0,"type":"String","address1":"String","address2":"String","address3":"String","city":"String","county":"String","postCode":"String","country":"String"}],"datesOfBirth":[{"searchResultDateOfBirthId":0,"dateOfBirth":"String","year":0,"month":0,"day":0,"type":"String"}],"names":[{"searchResultNameId":0,"type":"String","title":"String","fullName":"String","resultSimilarity":0}],"nationalities":[{"searchResultNationalityId":0,"nationality":"String"}],"placesOfBirth":[{"searchResultPlaceOfBirthId":0,"placeOfBirth":"String","countryOfBirth":"String"}],"remarks":[{"searchResultRemarkId":0,"name":"String","description":"String"}]}]},"searchSources":[{"listId":"String","listName":"String","listShortName":"String","isAffectedByListUpdate":false}],"listSearchResults":[{"searchResultId":0,"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","sanctionsListId":"String","sanctionsListName":"String","addresses":[{"searchResultAddressId":0,"type":"String","address1":"String","address2":"String","address3":"String","city":"String","county":"String","postCode":"String","country":"String"}],"datesOfBirth":[{"searchResultDateOfBirthId":0,"dateOfBirth":"String","year":0,"month":0,"day":0,"type":"String"}],"names":[{"searchResultNameId":0,"type":"String","title":"String","fullName":"String","resultSimilarity":0}],"nationalities":[{"searchResultNationalityId":0,"nationality":"String"}],"placesOfBirth":[{"searchResultPlaceOfBirthId":0,"placeOfBirth":"String","countryOfBirth":"String"}],"remarks":[{"searchResultRemarkId":0,"name":"String","description":"String"}]}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}