| 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. |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResponseError:
error_code: Optional[str] = None
field_name: Optional[str] = None
message: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArrayOfResponseError(List[ResponseError]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResponseStatus:
error_code: Optional[str] = None
message: Optional[str] = None
stack_trace: Optional[str] = None
errors: Optional[ArrayOfResponseError] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchCriteria:
name: Optional[str] = None
date_of_birth: Optional[str] = None
country_of_birth: Optional[str] = None
nationality: Optional[str] = None
address: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchResultHmTreasury:
result_strength: int = 0
result_similarity: Decimal = decimal.Decimal(0)
result_resolved: bool = False
result_type: Optional[str] = None
date_listed: datetime.datetime = datetime.datetime(1, 1, 1)
date_updated: datetime.datetime = datetime.datetime(1, 1, 1)
name1: Optional[str] = None
name2: Optional[str] = None
name3: Optional[str] = None
name4: Optional[str] = None
name5: Optional[str] = None
name6: Optional[str] = None
date_of_birth: Optional[str] = None
country_of_birth: Optional[str] = None
nationality: Optional[str] = None
address1: Optional[str] = None
address2: Optional[str] = None
address3: Optional[str] = None
address4: Optional[str] = None
address5: Optional[str] = None
address6: Optional[str] = None
post_code: Optional[str] = None
country: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchResultOfacAddress:
address1: Optional[str] = None
address2: Optional[str] = None
address3: Optional[str] = None
city: Optional[str] = None
state: Optional[str] = None
post_code: Optional[str] = None
country: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchResultOfacAka:
first_name: Optional[str] = None
last_name: Optional[str] = None
type: Optional[str] = None
strength: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchResultOfacDateOfBirth:
date_of_birth: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchResultOfacNationality:
country: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchResultOfacPlaceOfBirth:
place_of_birth: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchResultOfac:
result_strength: int = 0
result_similarity: Decimal = decimal.Decimal(0)
result_resolved: bool = False
result_type: Optional[str] = None
date_updated: datetime.datetime = datetime.datetime(1, 1, 1)
first_name: Optional[str] = None
last_name: Optional[str] = None
addresses: Optional[List[SearchResultOfacAddress]] = None
akas: Optional[List[SearchResultOfacAka]] = None
date_of_births: Optional[List[SearchResultOfacDateOfBirth]] = None
nationalities: Optional[List[SearchResultOfacNationality]] = None
place_of_births: Optional[List[SearchResultOfacPlaceOfBirth]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchResults:
hmt_results: Optional[List[SearchResultHmTreasury]] = None
ofac_results: Optional[List[SearchResultOfac]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchRecord:
id: int = 0
search_type: Optional[str] = None
date_searched: datetime.datetime = datetime.datetime(1, 1, 1)
date_updated: datetime.datetime = datetime.datetime(1, 1, 1)
num_of_results: int = 0
client_in_results: bool = False
client_not_in_results: bool = False
affected_by_update: bool = False
search_criteria: Optional[SearchCriteria] = None
search_results: Optional[SearchResults] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCompanySearchData(IBaseDataResponse, IHasResponseStatus):
response_status: Optional[ResponseStatus] = None
search_record: Optional[SearchRecord] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCompanySearchResponse:
data: Optional[GetCompanySearchData] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Authentication(IAuthentication):
# @ApiMember(DataType="string", Description="The API User ID that will authenticate your request", IsRequired=true)
api_user_id: Optional[str] = None
"""
The API User ID that will authenticate your request
"""
# @ApiMember(DataType="string", Description="The API User Key that will authenticate your request", IsRequired=true)
api_user_key: Optional[str] = None
"""
The API User Key that will authenticate your request
"""
# @ApiResponse(Description="Your request is successful if the \"<em>Data.ResponseStatus.Message</em>\" field is \"<b>Success</b>\".", StatusCode=200)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCompanySearch(IBaseRequest):
authentication: Optional[Authentication] = None
id: int = 0
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
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"}]}]}}}}