| 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 .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/get HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"subUserName":"String","onlyShowUnresolvedResults":false,"id":0},"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)\/"}]}]}},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}