| Get a PEP search |
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 Authentication:
# @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
api_user_id: Optional[str] = None
"""
The API User ID provided by us when you signed up to use our API
"""
# @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
api_user_key: Optional[str] = None
"""
The API User Key provided by us when you signed up to use our API
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseRequest(IBaseRequest):
# @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
authentication: Optional[Authentication] = None
"""
The authentication credentials
"""
@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
meta: Optional[Dict[str, 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
meta: Optional[Dict[str, str]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse(IBaseDataResponse, IHasResponseStatus):
# @ApiMember(Description="The status of the response")
response_status: Optional[ResponseStatus] = None
"""
The status of the response
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LinkedTo:
client_id: Optional[int] = None
id: Optional[int] = None
type: Optional[str] = None
subtype: Optional[str] = None
status: Optional[str] = None
description: Optional[str] = None
is_archived: Optional[bool] = None
name: Optional[str] = None
date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArrayOfLinkedTo(List[LinkedTo]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchCriteria:
name: Optional[str] = None
address: Optional[str] = None
country: Optional[str] = None
date_of_birth: Optional[str] = None
nationality: Optional[str] = None
reference: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PepSearchResultAddress:
address_line1: Optional[str] = None
address_line2: Optional[str] = None
address_line3: Optional[str] = None
address_line4: Optional[str] = None
town: Optional[str] = None
county: Optional[str] = None
post_code: Optional[str] = None
country: Optional[str] = None
iso_country: Optional[str] = None
soft_delete: Optional[bool] = None
date_last_updated: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PepSearchResultAlias:
forename: Optional[str] = None
middle_name: Optional[str] = None
surname: Optional[str] = None
soft_delete: Optional[bool] = None
date_of_soft_delete: Optional[datetime.datetime] = None
date_last_updated: datetime.datetime = datetime.datetime(1, 1, 1)
title: Optional[str] = None
alternate_title: Optional[str] = None
business_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PepSearchResultArticleSnippet:
title: Optional[str] = None
text: Optional[str] = None
adverse_terms: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PepSearchResultArticle:
url: Optional[str] = None
original_url: Optional[str] = None
source: Optional[str] = None
date_of_capture: Optional[datetime.datetime] = None
date_last_updated: datetime.datetime = datetime.datetime(1, 1, 1)
snippets: Optional[List[PepSearchResultArticleSnippet]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PepSearchResultIndividualAssociation:
link_description: Optional[str] = None
soft_delete: Optional[bool] = None
date_last_updated: datetime.datetime = datetime.datetime(1, 1, 1)
full_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PepSearchResultBusinessAssociation:
link_description: Optional[str] = None
soft_delete: Optional[bool] = None
date_last_updated: datetime.datetime = datetime.datetime(1, 1, 1)
business_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PepSearchResultNote:
source: Optional[str] = None
notes: Optional[str] = None
soft_delete: Optional[bool] = None
date_last_updated: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PepSearchResultPoliticalPosition:
description: Optional[str] = None
from_: Optional[str] = field(metadata=config(field_name='from'), default=None)
to: Optional[str] = None
country: Optional[str] = None
soft_delete: Optional[bool] = None
date_last_updated: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PepSearchResult:
result_similarity: Decimal = decimal.Decimal(0)
result_resolved: bool = False
date_last_updated: datetime.datetime = datetime.datetime(1, 1, 1)
result_is_client: bool = False
id: int = 0
type: Optional[str] = None
title: Optional[str] = None
forename: Optional[str] = None
middlename: Optional[str] = None
surname: Optional[str] = None
soft_delete: Optional[bool] = None
date_of_soft_delete: Optional[datetime.datetime] = None
date_of_capture: Optional[datetime.datetime] = None
date_of_birth: Optional[datetime.datetime] = None
date_of_death: Optional[datetime.datetime] = None
year_of_birth: Optional[int] = None
year_of_death: Optional[int] = None
gender: Optional[str] = None
home_telephone: Optional[str] = None
business_telephone: Optional[str] = None
mobile_telephone: Optional[str] = None
fax: Optional[str] = None
email: Optional[str] = None
nationality: Optional[str] = None
source: Optional[str] = None
category: Optional[str] = None
picture: Optional[str] = None
alternate_title: Optional[str] = None
business_name: Optional[str] = None
description: Optional[str] = None
telephone: Optional[str] = None
website: Optional[str] = None
pep_tier: Optional[int] = None
addresses: Optional[List[PepSearchResultAddress]] = None
aliases: Optional[List[PepSearchResultAlias]] = None
articles: Optional[List[PepSearchResultArticle]] = None
associations: Optional[List[PepSearchResultIndividualAssociation]] = None
business_associations: Optional[List[PepSearchResultBusinessAssociation]] = None
notes: Optional[List[PepSearchResultNote]] = None
political_positions: Optional[List[PepSearchResultPoliticalPosition]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PepSearchResults:
results: Optional[List[PepSearchResult]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PepSearchRecord:
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)
date_renewal: Optional[datetime.datetime] = None
date_archived: Optional[datetime.datetime] = None
is_archived: bool = False
num_of_results: int = 0
client_in_results: bool = False
client_not_in_results: bool = False
affected_by_update: bool = False
is_day_one_search: bool = False
search_criteria: Optional[SearchCriteria] = None
search_results: Optional[PepSearchResults] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPepSearchData(BaseResponse, IBaseSearchResponse):
linked_to: Optional[ArrayOfLinkedTo] = None
search_record: Optional[PepSearchRecord] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPepSearchResponse:
data: Optional[GetPepSearchData] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPepSearchRequest:
# @ApiMember(Description="If the search was created against a single Sub User account, specify their username here")
sub_user_name: Optional[str] = None
"""
If the search was created against a single Sub User account, specify their username here
"""
# @ApiMember(Description="If set to true, the response will exclude resolved search results, it will only include unresolved results")
only_show_unresolved_results: bool = False
"""
If set to true, the response will exclude resolved search results, it will only include unresolved results
"""
id: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPepSearch(BaseRequest):
request: Optional[GetPepSearchRequest] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap12 suffix or ?format=soap12
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap12 HTTP/1.1
Host: api.sanctionssearch.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetPepSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request>
<Id>0</Id>
<OnlyShowUnresolvedResults>false</OnlyShowUnresolvedResults>
<SubUserName>String</SubUserName>
</Request>
</GetPepSearch>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetPepSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Data>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
<LinkedTo>
<LinkedTo>
<ClientId>0</ClientId>
<Date>0001-01-01T00:00:00</Date>
<Description>String</Description>
<Id>0</Id>
<IsArchived>false</IsArchived>
<Name>String</Name>
<Status>String</Status>
<Subtype>String</Subtype>
<Type>String</Type>
</LinkedTo>
</LinkedTo>
<SearchRecord>
<AffectedByUpdate>false</AffectedByUpdate>
<ClientInResults>false</ClientInResults>
<ClientNotInResults>false</ClientNotInResults>
<DateArchived>0001-01-01T00:00:00</DateArchived>
<DateRenewal>0001-01-01T00:00:00</DateRenewal>
<DateSearched>0001-01-01T00:00:00</DateSearched>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<Id>0</Id>
<IsArchived>false</IsArchived>
<IsDayOneSearch>false</IsDayOneSearch>
<NumOfResults>0</NumOfResults>
<SearchCriteria>
<Address>String</Address>
<Country>String</Country>
<DateOfBirth>String</DateOfBirth>
<Name>String</Name>
<Nationality>String</Nationality>
<Reference>String</Reference>
</SearchCriteria>
<SearchResults>
<Results>
<PepSearchResult>
<Addresses>
<PepSearchResultAddress>
<AddressLine1>String</AddressLine1>
<AddressLine2>String</AddressLine2>
<AddressLine3>String</AddressLine3>
<AddressLine4>String</AddressLine4>
<Country>String</Country>
<County>String</County>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<ISOCountry>String</ISOCountry>
<PostCode>String</PostCode>
<SoftDelete>false</SoftDelete>
<Town>String</Town>
</PepSearchResultAddress>
</Addresses>
<Aliases>
<PepSearchResultAlias>
<AlternateTitle>String</AlternateTitle>
<BusinessName>String</BusinessName>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<DateOfSoftDelete>0001-01-01T00:00:00</DateOfSoftDelete>
<Forename>String</Forename>
<MiddleName>String</MiddleName>
<SoftDelete>false</SoftDelete>
<Surname>String</Surname>
<Title>String</Title>
</PepSearchResultAlias>
</Aliases>
<AlternateTitle>String</AlternateTitle>
<Articles>
<PepSearchResultArticle>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<DateOfCapture>0001-01-01T00:00:00</DateOfCapture>
<OriginalUrl>String</OriginalUrl>
<Snippets>
<PepSearchResultArticleSnippet>
<AdverseTerms>String</AdverseTerms>
<Text>String</Text>
<Title>String</Title>
</PepSearchResultArticleSnippet>
</Snippets>
<Source>String</Source>
<Url>String</Url>
</PepSearchResultArticle>
</Articles>
<Associations>
<PepSearchResultIndividualAssociation>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<FullName>String</FullName>
<LinkDescription>String</LinkDescription>
<SoftDelete>false</SoftDelete>
</PepSearchResultIndividualAssociation>
</Associations>
<BusinessAssociations>
<PepSearchResultBusinessAssociation>
<BusinessName>String</BusinessName>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<LinkDescription>String</LinkDescription>
<SoftDelete>false</SoftDelete>
</PepSearchResultBusinessAssociation>
</BusinessAssociations>
<BusinessName>String</BusinessName>
<BusinessTelephone>String</BusinessTelephone>
<Category>String</Category>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
<DateOfCapture>0001-01-01T00:00:00</DateOfCapture>
<DateOfDeath>0001-01-01T00:00:00</DateOfDeath>
<DateOfSoftDelete>0001-01-01T00:00:00</DateOfSoftDelete>
<Description>String</Description>
<Email>String</Email>
<Fax>String</Fax>
<Forename>String</Forename>
<Gender>String</Gender>
<HomeTelephone>String</HomeTelephone>
<Id>0</Id>
<Middlename>String</Middlename>
<MobileTelephone>String</MobileTelephone>
<Nationality>String</Nationality>
<Notes>
<PepSearchResultNote>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<Notes>String</Notes>
<SoftDelete>false</SoftDelete>
<Source>String</Source>
</PepSearchResultNote>
</Notes>
<PepTier>0</PepTier>
<Picture>String</Picture>
<PoliticalPositions>
<PepSearchResultPoliticalPosition>
<Country>String</Country>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<Description>String</Description>
<From>String</From>
<SoftDelete>false</SoftDelete>
<To>String</To>
</PepSearchResultPoliticalPosition>
</PoliticalPositions>
<ResultIsClient>false</ResultIsClient>
<ResultResolved>false</ResultResolved>
<ResultSimilarity>0</ResultSimilarity>
<SoftDelete>false</SoftDelete>
<Source>String</Source>
<Surname>String</Surname>
<Telephone>String</Telephone>
<Title>String</Title>
<Type>String</Type>
<Website>String</Website>
<YearOfBirth>0</YearOfBirth>
<YearOfDeath>0</YearOfDeath>
</PepSearchResult>
</Results>
</SearchResults>
<SearchType>String</SearchType>
</SearchRecord>
</Data>
</GetPepSearchResponse>
</soap12:Body>
</soap12:Envelope>