| POST | /peps/get | Get a PEP search |
|---|
"use strict";
export class Authentication {
/** @param {{apiUserId?:string,apiUserKey?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The API User ID provided by us when you signed up to use our API */
apiUserId;
/**
* @type {string}
* @description The API User Key provided by us when you signed up to use our API */
apiUserKey;
}
export class BaseRequest {
/** @param {{authentication?:Authentication}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {Authentication}
* @description The authentication credentials */
authentication;
}
export class ResponseError {
/** @param {{errorCode?:string,fieldName?:string,message?:string,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
errorCode;
/** @type {string} */
fieldName;
/** @type {string} */
message;
/** @type {{ [index: string]: string; }} */
meta;
}
export class ArrayOfResponseError extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class ResponseStatus {
/** @param {{errorCode?:string,message?:string,stackTrace?:string,errors?:ArrayOfResponseError,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
errorCode;
/** @type {string} */
message;
/** @type {string} */
stackTrace;
/** @type {ArrayOfResponseError} */
errors;
/** @type {{ [index: string]: string; }} */
meta;
}
export class BaseResponse {
/** @param {{responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {ResponseStatus}
* @description The status of the response */
responseStatus;
}
export class LinkedTo {
/** @param {{clientId?:number,id?:number,type?:string,subtype?:string,status?:string,description?:string,isArchived?:boolean,name?:string,date?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
clientId;
/** @type {?number} */
id;
/** @type {?string} */
type;
/** @type {?string} */
subtype;
/** @type {?string} */
status;
/** @type {?string} */
description;
/** @type {?boolean} */
isArchived;
/** @type {?string} */
name;
/** @type {?string} */
date;
}
export class ArrayOfLinkedTo extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class SearchCriteria {
/** @param {{name?:string,address?:string,country?:string,dateOfBirth?:string,nationality?:string,reference?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
name;
/** @type {string} */
address;
/** @type {string} */
country;
/** @type {string} */
dateOfBirth;
/** @type {string} */
nationality;
/** @type {string} */
reference;
}
export class PepSearchResultAddress {
/** @param {{addressLine1?:string,addressLine2?:string,addressLine3?:string,addressLine4?:string,town?:string,county?:string,postCode?:string,country?:string,isoCountry?:string,softDelete?:boolean,dateLastUpdated?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
addressLine1;
/** @type {string} */
addressLine2;
/** @type {string} */
addressLine3;
/** @type {string} */
addressLine4;
/** @type {string} */
town;
/** @type {string} */
county;
/** @type {string} */
postCode;
/** @type {string} */
country;
/** @type {string} */
isoCountry;
/** @type {?boolean} */
softDelete;
/** @type {string} */
dateLastUpdated;
}
export class PepSearchResultAlias {
/** @param {{forename?:string,middleName?:string,surname?:string,softDelete?:boolean,dateOfSoftDelete?:string,dateLastUpdated?:string,title?:string,alternateTitle?:string,businessName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
forename;
/** @type {string} */
middleName;
/** @type {string} */
surname;
/** @type {?boolean} */
softDelete;
/** @type {?string} */
dateOfSoftDelete;
/** @type {string} */
dateLastUpdated;
/** @type {string} */
title;
/** @type {string} */
alternateTitle;
/** @type {string} */
businessName;
}
export class PepSearchResultArticleSnippet {
/** @param {{title?:string,text?:string,adverseTerms?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
title;
/** @type {string} */
text;
/** @type {string} */
adverseTerms;
}
export class PepSearchResultArticle {
/** @param {{url?:string,originalUrl?:string,source?:string,dateOfCapture?:string,dateLastUpdated?:string,snippets?:PepSearchResultArticleSnippet[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
url;
/** @type {string} */
originalUrl;
/** @type {string} */
source;
/** @type {?string} */
dateOfCapture;
/** @type {string} */
dateLastUpdated;
/** @type {PepSearchResultArticleSnippet[]} */
snippets;
}
export class PepSearchResultIndividualAssociation {
/** @param {{linkDescription?:string,softDelete?:boolean,dateLastUpdated?:string,fullName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
linkDescription;
/** @type {?boolean} */
softDelete;
/** @type {string} */
dateLastUpdated;
/** @type {string} */
fullName;
}
export class PepSearchResultBusinessAssociation {
/** @param {{linkDescription?:string,softDelete?:boolean,dateLastUpdated?:string,businessName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
linkDescription;
/** @type {?boolean} */
softDelete;
/** @type {string} */
dateLastUpdated;
/** @type {string} */
businessName;
}
export class PepSearchResultNote {
/** @param {{source?:string,notes?:string,softDelete?:boolean,dateLastUpdated?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
source;
/** @type {string} */
notes;
/** @type {?boolean} */
softDelete;
/** @type {string} */
dateLastUpdated;
}
export class PepSearchResultPoliticalPosition {
/** @param {{description?:string,from?:string,to?:string,country?:string,softDelete?:boolean,dateLastUpdated?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
description;
/** @type {string} */
from;
/** @type {string} */
to;
/** @type {string} */
country;
/** @type {?boolean} */
softDelete;
/** @type {string} */
dateLastUpdated;
}
export class PepSearchResult {
/** @param {{resultSimilarity?:number,resultResolved?:boolean,dateLastUpdated?:string,resultIsClient?:boolean,id?:number,type?:string,title?:string,forename?:string,middlename?:string,surname?:string,softDelete?:boolean,dateOfSoftDelete?:string,dateOfCapture?:string,dateOfBirth?:string,dateOfDeath?:string,yearOfBirth?:number,yearOfDeath?:number,gender?:string,homeTelephone?:string,businessTelephone?:string,mobileTelephone?:string,fax?:string,email?:string,nationality?:string,source?:string,category?:string,picture?:string,alternateTitle?:string,businessName?:string,description?:string,telephone?:string,website?:string,pepTier?:number,addresses?:PepSearchResultAddress[],aliases?:PepSearchResultAlias[],articles?:PepSearchResultArticle[],associations?:PepSearchResultIndividualAssociation[],businessAssociations?:PepSearchResultBusinessAssociation[],notes?:PepSearchResultNote[],politicalPositions?:PepSearchResultPoliticalPosition[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
resultSimilarity;
/** @type {boolean} */
resultResolved;
/** @type {string} */
dateLastUpdated;
/** @type {boolean} */
resultIsClient;
/** @type {number} */
id;
/** @type {string} */
type;
/** @type {string} */
title;
/** @type {string} */
forename;
/** @type {string} */
middlename;
/** @type {string} */
surname;
/** @type {?boolean} */
softDelete;
/** @type {?string} */
dateOfSoftDelete;
/** @type {?string} */
dateOfCapture;
/** @type {?string} */
dateOfBirth;
/** @type {?string} */
dateOfDeath;
/** @type {?number} */
yearOfBirth;
/** @type {?number} */
yearOfDeath;
/** @type {string} */
gender;
/** @type {string} */
homeTelephone;
/** @type {string} */
businessTelephone;
/** @type {string} */
mobileTelephone;
/** @type {string} */
fax;
/** @type {string} */
email;
/** @type {string} */
nationality;
/** @type {string} */
source;
/** @type {string} */
category;
/** @type {string} */
picture;
/** @type {string} */
alternateTitle;
/** @type {string} */
businessName;
/** @type {string} */
description;
/** @type {string} */
telephone;
/** @type {string} */
website;
/** @type {?number} */
pepTier;
/** @type {PepSearchResultAddress[]} */
addresses;
/** @type {PepSearchResultAlias[]} */
aliases;
/** @type {PepSearchResultArticle[]} */
articles;
/** @type {PepSearchResultIndividualAssociation[]} */
associations;
/** @type {PepSearchResultBusinessAssociation[]} */
businessAssociations;
/** @type {PepSearchResultNote[]} */
notes;
/** @type {PepSearchResultPoliticalPosition[]} */
politicalPositions;
}
export class PepSearchResults {
/** @param {{results?:PepSearchResult[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {PepSearchResult[]} */
results;
}
export class PepSearchRecord {
/** @param {{id?:number,searchType?:string,dateSearched?:string,dateUpdated?:string,dateRenewal?:string,dateArchived?:string,isArchived?:boolean,numOfResults?:number,clientInResults?:boolean,clientNotInResults?:boolean,affectedByUpdate?:boolean,isDayOneSearch?:boolean,searchCriteria?:SearchCriteria,searchResults?:PepSearchResults}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
searchType;
/** @type {string} */
dateSearched;
/** @type {string} */
dateUpdated;
/** @type {?string} */
dateRenewal;
/** @type {?string} */
dateArchived;
/** @type {boolean} */
isArchived;
/** @type {number} */
numOfResults;
/** @type {boolean} */
clientInResults;
/** @type {boolean} */
clientNotInResults;
/** @type {boolean} */
affectedByUpdate;
/** @type {boolean} */
isDayOneSearch;
/** @type {SearchCriteria} */
searchCriteria;
/** @type {PepSearchResults} */
searchResults;
}
export class GetPepSearchData extends BaseResponse {
/** @param {{linkedTo?:ArrayOfLinkedTo,searchRecord?:PepSearchRecord,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {ArrayOfLinkedTo} */
linkedTo;
/** @type {PepSearchRecord} */
searchRecord;
}
export class GetPepSearchResponse {
/** @param {{data?:GetPepSearchData}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {GetPepSearchData} */
data;
}
export class GetPepSearchRequest {
/** @param {{subUserName?:string,onlyShowUnresolvedResults?:boolean,id?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description If the search was created against a single Sub User account, specify their username here */
subUserName;
/**
* @type {boolean}
* @description If set to true, the response will exclude resolved search results, it will only include unresolved results */
onlyShowUnresolvedResults;
/** @type {number} */
id;
}
export class GetPepSearch extends BaseRequest {
/** @param {{request?:GetPepSearchRequest,authentication?:Authentication}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {GetPepSearchRequest} */
request;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /peps/get HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<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>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<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>