Sanctions Search API: v1

GetCompanySearch

Sanctions

The following routes are available for this service:
POST	/sanctions/entity/get	Create a get a sanctions search for an entity	This will get a new sanctions search for an entity, such as a company, vessel, organisation, or group.

**GetCompanySearch** Parameters:
Name	Parameter	Data Type	Required	Description
Authentication	body	Authentication	No
Id	body	long	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

**GetCompanySearchResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	GetCompanySearchData	No

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

**SearchRecord** 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
SearchResults	form	SearchResults	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

**SearchResults** Parameters:
Name	Parameter	Data Type	Required	Description
HMTResults	form	List<SearchResultHmTreasury>	No
OfacResults	form	List<SearchResultOfac>	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

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/entity/get HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Authentication":{"ApiUserId":"String","ApiUserKey":"String"},"Id":0}

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"}]},"SearchRecord":{"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"},"SearchResults":{"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"}],"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"}]}]}}}}