Add a sanctions 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 SearchResultEuAddress {
/** @param {{street?:string,city?:string,country?:string,postCode?:string,other?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
street;
/** @type {string} */
city;
/** @type {string} */
country;
/** @type {string} */
postCode;
/** @type {string} */
other;
}
export class SearchResultEuBirth {
/** @param {{date?:string,place?:string,country?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
date;
/** @type {string} */
place;
/** @type {string} */
country;
}
export class SearchResultOfacEuCitizenship {
/** @param {{country?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
country;
}
export class SearchResultEuName {
/** @param {{fullName?:string,gender?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
fullName;
/** @type {string} */
gender;
}
export class SearchResultEuPassport {
/** @param {{number?:string,country?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
number;
/** @type {string} */
country;
}
export class SearchResultEu {
/** @param {{resultStrength?:number,resultSimilarity?:number,resultResolved?:boolean,resultType?:string,dateUpdated?:string,addresses?:SearchResultEuAddress[],births?:SearchResultEuBirth[],citizenships?:SearchResultOfacEuCitizenship[],names?:SearchResultEuName[],passports?:SearchResultEuPassport[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
resultStrength;
/** @type {number} */
resultSimilarity;
/** @type {boolean} */
resultResolved;
/** @type {string} */
resultType;
/** @type {string} */
dateUpdated;
/** @type {SearchResultEuAddress[]} */
addresses;
/** @type {SearchResultEuBirth[]} */
births;
/** @type {SearchResultOfacEuCitizenship[]} */
citizenships;
/** @type {SearchResultEuName[]} */
names;
/** @type {SearchResultEuPassport[]} */
passports;
}
export class SearchResultHmTreasury {
/** @param {{resultStrength?:number,resultSimilarity?:number,resultResolved?:boolean,resultType?:string,dateListed?:string,dateUpdated?:string,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}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
resultStrength;
/** @type {number} */
resultSimilarity;
/** @type {boolean} */
resultResolved;
/** @type {string} */
resultType;
/** @type {string} */
dateListed;
/** @type {string} */
dateUpdated;
/** @type {string} */
name1;
/** @type {string} */
name2;
/** @type {string} */
name3;
/** @type {string} */
name4;
/** @type {string} */
name5;
/** @type {string} */
name6;
/** @type {string} */
dateOfBirth;
/** @type {string} */
countryOfBirth;
/** @type {string} */
nationality;
/** @type {string} */
address1;
/** @type {string} */
address2;
/** @type {string} */
address3;
/** @type {string} */
address4;
/** @type {string} */
address5;
/** @type {string} */
address6;
/** @type {string} */
postCode;
/** @type {string} */
country;
}
export class SearchResultOfacAddress {
/** @param {{address1?:string,address2?:string,address3?:string,city?:string,state?:string,postCode?:string,country?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
address1;
/** @type {string} */
address2;
/** @type {string} */
address3;
/** @type {string} */
city;
/** @type {string} */
state;
/** @type {string} */
postCode;
/** @type {string} */
country;
}
export class SearchResultOfacAka {
/** @param {{firstName?:string,lastName?:string,type?:string,strength?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
firstName;
/** @type {string} */
lastName;
/** @type {string} */
type;
/** @type {string} */
strength;
}
export class SearchResultOfacDateOfBirth {
/** @param {{dateOfBirth?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
dateOfBirth;
}
export class SearchResultOfacNationality {
/** @param {{country?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
country;
}
export class SearchResultOfacPlaceOfBirth {
/** @param {{placeOfBirth?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
placeOfBirth;
}
export class SearchResultOfac {
/** @param {{resultStrength?:number,resultSimilarity?:number,resultResolved?:boolean,resultType?:string,dateUpdated?:string,firstName?:string,lastName?:string,addresses?:SearchResultOfacAddress[],akas?:SearchResultOfacAka[],dateOfBirths?:SearchResultOfacDateOfBirth[],nationalities?:SearchResultOfacNationality[],placeOfBirths?:SearchResultOfacPlaceOfBirth[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
resultStrength;
/** @type {number} */
resultSimilarity;
/** @type {boolean} */
resultResolved;
/** @type {string} */
resultType;
/** @type {string} */
dateUpdated;
/** @type {string} */
firstName;
/** @type {string} */
lastName;
/** @type {SearchResultOfacAddress[]} */
addresses;
/** @type {SearchResultOfacAka[]} */
akas;
/** @type {SearchResultOfacDateOfBirth[]} */
dateOfBirths;
/** @type {SearchResultOfacNationality[]} */
nationalities;
/** @type {SearchResultOfacPlaceOfBirth[]} */
placeOfBirths;
}
export class SearchResultDfat {
/** @param {{resultStrength?:number,resultSimilarity?:number,resultResolved?:boolean,resultType?:string,dateUpdated?:string,fullName?:string,address?:string,dateOfBirth?:string,placeOfBirth?:string,nationality?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
resultStrength;
/** @type {number} */
resultSimilarity;
/** @type {boolean} */
resultResolved;
/** @type {string} */
resultType;
/** @type {string} */
dateUpdated;
/** @type {string} */
fullName;
/** @type {string} */
address;
/** @type {string} */
dateOfBirth;
/** @type {string} */
placeOfBirth;
/** @type {string} */
nationality;
}
export class SearchResultOsfi {
/** @param {{resultStrength?:number,resultSimilarity?:number,resultResolved?:boolean,resultType?:string,dateUpdated?:string,fullName?:string,address?:string,dateOfBirth?:string,placeOfBirth?:string,nationality?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
resultStrength;
/** @type {number} */
resultSimilarity;
/** @type {boolean} */
resultResolved;
/** @type {string} */
resultType;
/** @type {string} */
dateUpdated;
/** @type {string} */
fullName;
/** @type {string} */
address;
/** @type {string} */
dateOfBirth;
/** @type {string} */
placeOfBirth;
/** @type {string} */
nationality;
}
export class SearchResultCanadianJustice {
/** @param {{resultStrength?:number,resultSimilarity?:number,resultResolved?:boolean,resultType?:string,dateUpdated?:string,name?:string,dateOfBirth?:string,country?:string,refId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
resultStrength;
/** @type {number} */
resultSimilarity;
/** @type {boolean} */
resultResolved;
/** @type {string} */
resultType;
/** @type {string} */
dateUpdated;
/** @type {string} */
name;
/** @type {string} */
dateOfBirth;
/** @type {string} */
country;
/** @type {number} */
refId;
}
export class SearchResultCanadianSema {
/** @param {{resultStrength?:number,resultSimilarity?:number,resultResolved?:boolean,resultType?:string,dateUpdated?:string,name?:string,dateOfBirth?:string,country?:string,schedule?:string,item?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
resultStrength;
/** @type {number} */
resultSimilarity;
/** @type {boolean} */
resultResolved;
/** @type {string} */
resultType;
/** @type {string} */
dateUpdated;
/** @type {string} */
name;
/** @type {string} */
dateOfBirth;
/** @type {string} */
country;
/** @type {string} */
schedule;
/** @type {string} */
item;
}
export class SearchResultAddress {
/** @param {{searchResultAddressId?:number,type?:string,address1?:string,address2?:string,address3?:string,city?:string,county?:string,postCode?:string,country?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
searchResultAddressId;
/** @type {string} */
type;
/** @type {string} */
address1;
/** @type {string} */
address2;
/** @type {string} */
address3;
/** @type {string} */
city;
/** @type {string} */
county;
/** @type {string} */
postCode;
/** @type {string} */
country;
}
export class SearchResultDateOfBirth {
/** @param {{searchResultDateOfBirthId?:number,dateOfBirth?:string,year?:number,month?:number,day?:number,type?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
searchResultDateOfBirthId;
/** @type {string} */
dateOfBirth;
/** @type {?number} */
year;
/** @type {?number} */
month;
/** @type {?number} */
day;
/** @type {string} */
type;
}
export class SearchResultName {
/** @param {{searchResultNameId?:number,type?:string,title?:string,fullName?:string,resultSimilarity?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
searchResultNameId;
/** @type {string} */
type;
/** @type {string} */
title;
/** @type {string} */
fullName;
/** @type {number} */
resultSimilarity;
}
export class SearchResultNationality {
/** @param {{searchResultNationalityId?:number,nationality?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
searchResultNationalityId;
/** @type {string} */
nationality;
}
export class SearchResultPlaceOfBirth {
/** @param {{searchResultPlaceOfBirthId?:number,placeOfBirth?:string,countryOfBirth?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
searchResultPlaceOfBirthId;
/** @type {string} */
placeOfBirth;
/** @type {string} */
countryOfBirth;
}
export class SearchResultRemark {
/** @param {{searchResultRemarkId?:number,name?:string,description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
searchResultRemarkId;
/** @type {string} */
name;
/** @type {string} */
description;
}
export class SearchResultEntry {
/** @param {{searchResultId?:number,resultStrength?:number,resultSimilarity?:number,resultResolved?:boolean,resultType?:string,dateUpdated?:string,sanctionsListId?:string,sanctionsListName?:string,addresses?:SearchResultAddress[],datesOfBirth?:SearchResultDateOfBirth[],names?:SearchResultName[],nationalities?:SearchResultNationality[],placesOfBirth?:SearchResultPlaceOfBirth[],remarks?:SearchResultRemark[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
searchResultId;
/** @type {number} */
resultStrength;
/** @type {number} */
resultSimilarity;
/** @type {boolean} */
resultResolved;
/** @type {string} */
resultType;
/** @type {?string} */
dateUpdated;
/** @type {string} */
sanctionsListId;
/** @type {string} */
sanctionsListName;
/** @type {SearchResultAddress[]} */
addresses;
/** @type {SearchResultDateOfBirth[]} */
datesOfBirth;
/** @type {SearchResultName[]} */
names;
/** @type {SearchResultNationality[]} */
nationalities;
/** @type {SearchResultPlaceOfBirth[]} */
placesOfBirth;
/** @type {SearchResultRemark[]} */
remarks;
}
export class SearchResults {
/** @param {{euResults?:SearchResultEu[],hmtResults?:SearchResultHmTreasury[],hmtUkraineResults?:SearchResultHmTreasury[],ofacResults?:SearchResultOfac[],ofacConsolidatedResults?:SearchResultOfac[],dfatResults?:SearchResultDfat[],osfiResults?:SearchResultOsfi[],canadianJusticeResults?:SearchResultCanadianJustice[],canadianSemaResults?:SearchResultCanadianSema[],swissSecoResults?:SearchResultEntry[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {SearchResultEu[]} */
euResults;
/** @type {SearchResultHmTreasury[]} */
hmtResults;
/** @type {SearchResultHmTreasury[]} */
hmtUkraineResults;
/** @type {SearchResultOfac[]} */
ofacResults;
/** @type {SearchResultOfac[]} */
ofacConsolidatedResults;
/** @type {SearchResultDfat[]} */
dfatResults;
/** @type {SearchResultOsfi[]} */
osfiResults;
/** @type {SearchResultCanadianJustice[]} */
canadianJusticeResults;
/** @type {SearchResultCanadianSema[]} */
canadianSemaResults;
/** @type {SearchResultEntry[]} */
swissSecoResults;
}
export class SearchSource {
/** @param {{listId?:string,listName?:string,listShortName?:string,isAffectedByListUpdate?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
listId;
/** @type {string} */
listName;
/** @type {string} */
listShortName;
/** @type {?boolean} */
isAffectedByListUpdate;
}
export class ArrayOfSearchResultEntries extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class SearchRecord {
/** @param {{id?:number,searchType?:string,dateSearched?:string,dateUpdated?:string,dateArchived?:string,isArchived?:boolean,numOfResults?:number,clientInResults?:boolean,clientNotInResults?:boolean,affectedByUpdate?:boolean,searchCriteria?:SearchCriteria,searchResults?:SearchResults,searchSources?:SearchSource[],listSearchResults?:ArrayOfSearchResultEntries}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
searchType;
/** @type {string} */
dateSearched;
/** @type {string} */
dateUpdated;
/** @type {?string} */
dateArchived;
/** @type {boolean} */
isArchived;
/** @type {number} */
numOfResults;
/** @type {boolean} */
clientInResults;
/** @type {boolean} */
clientNotInResults;
/** @type {boolean} */
affectedByUpdate;
/** @type {SearchCriteria} */
searchCriteria;
/** @type {SearchResults} */
searchResults;
/** @type {SearchSource[]} */
searchSources;
/** @type {ArrayOfSearchResultEntries} */
listSearchResults;
}
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 AddSearchData extends BaseResponse {
/** @param {{linkedTo?:ArrayOfLinkedTo,searchRecord?:SearchRecord,includesPepSearchRecord?:boolean,pepSearchRecord?:PepSearchRecord,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {ArrayOfLinkedTo} */
linkedTo;
/** @type {SearchRecord} */
searchRecord;
/** @type {boolean} */
includesPepSearchRecord;
/** @type {PepSearchRecord} */
pepSearchRecord;
}
export class AddSearchResponse {
/** @param {{data?:AddSearchData}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {AddSearchData} */
data;
}
export class ArrayOfLists extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class AddSearchRequest {
/** @param {{subUserName?:string,type?:string,name?:string,country?:string,address?:string,dateOfBirth?:string,nationality?:string,reference?:string,excludeResults?:boolean,selectedLists?:ArrayOfLists,performPepSearch?:boolean,dayOneSearch?:boolean,linkedTo?:ArrayOfLinkedTo}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description If the search should be saved against a single Sub User account, specify their username here */
subUserName;
/** @type {string} */
type;
/** @type {string} */
name;
/** @type {string} */
country;
/** @type {string} */
address;
/** @type {string} */
dateOfBirth;
/** @type {string} */
nationality;
/** @type {string} */
reference;
/** @type {boolean} */
excludeResults;
/** @type {ArrayOfLists} */
selectedLists;
/** @type {boolean} */
performPepSearch;
/** @type {boolean} */
dayOneSearch;
/**
* @type {ArrayOfLinkedTo}
* @description If the search should be linked to other searches, specify the them here */
linkedTo;
}
export class AddSearch extends BaseRequest {
/** @param {{request?:AddSearchRequest,authentication?:Authentication}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {AddSearchRequest} */
request;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap11 suffix or ?format=soap11
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap11 HTTP/1.1
Host: api.sanctionssearch.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: AddSearch
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AddSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request>
<Address>String</Address>
<Country>String</Country>
<DateOfBirth>String</DateOfBirth>
<DayOneSearch>false</DayOneSearch>
<ExcludeResults>false</ExcludeResults>
<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>
<Name>String</Name>
<Nationality>String</Nationality>
<PerformPepSearch>false</PerformPepSearch>
<Reference>String</Reference>
<SelectedLists>
<ListId>String</ListId>
</SelectedLists>
<SubUserName>String</SubUserName>
<Type>String</Type>
</Request>
</AddSearch>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <AddSearchResponse 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> <IncludesPepSearchRecord>false</IncludesPepSearchRecord> <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> <PepSearchRecord> <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> </PepSearchRecord> <SearchRecord> <AffectedByUpdate>false</AffectedByUpdate> <ClientInResults>false</ClientInResults> <ClientNotInResults>false</ClientNotInResults> <DateArchived>0001-01-01T00:00:00</DateArchived> <DateSearched>0001-01-01T00:00:00</DateSearched> <DateUpdated>0001-01-01T00:00:00</DateUpdated> <Id>0</Id> <IsArchived>false</IsArchived> <ListSearchResults> <SearchResultEntry> <Addresses> <SearchResultAddress> <Address1>String</Address1> <Address2>String</Address2> <Address3>String</Address3> <City>String</City> <Country>String</Country> <County>String</County> <PostCode>String</PostCode> <SearchResultAddressId>0</SearchResultAddressId> <Type>String</Type> </SearchResultAddress> </Addresses> <DateUpdated>0001-01-01T00:00:00</DateUpdated> <DatesOfBirth> <SearchResultDateOfBirth> <DateOfBirth>String</DateOfBirth> <Day>0</Day> <Month>0</Month> <SearchResultDateOfBirthId>0</SearchResultDateOfBirthId> <Type>String</Type> <Year>0</Year> </SearchResultDateOfBirth> </DatesOfBirth> <Names> <SearchResultName> <FullName>String</FullName> <ResultSimilarity>0</ResultSimilarity> <SearchResultNameId>0</SearchResultNameId> <Title>String</Title> <Type>String</Type> </SearchResultName> </Names> <Nationalities> <SearchResultNationality> <Nationality>String</Nationality> <SearchResultNationalityId>0</SearchResultNationalityId> </SearchResultNationality> </Nationalities> <PlacesOfBirth> <SearchResultPlaceOfBirth> <CountryOfBirth>String</CountryOfBirth> <PlaceOfBirth>String</PlaceOfBirth> <SearchResultPlaceOfBirthId>0</SearchResultPlaceOfBirthId> </SearchResultPlaceOfBirth> </PlacesOfBirth> <Remarks> <SearchResultRemark> <Description>String</Description> <Name>String</Name> <SearchResultRemarkId>0</SearchResultRemarkId> </SearchResultRemark> </Remarks> <ResultResolved>false</ResultResolved> <ResultSimilarity>0</ResultSimilarity> <ResultStrength>0</ResultStrength> <ResultType>String</ResultType> <SanctionsListId>String</SanctionsListId> <SanctionsListName>String</SanctionsListName> <SearchResultId>0</SearchResultId> </SearchResultEntry> </ListSearchResults> <NumOfResults>0</NumOfResults> <SearchCriteria> <Address>String</Address> <Country>String</Country> <DateOfBirth>String</DateOfBirth> <Name>String</Name> <Nationality>String</Nationality> <Reference>String</Reference> </SearchCriteria> <SearchResults> <CanadianJusticeResults> <SearchResultCanadianJustice> <Country>String</Country> <DateOfBirth>String</DateOfBirth> <DateUpdated>0001-01-01T00:00:00</DateUpdated> <Name>String</Name> <RefId>0</RefId> <ResultResolved>false</ResultResolved> <ResultSimilarity>0</ResultSimilarity> <ResultStrength>0</ResultStrength> <ResultType>String</ResultType> </SearchResultCanadianJustice> </CanadianJusticeResults> <CanadianSemaResults> <SearchResultCanadianSema> <Country>String</Country> <DateOfBirth>String</DateOfBirth> <DateUpdated>0001-01-01T00:00:00</DateUpdated> <Item>String</Item> <Name>String</Name> <ResultResolved>false</ResultResolved> <ResultSimilarity>0</ResultSimilarity> <ResultStrength>0</ResultStrength> <ResultType>String</ResultType> <Schedule>String</Schedule> </SearchResultCanadianSema> </CanadianSemaResults> <DfatResults> <SearchResultDfat> <Address>String</Address> <DateOfBirth>String</DateOfBirth> <DateUpdated>0001-01-01T00:00:00</DateUpdated> <FullName>String</FullName> <Nationality>String</Nationality> <PlaceOfBirth>String</PlaceOfBirth> <ResultResolved>false</ResultResolved> <ResultSimilarity>0</ResultSimilarity> <ResultStrength>0</ResultStrength> <ResultType>String</ResultType> </SearchResultDfat> </DfatResults> <EuResults> <SearchResultEu> <Addresses> <SearchResultEuAddress> <City>String</City> <Country>String</Country> <Other>String</Other> <PostCode>String</PostCode> <Street>String</Street> </SearchResultEuAddress> </Addresses> <Births> <SearchResultEuBirth> <Country>String</Country> <Date>String</Date> <Place>String</Place> </SearchResultEuBirth> </Births> <Citizenships> <SearchResultOfacEuCitizenship> <Country>String</Country> </SearchResultOfacEuCitizenship> </Citizenships> <DateUpdated>0001-01-01T00:00:00</DateUpdated> <Names> <SearchResultEuName> <FullName>String</FullName> <Gender>String</Gender> </SearchResultEuName> </Names> <Passports> <SearchResultEuPassport> <Country>String</Country> <Number>String</Number> </SearchResultEuPassport> </Passports> <ResultResolved>false</ResultResolved> <ResultSimilarity>0</ResultSimilarity> <ResultStrength>0</ResultStrength> <ResultType>String</ResultType> </SearchResultEu> </EuResults> <HMTResults> <SearchResultHmTreasury> <Address1>String</Address1> <Address2>String</Address2> <Address3>String</Address3> <Address4>String</Address4> <Address5>String</Address5> <Address6>String</Address6> <Country>String</Country> <CountryOfBirth>String</CountryOfBirth> <DateListed>0001-01-01T00:00:00</DateListed> <DateOfBirth>String</DateOfBirth> <DateUpdated>0001-01-01T00:00:00</DateUpdated> <Name1>String</Name1> <Name2>String</Name2> <Name3>String</Name3> <Name4>String</Name4> <Name5>String</Name5> <Name6>String</Name6> <Nationality>String</Nationality> <PostCode>String</PostCode> <ResultResolved>false</ResultResolved> <ResultSimilarity>0</ResultSimilarity> <ResultStrength>0</ResultStrength> <ResultType>String</ResultType> </SearchResultHmTreasury> </HMTResults> <HMTUkraineResults> <SearchResultHmTreasury> <Address1>String</Address1> <Address2>String</Address2> <Address3>String</Address3> <Address4>String</Address4> <Address5>String</Address5> <Address6>String</Address6> <Country>String</Country> <CountryOfBirth>String</CountryOfBirth> <DateListed>0001-01-01T00:00:00</DateListed> <DateOfBirth>String</DateOfBirth> <DateUpdated>0001-01-01T00:00:00</DateUpdated> <Name1>String</Name1> <Name2>String</Name2> <Name3>String</Name3> <Name4>String</Name4> <Name5>String</Name5> <Name6>String</Name6> <Nationality>String</Nationality> <PostCode>String</PostCode> <ResultResolved>false</ResultResolved> <ResultSimilarity>0</ResultSimilarity> <ResultStrength>0</ResultStrength> <ResultType>String</ResultType> </SearchResultHmTreasury> </HMTUkraineResults> <OfacConsolidatedResults> <SearchResultOfac> <Addresses> <SearchResultOfacAddress> <Address1>String</Address1> <Address2>String</Address2> <Address3>String</Address3> <City>String</City> <Country>String</Country> <PostCode>String</PostCode> <State>String</State> </SearchResultOfacAddress> </Addresses> <Akas> <SearchResultOfacAka> <FirstName>String</FirstName> <LastName>String</LastName> <Strength>String</Strength> <Type>String</Type> </SearchResultOfacAka> </Akas> <DateOfBirths> <SearchResultOfacDateOfBirth> <DateOfBirth>String</DateOfBirth> </SearchResultOfacDateOfBirth> </DateOfBirths> <DateUpdated>0001-01-01T00:00:00</DateUpdated> <FirstName>String</FirstName> <LastName>String</LastName> <Nationalities> <SearchResultOfacNationality> <Country>String</Country> </SearchResultOfacNationality> </Nationalities> <PlaceOfBirths> <SearchResultOfacPlaceOfBirth> <PlaceOfBirth>String</PlaceOfBirth> </SearchResultOfacPlaceOfBirth> </PlaceOfBirths> <ResultResolved>false</ResultResolved> <ResultSimilarity>0</ResultSimilarity> <ResultStrength>0</ResultStrength> <ResultType>String</ResultType> </SearchResultOfac> </OfacConsolidatedResults> <OfacResults> <SearchResultOfac> <Addresses> <SearchResultOfacAddress> <Address1>String</Address1> <Address2>String</Address2> <Address3>String</Address3> <City>String</City> <Country>String</Country> <PostCode>String</PostCode> <State>String</State> </SearchResultOfacAddress> </Addresses> <Akas> <SearchResultOfacAka> <FirstName>String</FirstName> <LastName>String</LastName> <Strength>String</Strength> <Type>String</Type> </SearchResultOfacAka> </Akas> <DateOfBirths> <SearchResultOfacDateOfBirth> <DateOfBirth>String</DateOfBirth> </SearchResultOfacDateOfBirth> </DateOfBirths> <DateUpdated>0001-01-01T00:00:00</DateUpdated> <FirstName>String</FirstName> <LastName>String</LastName> <Nationalities> <SearchResultOfacNationality> <Country>String</Country> </SearchResultOfacNationality> </Nationalities> <PlaceOfBirths> <SearchResultOfacPlaceOfBirth> <PlaceOfBirth>String</PlaceOfBirth> </SearchResultOfacPlaceOfBirth> </PlaceOfBirths> <ResultResolved>false</ResultResolved> <ResultSimilarity>0</ResultSimilarity> <ResultStrength>0</ResultStrength> <ResultType>String</ResultType> </SearchResultOfac> </OfacResults> <OsfiResults> <SearchResultOsfi> <Address>String</Address> <DateOfBirth>String</DateOfBirth> <DateUpdated>0001-01-01T00:00:00</DateUpdated> <FullName>String</FullName> <Nationality>String</Nationality> <PlaceOfBirth>String</PlaceOfBirth> <ResultResolved>false</ResultResolved> <ResultSimilarity>0</ResultSimilarity> <ResultStrength>0</ResultStrength> <ResultType>String</ResultType> </SearchResultOsfi> </OsfiResults> <SwissSecoResults> <SearchResultEntry> <Addresses> <SearchResultAddress> <Address1>String</Address1> <Address2>String</Address2> <Address3>String</Address3> <City>String</City> <Country>String</Country> <County>String</County> <PostCode>String</PostCode> <SearchResultAddressId>0</SearchResultAddressId> <Type>String</Type> </SearchResultAddress> </Addresses> <DateUpdated>0001-01-01T00:00:00</DateUpdated> <DatesOfBirth> <SearchResultDateOfBirth> <DateOfBirth>String</DateOfBirth> <Day>0</Day> <Month>0</Month> <SearchResultDateOfBirthId>0</SearchResultDateOfBirthId> <Type>String</Type> <Year>0</Year> </SearchResultDateOfBirth> </DatesOfBirth> <Names> <SearchResultName> <FullName>String</FullName> <ResultSimilarity>0</ResultSimilarity> <SearchResultNameId>0</SearchResultNameId> <Title>String</Title> <Type>String</Type> </SearchResultName> </Names> <Nationalities> <SearchResultNationality> <Nationality>String</Nationality> <SearchResultNationalityId>0</SearchResultNationalityId> </SearchResultNationality> </Nationalities> <PlacesOfBirth> <SearchResultPlaceOfBirth> <CountryOfBirth>String</CountryOfBirth> <PlaceOfBirth>String</PlaceOfBirth> <SearchResultPlaceOfBirthId>0</SearchResultPlaceOfBirthId> </SearchResultPlaceOfBirth> </PlacesOfBirth> <Remarks> <SearchResultRemark> <Description>String</Description> <Name>String</Name> <SearchResultRemarkId>0</SearchResultRemarkId> </SearchResultRemark> </Remarks> <ResultResolved>false</ResultResolved> <ResultSimilarity>0</ResultSimilarity> <ResultStrength>0</ResultStrength> <ResultType>String</ResultType> <SanctionsListId>String</SanctionsListId> <SanctionsListName>String</SanctionsListName> <SearchResultId>0</SearchResultId> </SearchResultEntry> </SwissSecoResults> </SearchResults> <SearchSources> <SearchSource> <IsAffectedByListUpdate>false</IsAffectedByListUpdate> <ListId>String</ListId> <ListName>String</ListName> <ListShortName>String</ListShortName> </SearchSource> </SearchSources> <SearchType>String</SearchType> </SearchRecord> </Data> </AddSearchResponse> </soap:Body> </soap:Envelope>