| Get a PEP search |
// @DataContract
export class Authentication
{
/** @description The API User ID provided by us when you signed up to use our API */
// @DataMember
// @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
public apiUserId: string;
/** @description The API User Key provided by us when you signed up to use our API */
// @DataMember
// @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
public apiUserKey: string;
public constructor(init?: Partial<Authentication>) { (Object as any).assign(this, init); }
}
// @DataContract
export class BaseRequest implements IBaseRequest
{
/** @description The authentication credentials */
// @DataMember
// @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
public authentication: Authentication;
public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}
// @DataContract
export class ResponseError
{
// @DataMember(Order=1)
public errorCode: string;
// @DataMember(Order=2)
public fieldName: string;
// @DataMember(Order=3)
public message: string;
// @DataMember(Order=4)
public meta: { [index: string]: string; };
public constructor(init?: Partial<ResponseError>) { (Object as any).assign(this, init); }
}
export class ArrayOfResponseError extends Array<ResponseError>
{
public constructor(init?: Partial<ArrayOfResponseError>) { super(); (Object as any).assign(this, init); }
}
// @DataContract
export class ResponseStatus
{
// @DataMember(Order=1)
public errorCode: string;
// @DataMember(Order=2)
public message: string;
// @DataMember(Order=3)
public stackTrace: string;
// @DataMember(Order=4)
public errors: ArrayOfResponseError;
// @DataMember(Order=5)
public meta: { [index: string]: string; };
public constructor(init?: Partial<ResponseStatus>) { (Object as any).assign(this, init); }
}
export class BaseResponse implements IBaseDataResponse, IHasResponseStatus
{
/** @description The status of the response */
// @ApiMember(Description="The status of the response")
public responseStatus: ResponseStatus;
public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}
export class LinkedTo
{
public clientId?: number;
public id?: number;
public type?: string;
public subtype?: string;
public status?: string;
public description?: string;
public isArchived?: boolean;
public name?: string;
public date?: string;
public constructor(init?: Partial<LinkedTo>) { (Object as any).assign(this, init); }
}
export class ArrayOfLinkedTo extends Array<LinkedTo>
{
public constructor(init?: Partial<ArrayOfLinkedTo>) { super(); (Object as any).assign(this, init); }
}
export class SearchCriteria
{
public name: string;
public address: string;
public country: string;
public dateOfBirth: string;
public nationality: string;
public reference: string;
public constructor(init?: Partial<SearchCriteria>) { (Object as any).assign(this, init); }
}
export class PepSearchResultAddress
{
public addressLine1: string;
public addressLine2: string;
public addressLine3: string;
public addressLine4: string;
public town: string;
public county: string;
public postCode: string;
public country: string;
public isoCountry: string;
public softDelete?: boolean;
public dateLastUpdated: string;
public constructor(init?: Partial<PepSearchResultAddress>) { (Object as any).assign(this, init); }
}
export class PepSearchResultAlias
{
public forename: string;
public middleName: string;
public surname: string;
public softDelete?: boolean;
public dateOfSoftDelete?: string;
public dateLastUpdated: string;
public title: string;
public alternateTitle: string;
public businessName: string;
public constructor(init?: Partial<PepSearchResultAlias>) { (Object as any).assign(this, init); }
}
export class PepSearchResultArticleSnippet
{
public title: string;
public text: string;
public adverseTerms: string;
public constructor(init?: Partial<PepSearchResultArticleSnippet>) { (Object as any).assign(this, init); }
}
export class PepSearchResultArticle
{
public url: string;
public originalUrl: string;
public source: string;
public dateOfCapture?: string;
public dateLastUpdated: string;
public snippets: PepSearchResultArticleSnippet[];
public constructor(init?: Partial<PepSearchResultArticle>) { (Object as any).assign(this, init); }
}
export class PepSearchResultIndividualAssociation
{
public linkDescription: string;
public softDelete?: boolean;
public dateLastUpdated: string;
public fullName: string;
public constructor(init?: Partial<PepSearchResultIndividualAssociation>) { (Object as any).assign(this, init); }
}
export class PepSearchResultBusinessAssociation
{
public linkDescription: string;
public softDelete?: boolean;
public dateLastUpdated: string;
public businessName: string;
public constructor(init?: Partial<PepSearchResultBusinessAssociation>) { (Object as any).assign(this, init); }
}
export class PepSearchResultNote
{
public source: string;
public notes: string;
public softDelete?: boolean;
public dateLastUpdated: string;
public constructor(init?: Partial<PepSearchResultNote>) { (Object as any).assign(this, init); }
}
export class PepSearchResultPoliticalPosition
{
public description: string;
public from: string;
public to: string;
public country: string;
public softDelete?: boolean;
public dateLastUpdated: string;
public constructor(init?: Partial<PepSearchResultPoliticalPosition>) { (Object as any).assign(this, init); }
}
export class PepSearchResult
{
public resultSimilarity: number;
public resultResolved: boolean;
public dateLastUpdated: string;
public resultIsClient: boolean;
public id: number;
public type: string;
public title: string;
public forename: string;
public middlename: string;
public surname: string;
public softDelete?: boolean;
public dateOfSoftDelete?: string;
public dateOfCapture?: string;
public dateOfBirth?: string;
public dateOfDeath?: string;
public yearOfBirth?: number;
public yearOfDeath?: number;
public gender: string;
public homeTelephone: string;
public businessTelephone: string;
public mobileTelephone: string;
public fax: string;
public email: string;
public nationality: string;
public source: string;
public category: string;
public picture: string;
public alternateTitle: string;
public businessName: string;
public description: string;
public telephone: string;
public website: string;
public pepTier?: number;
public addresses: PepSearchResultAddress[];
public aliases: PepSearchResultAlias[];
public articles: PepSearchResultArticle[];
public associations: PepSearchResultIndividualAssociation[];
public businessAssociations: PepSearchResultBusinessAssociation[];
public notes: PepSearchResultNote[];
public politicalPositions: PepSearchResultPoliticalPosition[];
public constructor(init?: Partial<PepSearchResult>) { (Object as any).assign(this, init); }
}
export class PepSearchResults
{
public results: PepSearchResult[];
public constructor(init?: Partial<PepSearchResults>) { (Object as any).assign(this, init); }
}
export class PepSearchRecord
{
public id: number;
public searchType: string;
public dateSearched: string;
public dateUpdated: string;
public dateRenewal?: string;
public dateArchived?: string;
public isArchived: boolean;
public numOfResults: number;
public clientInResults: boolean;
public clientNotInResults: boolean;
public affectedByUpdate: boolean;
public isDayOneSearch: boolean;
public searchCriteria: SearchCriteria;
public searchResults: PepSearchResults;
public constructor(init?: Partial<PepSearchRecord>) { (Object as any).assign(this, init); }
}
export class GetPepSearchData extends BaseResponse implements IBaseSearchResponse
{
public linkedTo: ArrayOfLinkedTo;
public searchRecord: PepSearchRecord;
public constructor(init?: Partial<GetPepSearchData>) { super(init); (Object as any).assign(this, init); }
}
// @DataContract
export class GetPepSearchResponse
{
// @DataMember
public data: GetPepSearchData;
public constructor(init?: Partial<GetPepSearchResponse>) { (Object as any).assign(this, init); }
}
export class GetPepSearchRequest
{
/** @description If the search was created against a single Sub User account, specify their username here */
// @ApiMember(Description="If the search was created against a single Sub User account, specify their username here")
public subUserName: string;
/** @description If set to true, the response will exclude resolved search results, it will only include unresolved results */
// @ApiMember(Description="If set to true, the response will exclude resolved search results, it will only include unresolved results")
public onlyShowUnresolvedResults: boolean;
public id: number;
public constructor(init?: Partial<GetPepSearchRequest>) { (Object as any).assign(this, init); }
}
// @DataContract
export class GetPepSearch extends BaseRequest
{
// @DataMember
public request: GetPepSearchRequest;
public constructor(init?: Partial<GetPepSearch>) { super(init); (Object as any).assign(this, init); }
}
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>