| POST | /peps/add | Add 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 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 AddPepSearchData extends BaseResponse {
/** @param {{linkedTo?:ArrayOfLinkedTo,searchRecord?:PepSearchRecord,includesSanctionsSearchRecord?:boolean,sanctionsSearchRecord?:SearchRecord,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {ArrayOfLinkedTo} */
linkedTo;
/** @type {PepSearchRecord} */
searchRecord;
/** @type {boolean} */
includesSanctionsSearchRecord;
/** @type {SearchRecord} */
sanctionsSearchRecord;
}
export class AddPepSearchResponse {
/** @param {{data?:AddPepSearchData}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {AddPepSearchData} */
data;
}
export class ArrayOfLists extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class AddPepSearchRequest {
/** @param {{subUserName?:string,type?:string,name?:string,country?:string,address?:string,dateOfBirth?:string,nationality?:string,reference?:string,excludeResults?:boolean,performSanctionsSearch?:boolean,dayOneSearch?:boolean,selectedLists?:ArrayOfLists,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 {boolean} */
performSanctionsSearch;
/** @type {boolean} */
dayOneSearch;
/** @type {ArrayOfLists} */
selectedLists;
/**
* @type {ArrayOfLinkedTo}
* @description If the search should be linked to other searches, specify the them here */
linkedTo;
}
export class AddPepSearch extends BaseRequest {
/** @param {{request?:AddPepSearchRequest,authentication?:Authentication}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {AddPepSearchRequest} */
request;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /peps/add HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"subUserName":"String","type":"String","name":"String","country":"String","address":"String","dateOfBirth":"String","nationality":"String","reference":"String","excludeResults":false,"performSanctionsSearch":false,"dayOneSearch":false,"selectedLists":["String"],"linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}]},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}],"searchRecord":{"id":0,"searchType":"String","dateSearched":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","dateRenewal":"\/Date(-62135596800000-0000)\/","dateArchived":"\/Date(-62135596800000-0000)\/","isArchived":false,"numOfResults":0,"clientInResults":false,"clientNotInResults":false,"affectedByUpdate":false,"isDayOneSearch":false,"searchCriteria":{"name":"String","address":"String","country":"String","dateOfBirth":"String","nationality":"String","reference":"String"},"searchResults":{"results":[{"resultSimilarity":0,"resultResolved":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/","resultIsClient":false,"id":0,"type":"String","title":"String","forename":"String","middlename":"String","surname":"String","softDelete":false,"dateOfSoftDelete":"\/Date(-62135596800000-0000)\/","dateOfCapture":"\/Date(-62135596800000-0000)\/","dateOfBirth":"\/Date(-62135596800000-0000)\/","dateOfDeath":"\/Date(-62135596800000-0000)\/","yearOfBirth":0,"yearOfDeath":0,"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":0,"addresses":[{"addressLine1":"String","addressLine2":"String","addressLine3":"String","addressLine4":"String","town":"String","county":"String","postCode":"String","country":"String","isoCountry":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/"}],"aliases":[{"forename":"String","middleName":"String","surname":"String","softDelete":false,"dateOfSoftDelete":"\/Date(-62135596800000-0000)\/","dateLastUpdated":"\/Date(-62135596800000-0000)\/","title":"String","alternateTitle":"String","businessName":"String"}],"articles":[{"url":"String","originalUrl":"String","source":"String","dateOfCapture":"\/Date(-62135596800000-0000)\/","dateLastUpdated":"\/Date(-62135596800000-0000)\/","snippets":[{"title":"String","text":"String","adverseTerms":"String"}]}],"associations":[{"linkDescription":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/","fullName":"String"}],"businessAssociations":[{"linkDescription":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/","businessName":"String"}],"notes":[{"source":"String","notes":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/"}],"politicalPositions":[{"description":"String","from":"String","to":"String","country":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/"}]}]}},"includesSanctionsSearchRecord":false,"sanctionsSearchRecord":{"id":0,"searchType":"String","dateSearched":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","dateArchived":"\/Date(-62135596800000-0000)\/","isArchived":false,"numOfResults":0,"clientInResults":false,"clientNotInResults":false,"affectedByUpdate":false,"searchCriteria":{"name":"String","address":"String","country":"String","dateOfBirth":"String","nationality":"String","reference":"String"},"searchResults":{"euResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","addresses":[{"street":"String","city":"String","country":"String","postCode":"String","other":"String"}],"births":[{"date":"String","place":"String","country":"String"}],"citizenships":[{"country":"String"}],"names":[{"fullName":"String","gender":"String"}],"passports":[{"number":"String","country":"String"}]}],"hmtResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateListed":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","name1":"String","name2":"String","name3":"String","name4":"String","name5":"String","name6":"String","dateOfBirth":"String","countryOfBirth":"String","nationality":"String","address1":"String","address2":"String","address3":"String","address4":"String","address5":"String","address6":"String","postCode":"String","country":"String"}],"hmtUkraineResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateListed":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","name1":"String","name2":"String","name3":"String","name4":"String","name5":"String","name6":"String","dateOfBirth":"String","countryOfBirth":"String","nationality":"String","address1":"String","address2":"String","address3":"String","address4":"String","address5":"String","address6":"String","postCode":"String","country":"String"}],"ofacResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","firstName":"String","lastName":"String","addresses":[{"address1":"String","address2":"String","address3":"String","city":"String","state":"String","postCode":"String","country":"String"}],"akas":[{"firstName":"String","lastName":"String","type":"String","strength":"String"}],"dateOfBirths":[{"dateOfBirth":"String"}],"nationalities":[{"country":"String"}],"placeOfBirths":[{"placeOfBirth":"String"}]}],"ofacConsolidatedResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","firstName":"String","lastName":"String","addresses":[{"address1":"String","address2":"String","address3":"String","city":"String","state":"String","postCode":"String","country":"String"}],"akas":[{"firstName":"String","lastName":"String","type":"String","strength":"String"}],"dateOfBirths":[{"dateOfBirth":"String"}],"nationalities":[{"country":"String"}],"placeOfBirths":[{"placeOfBirth":"String"}]}],"dfatResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","fullName":"String","address":"String","dateOfBirth":"String","placeOfBirth":"String","nationality":"String"}],"osfiResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","fullName":"String","address":"String","dateOfBirth":"String","placeOfBirth":"String","nationality":"String"}],"canadianJusticeResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","name":"String","dateOfBirth":"String","country":"String","refId":0}],"canadianSemaResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","name":"String","dateOfBirth":"String","country":"String","schedule":"String","item":"String"}],"swissSecoResults":[{"searchResultId":0,"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","sanctionsListId":"String","sanctionsListName":"String","addresses":[{"searchResultAddressId":0,"type":"String","address1":"String","address2":"String","address3":"String","city":"String","county":"String","postCode":"String","country":"String"}],"datesOfBirth":[{"searchResultDateOfBirthId":0,"dateOfBirth":"String","year":0,"month":0,"day":0,"type":"String"}],"names":[{"searchResultNameId":0,"type":"String","title":"String","fullName":"String","resultSimilarity":0}],"nationalities":[{"searchResultNationalityId":0,"nationality":"String"}],"placesOfBirth":[{"searchResultPlaceOfBirthId":0,"placeOfBirth":"String","countryOfBirth":"String"}],"remarks":[{"searchResultRemarkId":0,"name":"String","description":"String"}]}]},"searchSources":[{"listId":"String","listName":"String","listShortName":"String","isAffectedByListUpdate":false}],"listSearchResults":[{"searchResultId":0,"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","sanctionsListId":"String","sanctionsListName":"String","addresses":[{"searchResultAddressId":0,"type":"String","address1":"String","address2":"String","address3":"String","city":"String","county":"String","postCode":"String","country":"String"}],"datesOfBirth":[{"searchResultDateOfBirthId":0,"dateOfBirth":"String","year":0,"month":0,"day":0,"type":"String"}],"names":[{"searchResultNameId":0,"type":"String","title":"String","fullName":"String","resultSimilarity":0}],"nationalities":[{"searchResultNationalityId":0,"nationality":"String"}],"placesOfBirth":[{"searchResultPlaceOfBirthId":0,"placeOfBirth":"String","countryOfBirth":"String"}],"remarks":[{"searchResultRemarkId":0,"name":"String","description":"String"}]}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}