| Get a company lookup |
"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 ArrayOfLists extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class CompanyDirectorOrShareholder {
/** @param {{id?:number,searchType?:string,dateSearched?:string,dateUpdated?:string,numOfResults?:number,clientInResults?:boolean,clientNotInResults?:boolean,affectedByUpdate?:boolean,searchCriteria?:SearchCriteria,isDirector?:boolean,isShareholder?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
searchType;
/** @type {string} */
dateSearched;
/** @type {string} */
dateUpdated;
/** @type {number} */
numOfResults;
/** @type {boolean} */
clientInResults;
/** @type {boolean} */
clientNotInResults;
/** @type {boolean} */
affectedByUpdate;
/** @type {SearchCriteria} */
searchCriteria;
/** @type {boolean} */
isDirector;
/** @type {boolean} */
isShareholder;
}
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 SearchListItem {
/** @param {{id?:number,searchType?:string,dateSearched?:string,dateUpdated?:string,dateArchived?:string,isArchived?:boolean,numOfResults?:number,clientInResults?:boolean,clientNotInResults?:boolean,affectedByUpdate?:boolean,searchCriteria?:SearchCriteria,searchSources?:SearchSource[]}} [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 {SearchSource[]} */
searchSources;
}
export class CompanyLookupEnhancedLatestAccounts {
/** @param {{currency?:string,turnover?:number,shareholdersEquity?:number,creditRating?:number,creditLimit?:number,creditRatingDescription?:string,accountRefDay?:number,accountRefMonth?:number,accountNextDueDate?:string,accountLastMadeUpDate?:string,accountCategory?:string,returnLastMadeUpDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
currency;
/** @type {?number} */
turnover;
/** @type {?number} */
shareholdersEquity;
/** @type {?number} */
creditRating;
/** @type {?number} */
creditLimit;
/** @type {string} */
creditRatingDescription;
/** @type {?number} */
accountRefDay;
/** @type {?number} */
accountRefMonth;
/** @type {?string} */
accountNextDueDate;
/** @type {?string} */
accountLastMadeUpDate;
/** @type {string} */
accountCategory;
/** @type {?string} */
returnLastMadeUpDate;
}
export class CompanyLookupEnhancedSummary {
/** @param {{name?:string,country?:string,registrationNumber?:string,dateOfIncorporation?:string,typeOfIncorporation?:string,companyStatus?:string,address?:string,telephone?:string,sicCode?:string,sicDescription?:string,principleActivity?:string,latestAccounts?:CompanyLookupEnhancedLatestAccounts}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
name;
/** @type {string} */
country;
/** @type {string} */
registrationNumber;
/** @type {string} */
dateOfIncorporation;
/** @type {string} */
typeOfIncorporation;
/** @type {string} */
companyStatus;
/** @type {string} */
address;
/** @type {string} */
telephone;
/** @type {string} */
sicCode;
/** @type {string} */
sicDescription;
/** @type {string} */
principleActivity;
/** @type {CompanyLookupEnhancedLatestAccounts} */
latestAccounts;
}
export class CompanyLookupEnhancedAddress {
/** @param {{fullAddress?:string,address1?:string,address2?:string,address3?:string,address4?:string,postCode?:string,telephone?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
fullAddress;
/** @type {string} */
address1;
/** @type {string} */
address2;
/** @type {string} */
address3;
/** @type {string} */
address4;
/** @type {string} */
postCode;
/** @type {string} */
telephone;
}
export class CompanyLookupEnhancedWebsite {
/** @param {{website?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
website;
}
export class CompanyLookupEnhancedAdditionalContact {
/** @param {{telephone?:string,faxNumber?:string,emailAddress?:string,webAddress?:string,twitter?:string,facebook?:string,googlePlus?:string,linkedIn?:string,contactName?:string,businessClassification?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
telephone;
/** @type {string} */
faxNumber;
/** @type {string} */
emailAddress;
/** @type {string} */
webAddress;
/** @type {string} */
twitter;
/** @type {string} */
facebook;
/** @type {string} */
googlePlus;
/** @type {string} */
linkedIn;
/** @type {string} */
contactName;
/** @type {string} */
businessClassification;
}
export class CompanyLookupEnhancedContactInfo {
/** @param {{registeredAddress?:CompanyLookupEnhancedAddress,tradingAddresses?:CompanyLookupEnhancedAddress[],websites?:CompanyLookupEnhancedWebsite[],additionalContactInfo?:CompanyLookupEnhancedAdditionalContact}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {CompanyLookupEnhancedAddress} */
registeredAddress;
/** @type {CompanyLookupEnhancedAddress[]} */
tradingAddresses;
/** @type {CompanyLookupEnhancedWebsite[]} */
websites;
/** @type {CompanyLookupEnhancedAdditionalContact} */
additionalContactInfo;
}
export class CompanyLookupEnhancedSicCode {
/** @param {{sicCode2003?:number,sicCode2003Description?:string,sicCode2007?:number,sicCode2007Description?:string,status?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
sicCode2003;
/** @type {string} */
sicCode2003Description;
/** @type {?number} */
sicCode2007;
/** @type {string} */
sicCode2007Description;
/** @type {string} */
status;
}
export class CompanyLookupEnhancedPreviousName {
/** @param {{dateChanged?:string,name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
dateChanged;
/** @type {string} */
name;
}
export class CompanyLookupEnhancedShareholder {
/** @param {{title?:string,forename?:string,surname?:string,address1?:string,address2?:string,address3?:string,address4?:string,address5?:string,postCode?:string,shareType?:string,number?:number,value?:number,currency?:string,shareholderType?:string,shareClass?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
title;
/** @type {string} */
forename;
/** @type {string} */
surname;
/** @type {string} */
address1;
/** @type {string} */
address2;
/** @type {string} */
address3;
/** @type {string} */
address4;
/** @type {string} */
address5;
/** @type {string} */
postCode;
/** @type {string} */
shareType;
/** @type {?number} */
number;
/** @type {?number} */
value;
/** @type {string} */
currency;
/** @type {string} */
shareholderType;
/** @type {string} */
shareClass;
}
export class CompanyLookupEnhancedShareStructure {
/** @param {{issuedShareCapital?:number,shareholders?:CompanyLookupEnhancedShareholder[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
issuedShareCapital;
/** @type {CompanyLookupEnhancedShareholder[]} */
shareholders;
}
export class CompanyLookupEnhancedDirector {
/** @param {{name?:string,address?:string,gender?:string,appointmentDate?:string,resignationDate?:string,dateOfBirth?:string,position?:string,idNumber?:number,currentDirectorships?:number,previousDirectorships?:number,totalDirectorships?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
name;
/** @type {string} */
address;
/** @type {string} */
gender;
/** @type {?string} */
appointmentDate;
/** @type {?string} */
resignationDate;
/** @type {?string} */
dateOfBirth;
/** @type {string} */
position;
/** @type {?number} */
idNumber;
/** @type {?number} */
currentDirectorships;
/** @type {?number} */
previousDirectorships;
/** @type {?number} */
totalDirectorships;
}
export class CompanyLookupEnhancedDirectors {
/** @param {{currentDirectors?:CompanyLookupEnhancedDirector[],previousDirectors?:CompanyLookupEnhancedDirector[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {CompanyLookupEnhancedDirector[]} */
currentDirectors;
/** @type {CompanyLookupEnhancedDirector[]} */
previousDirectors;
}
export class CompanyLookupEnhancedCompany {
/** @param {{country?:string,companyName?:string,companyNumber?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
country;
/** @type {string} */
companyName;
/** @type {string} */
companyNumber;
}
export class CompanyLookupEnhancedStructure {
/** @param {{parentCompanies?:CompanyLookupEnhancedCompany[],subsidiaryCompanies?:CompanyLookupEnhancedCompany[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {CompanyLookupEnhancedCompany[]} */
parentCompanies;
/** @type {CompanyLookupEnhancedCompany[]} */
subsidiaryCompanies;
}
export class CompanyLookupEnhancedCCJ {
/** @param {{date?:string,court?:string,amount?:number,caseNumber?:string,status?:string,datePaid?:string,incomingRecordDetails?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
date;
/** @type {string} */
court;
/** @type {?number} */
amount;
/** @type {string} */
caseNumber;
/** @type {string} */
status;
/** @type {string} */
datePaid;
/** @type {string} */
incomingRecordDetails;
}
export class CompanyLookupEnhancedCCJs {
/** @param {{possibleCCJs?:CompanyLookupEnhancedCCJ[],exactCCJs?:CompanyLookupEnhancedCCJ[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {CompanyLookupEnhancedCCJ[]} */
possibleCCJs;
/** @type {CompanyLookupEnhancedCCJ[]} */
exactCCJs;
}
export class CompanyLookupEnhancedEvent {
/** @param {{date?:string,description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
date;
/** @type {string} */
description;
}
export class CompanyLookupEnhancedCommentary {
/** @param {{text?:string,positiveOrNegative?:string,priority?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
text;
/** @type {string} */
positiveOrNegative;
/** @type {?number} */
priority;
}
export class CompanyLookupEnhancedCreditLimit {
/** @param {{date?:string,dateOrder?:number,amount?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
date;
/** @type {?number} */
dateOrder;
/** @type {?number} */
amount;
}
export class CompanyLookupEnhancedCreditRating {
/** @param {{date?:string,dateOrder?:number,amount?:number,shortDescription?:string,description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
date;
/** @type {?number} */
dateOrder;
/** @type {?number} */
amount;
/** @type {string} */
shortDescription;
/** @type {string} */
description;
}
export class CompanyLookupEnhancedCreditAccount {
/** @param {{creditLimitHistory?:CompanyLookupEnhancedCreditLimit[],creditRatingHistory?:CompanyLookupEnhancedCreditRating[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {CompanyLookupEnhancedCreditLimit[]} */
creditLimitHistory;
/** @type {CompanyLookupEnhancedCreditRating[]} */
creditRatingHistory;
}
export class CompanyLookupFinancialProfit {
/** @param {{turnover?:number,export?:number,costOfSales?:number,grossProfit?:number,wagesAndSalaries?:number,directorEmolument?:number,operatingProfit?:number,depreciation?:number,auditFees?:number,interestPayments?:number,pretaxProfit?:number,taxation?:number,profitAfterTax?:number,dividendsPayable?:number,retainedProfit?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
turnover;
/** @type {?number} */
export;
/** @type {?number} */
costOfSales;
/** @type {?number} */
grossProfit;
/** @type {?number} */
wagesAndSalaries;
/** @type {?number} */
directorEmolument;
/** @type {?number} */
operatingProfit;
/** @type {?number} */
depreciation;
/** @type {?number} */
auditFees;
/** @type {?number} */
interestPayments;
/** @type {?number} */
pretaxProfit;
/** @type {?number} */
taxation;
/** @type {?number} */
profitAfterTax;
/** @type {?number} */
dividendsPayable;
/** @type {?number} */
retainedProfit;
}
export class CompanyLookupFinancialBalance {
/** @param {{tangibleAccounts?:number,intangibleAssets?:number,totalFixedAssets?:number,stock?:number,tradeDebtors?:number,cash?:number,otherDebtors?:number,miscCurrentAssets?:number,totalCurrentAssets?:number,tradeCreditors?:number,bankLoansAndOverdrafts?:number,otherShortTermFinance?:number,miscCurrentLiabilities?:number,totalCurrentLiabilities?:number,bankLoansAndOverdraftsAndLTL?:number,otherLongTermFinance?:number,totalLongTermFinance?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
tangibleAccounts;
/** @type {?number} */
intangibleAssets;
/** @type {?number} */
totalFixedAssets;
/** @type {?number} */
stock;
/** @type {?number} */
tradeDebtors;
/** @type {?number} */
cash;
/** @type {?number} */
otherDebtors;
/** @type {?number} */
miscCurrentAssets;
/** @type {?number} */
totalCurrentAssets;
/** @type {?number} */
tradeCreditors;
/** @type {?number} */
bankLoansAndOverdrafts;
/** @type {?number} */
otherShortTermFinance;
/** @type {?number} */
miscCurrentLiabilities;
/** @type {?number} */
totalCurrentLiabilities;
/** @type {?number} */
bankLoansAndOverdraftsAndLTL;
/** @type {?number} */
otherLongTermFinance;
/** @type {?number} */
totalLongTermFinance;
}
export class CompanyLookupFinancialCapital {
/** @param {{calledUpSharedCapital?:number,profitAndLossAccountReserve?:number,revaluationReserve?:number,sundryReserves?:number,shareholderFunds?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
calledUpSharedCapital;
/** @type {?number} */
profitAndLossAccountReserve;
/** @type {?number} */
revaluationReserve;
/** @type {?number} */
sundryReserves;
/** @type {?number} */
shareholderFunds;
}
export class CompanyLookupFinancialOther {
/** @param {{netWorth?:number,netAssets?:number,workingCapital?:number,totalAssets?:number,totalLiabilities?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
netWorth;
/** @type {?number} */
netAssets;
/** @type {?number} */
workingCapital;
/** @type {?number} */
totalAssets;
/** @type {?number} */
totalLiabilities;
}
export class CompanyLookupFinancialCash {
/** @param {{netCashFlowFromOperations?:number,netCashFlowBeforeFinancing?:number,netCashFlowFromFinancing?:number,increaseInCash?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
netCashFlowFromOperations;
/** @type {?number} */
netCashFlowBeforeFinancing;
/** @type {?number} */
netCashFlowFromFinancing;
/** @type {?number} */
increaseInCash;
}
export class CompanyLookupFinancialMisc {
/** @param {{contingentLiability?:string,capitalEmployed?:number,numberOfEmployees?:number,auditors?:string,auditorComments?:string,bankers?:string,bankBranchCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
contingentLiability;
/** @type {?number} */
capitalEmployed;
/** @type {?number} */
numberOfEmployees;
/** @type {string} */
auditors;
/** @type {string} */
auditorComments;
/** @type {string} */
bankers;
/** @type {string} */
bankBranchCode;
}
export class CompanyLookupFinancialRatios {
/** @param {{preTaxProfitMargin?:number,currentRatio?:number,salesNetworkingCapital?:number,gearing?:number,equity?:number,creditorDays?:number,debtorDays?:number,liquidityAcidTest?:number,returnOnCapitalEmployed?:number,returnOnNetAssetsEmployed?:number,returnOnTotalAssetsEmployed?:number,currentDebtRatio?:number,totalDebtRatio?:number,stockTurnoverRatio?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
preTaxProfitMargin;
/** @type {?number} */
currentRatio;
/** @type {?number} */
salesNetworkingCapital;
/** @type {?number} */
gearing;
/** @type {?number} */
equity;
/** @type {?number} */
creditorDays;
/** @type {?number} */
debtorDays;
/** @type {?number} */
liquidityAcidTest;
/** @type {?number} */
returnOnCapitalEmployed;
/** @type {?number} */
returnOnNetAssetsEmployed;
/** @type {?number} */
returnOnTotalAssetsEmployed;
/** @type {?number} */
currentDebtRatio;
/** @type {?number} */
totalDebtRatio;
/** @type {?number} */
stockTurnoverRatio;
}
export class CompanyLookupEnhancedFinancialStatement {
/** @param {{yearEndDateOrder?:number,yearEndDate?:string,summaryNumberOfWeeks?:number,summaryCurrency?:string,summaryConsolidatedAccount?:string,profitAndLoss?:CompanyLookupFinancialProfit,balanceSheet?:CompanyLookupFinancialBalance,capitalAndReserves?:CompanyLookupFinancialCapital,other?:CompanyLookupFinancialOther,cash?:CompanyLookupFinancialCash,misc?:CompanyLookupFinancialMisc,ratios?:CompanyLookupFinancialRatios}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
yearEndDateOrder;
/** @type {?string} */
yearEndDate;
/** @type {?number} */
summaryNumberOfWeeks;
/** @type {string} */
summaryCurrency;
/** @type {string} */
summaryConsolidatedAccount;
/** @type {CompanyLookupFinancialProfit} */
profitAndLoss;
/** @type {CompanyLookupFinancialBalance} */
balanceSheet;
/** @type {CompanyLookupFinancialCapital} */
capitalAndReserves;
/** @type {CompanyLookupFinancialOther} */
other;
/** @type {CompanyLookupFinancialCash} */
cash;
/** @type {CompanyLookupFinancialMisc} */
misc;
/** @type {CompanyLookupFinancialRatios} */
ratios;
}
export class CompanyLookupEnhanced {
/** @param {{summary?:CompanyLookupEnhancedSummary,contactInformation?:CompanyLookupEnhancedContactInfo,sicCodes?:CompanyLookupEnhancedSicCode[],previousNames?:CompanyLookupEnhancedPreviousName[],shareStructure?:CompanyLookupEnhancedShareStructure,directors?:CompanyLookupEnhancedDirectors,groupStructure?:CompanyLookupEnhancedStructure,countyCourtJudgements?:CompanyLookupEnhancedCCJs,eventHistory?:CompanyLookupEnhancedEvent[],commentaries?:CompanyLookupEnhancedCommentary[],creditAccounts?:CompanyLookupEnhancedCreditAccount,financialStatements?:CompanyLookupEnhancedFinancialStatement[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {CompanyLookupEnhancedSummary} */
summary;
/** @type {CompanyLookupEnhancedContactInfo} */
contactInformation;
/** @type {CompanyLookupEnhancedSicCode[]} */
sicCodes;
/** @type {CompanyLookupEnhancedPreviousName[]} */
previousNames;
/** @type {CompanyLookupEnhancedShareStructure} */
shareStructure;
/** @type {CompanyLookupEnhancedDirectors} */
directors;
/** @type {CompanyLookupEnhancedStructure} */
groupStructure;
/** @type {CompanyLookupEnhancedCCJs} */
countyCourtJudgements;
/** @type {CompanyLookupEnhancedEvent[]} */
eventHistory;
/** @type {CompanyLookupEnhancedCommentary[]} */
commentaries;
/** @type {CompanyLookupEnhancedCreditAccount} */
creditAccounts;
/** @type {CompanyLookupEnhancedFinancialStatement[]} */
financialStatements;
}
export class CompanyLookupSearchRecord {
/** @param {{id?:number,searchCriteria?:SearchCriteria,selectedLists?:ArrayOfLists,date?:string,hasCompanyId?:boolean,hasCompanyDetails?:boolean,hasStartedSearches?:boolean,hasCompletedSearches?:boolean,companyDirectorsAndShareholders?:CompanyDirectorOrShareholder[],companySearchRecord?:SearchListItem,hasEnhancedInformation?:boolean,enhancedInformation?:CompanyLookupEnhanced}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {SearchCriteria} */
searchCriteria;
/** @type {ArrayOfLists} */
selectedLists;
/** @type {string} */
date;
/** @type {boolean} */
hasCompanyId;
/** @type {boolean} */
hasCompanyDetails;
/** @type {boolean} */
hasStartedSearches;
/** @type {boolean} */
hasCompletedSearches;
/** @type {CompanyDirectorOrShareholder[]} */
companyDirectorsAndShareholders;
/** @type {SearchListItem} */
companySearchRecord;
/** @type {boolean} */
hasEnhancedInformation;
/** @type {CompanyLookupEnhanced} */
enhancedInformation;
}
export class GetCompanyLookupData extends BaseResponse {
/** @param {{linkedTo?:ArrayOfLinkedTo,searchRecord?:CompanyLookupSearchRecord,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {ArrayOfLinkedTo} */
linkedTo;
/** @type {CompanyLookupSearchRecord} */
searchRecord;
}
export class GetCompanyLookupResponse {
/** @param {{data?:GetCompanyLookupData}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {GetCompanyLookupData} */
data;
}
export class GetCompanyLookupRequest {
/** @param {{subUserName?:string,id?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description If the search is being accessed by a sub user, specify their username here to validate they have permissions to view it */
subUserName;
/** @type {number} */
id;
}
export class GetCompanyLookup extends BaseRequest {
/** @param {{request?:GetCompanyLookupRequest,authentication?:Authentication}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {GetCompanyLookupRequest} */
request;
}
JavaScript GetCompanyLookup DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap12 suffix or ?format=soap12
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap12 HTTP/1.1
Host: api.sanctionssearch.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetCompanyLookup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request>
<Id>0</Id>
<SubUserName>String</SubUserName>
</Request>
</GetCompanyLookup>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetCompanyLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Data>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
<LinkedTo>
<LinkedTo>
<ClientId>0</ClientId>
<Date>0001-01-01T00:00:00</Date>
<Description>String</Description>
<Id>0</Id>
<IsArchived>false</IsArchived>
<Name>String</Name>
<Status>String</Status>
<Subtype>String</Subtype>
<Type>String</Type>
</LinkedTo>
</LinkedTo>
<SearchRecord>
<CompanyDirectorsAndShareholders>
<CompanyDirectorOrShareholder>
<AffectedByUpdate>false</AffectedByUpdate>
<ClientInResults>false</ClientInResults>
<ClientNotInResults>false</ClientNotInResults>
<DateSearched>0001-01-01T00:00:00</DateSearched>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<Id>0</Id>
<IsDirector>false</IsDirector>
<IsShareholder>false</IsShareholder>
<NumOfResults>0</NumOfResults>
<SearchCriteria>
<Address>String</Address>
<Country>String</Country>
<DateOfBirth>String</DateOfBirth>
<Name>String</Name>
<Nationality>String</Nationality>
<Reference>String</Reference>
</SearchCriteria>
<SearchType>String</SearchType>
</CompanyDirectorOrShareholder>
</CompanyDirectorsAndShareholders>
<CompanySearchRecord>
<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>
<NumOfResults>0</NumOfResults>
<SearchCriteria>
<Address>String</Address>
<Country>String</Country>
<DateOfBirth>String</DateOfBirth>
<Name>String</Name>
<Nationality>String</Nationality>
<Reference>String</Reference>
</SearchCriteria>
<SearchSources>
<SearchSource>
<IsAffectedByListUpdate>false</IsAffectedByListUpdate>
<ListId>String</ListId>
<ListName>String</ListName>
<ListShortName>String</ListShortName>
</SearchSource>
</SearchSources>
<SearchType>String</SearchType>
</CompanySearchRecord>
<Date>0001-01-01T00:00:00</Date>
<EnhancedInformation>
<Commentaries>
<CompanyLookupEnhancedCommentary>
<PositiveOrNegative>String</PositiveOrNegative>
<Priority>0</Priority>
<Text>String</Text>
</CompanyLookupEnhancedCommentary>
</Commentaries>
<ContactInformation>
<AdditionalContactInfo>
<BusinessClassification>String</BusinessClassification>
<ContactName>String</ContactName>
<EmailAddress>String</EmailAddress>
<Facebook>String</Facebook>
<FaxNumber>String</FaxNumber>
<GooglePlus>String</GooglePlus>
<LinkedIn>String</LinkedIn>
<Telephone>String</Telephone>
<Twitter>String</Twitter>
<WebAddress>String</WebAddress>
</AdditionalContactInfo>
<RegisteredAddress>
<Address1>String</Address1>
<Address2>String</Address2>
<Address3>String</Address3>
<Address4>String</Address4>
<FullAddress>String</FullAddress>
<PostCode>String</PostCode>
<Telephone>String</Telephone>
</RegisteredAddress>
<TradingAddresses>
<CompanyLookupEnhancedAddress>
<Address1>String</Address1>
<Address2>String</Address2>
<Address3>String</Address3>
<Address4>String</Address4>
<FullAddress>String</FullAddress>
<PostCode>String</PostCode>
<Telephone>String</Telephone>
</CompanyLookupEnhancedAddress>
</TradingAddresses>
<Websites>
<CompanyLookupEnhancedWebsite>
<Website>String</Website>
</CompanyLookupEnhancedWebsite>
</Websites>
</ContactInformation>
<CountyCourtJudgements>
<ExactCCJs>
<CompanyLookupEnhancedCCJ>
<Amount>0</Amount>
<CaseNumber>String</CaseNumber>
<Court>String</Court>
<Date>0001-01-01T00:00:00</Date>
<DatePaid>String</DatePaid>
<IncomingRecordDetails>String</IncomingRecordDetails>
<Status>String</Status>
</CompanyLookupEnhancedCCJ>
</ExactCCJs>
<PossibleCCJs>
<CompanyLookupEnhancedCCJ>
<Amount>0</Amount>
<CaseNumber>String</CaseNumber>
<Court>String</Court>
<Date>0001-01-01T00:00:00</Date>
<DatePaid>String</DatePaid>
<IncomingRecordDetails>String</IncomingRecordDetails>
<Status>String</Status>
</CompanyLookupEnhancedCCJ>
</PossibleCCJs>
</CountyCourtJudgements>
<CreditAccounts>
<CreditLimitHistory>
<CompanyLookupEnhancedCreditLimit>
<Amount>0</Amount>
<Date>0001-01-01T00:00:00</Date>
<DateOrder>0</DateOrder>
</CompanyLookupEnhancedCreditLimit>
</CreditLimitHistory>
<CreditRatingHistory>
<CompanyLookupEnhancedCreditRating>
<Amount>0</Amount>
<Date>0001-01-01T00:00:00</Date>
<DateOrder>0</DateOrder>
<Description>String</Description>
<ShortDescription>String</ShortDescription>
</CompanyLookupEnhancedCreditRating>
</CreditRatingHistory>
</CreditAccounts>
<Directors>
<CurrentDirectors>
<CompanyLookupEnhancedDirector>
<Address>String</Address>
<AppointmentDate>0001-01-01T00:00:00</AppointmentDate>
<CurrentDirectorships>0</CurrentDirectorships>
<DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
<Gender>String</Gender>
<IdNumber>0</IdNumber>
<Name>String</Name>
<Position>String</Position>
<PreviousDirectorships>0</PreviousDirectorships>
<ResignationDate>0001-01-01T00:00:00</ResignationDate>
<TotalDirectorships>0</TotalDirectorships>
</CompanyLookupEnhancedDirector>
</CurrentDirectors>
<PreviousDirectors>
<CompanyLookupEnhancedDirector>
<Address>String</Address>
<AppointmentDate>0001-01-01T00:00:00</AppointmentDate>
<CurrentDirectorships>0</CurrentDirectorships>
<DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
<Gender>String</Gender>
<IdNumber>0</IdNumber>
<Name>String</Name>
<Position>String</Position>
<PreviousDirectorships>0</PreviousDirectorships>
<ResignationDate>0001-01-01T00:00:00</ResignationDate>
<TotalDirectorships>0</TotalDirectorships>
</CompanyLookupEnhancedDirector>
</PreviousDirectors>
</Directors>
<EventHistory>
<CompanyLookupEnhancedEvent>
<Date>0001-01-01T00:00:00</Date>
<Description>String</Description>
</CompanyLookupEnhancedEvent>
</EventHistory>
<FinancialStatements>
<CompanyLookupEnhancedFinancialStatement>
<BalanceSheet>
<BankLoansAndOverdrafts>0</BankLoansAndOverdrafts>
<BankLoansAndOverdraftsAndLTL>0</BankLoansAndOverdraftsAndLTL>
<Cash>0</Cash>
<IntangibleAssets>0</IntangibleAssets>
<MiscCurrentAssets>0</MiscCurrentAssets>
<MiscCurrentLiabilities>0</MiscCurrentLiabilities>
<OtherDebtors>0</OtherDebtors>
<OtherLongTermFinance>0</OtherLongTermFinance>
<OtherShortTermFinance>0</OtherShortTermFinance>
<Stock>0</Stock>
<TangibleAccounts>0</TangibleAccounts>
<TotalCurrentAssets>0</TotalCurrentAssets>
<TotalCurrentLiabilities>0</TotalCurrentLiabilities>
<TotalFixedAssets>0</TotalFixedAssets>
<TotalLongTermFinance>0</TotalLongTermFinance>
<TradeCreditors>0</TradeCreditors>
<TradeDebtors>0</TradeDebtors>
</BalanceSheet>
<CapitalAndReserves>
<CalledUpSharedCapital>0</CalledUpSharedCapital>
<ProfitAndLossAccountReserve>0</ProfitAndLossAccountReserve>
<RevaluationReserve>0</RevaluationReserve>
<ShareholderFunds>0</ShareholderFunds>
<SundryReserves>0</SundryReserves>
</CapitalAndReserves>
<Cash>
<IncreaseInCash>0</IncreaseInCash>
<NetCashFlowBeforeFinancing>0</NetCashFlowBeforeFinancing>
<NetCashFlowFromFinancing>0</NetCashFlowFromFinancing>
<NetCashFlowFromOperations>0</NetCashFlowFromOperations>
</Cash>
<Misc>
<AuditorComments>String</AuditorComments>
<Auditors>String</Auditors>
<BankBranchCode>String</BankBranchCode>
<Bankers>String</Bankers>
<CapitalEmployed>0</CapitalEmployed>
<ContingentLiability>String</ContingentLiability>
<NumberOfEmployees>0</NumberOfEmployees>
</Misc>
<Other>
<NetAssets>0</NetAssets>
<NetWorth>0</NetWorth>
<TotalAssets>0</TotalAssets>
<TotalLiabilities>0</TotalLiabilities>
<WorkingCapital>0</WorkingCapital>
</Other>
<ProfitAndLoss>
<AuditFees>0</AuditFees>
<CostOfSales>0</CostOfSales>
<Depreciation>0</Depreciation>
<DirectorEmolument>0</DirectorEmolument>
<DividendsPayable>0</DividendsPayable>
<Export>0</Export>
<GrossProfit>0</GrossProfit>
<InterestPayments>0</InterestPayments>
<OperatingProfit>0</OperatingProfit>
<PretaxProfit>0</PretaxProfit>
<ProfitAfterTax>0</ProfitAfterTax>
<RetainedProfit>0</RetainedProfit>
<Taxation>0</Taxation>
<Turnover>0</Turnover>
<WagesAndSalaries>0</WagesAndSalaries>
</ProfitAndLoss>
<Ratios>
<CreditorDays>0</CreditorDays>
<CurrentDebtRatio>0</CurrentDebtRatio>
<CurrentRatio>0</CurrentRatio>
<DebtorDays>0</DebtorDays>
<Equity>0</Equity>
<Gearing>0</Gearing>
<LiquidityAcidTest>0</LiquidityAcidTest>
<PreTaxProfitMargin>0</PreTaxProfitMargin>
<ReturnOnCapitalEmployed>0</ReturnOnCapitalEmployed>
<ReturnOnNetAssetsEmployed>0</ReturnOnNetAssetsEmployed>
<ReturnOnTotalAssetsEmployed>0</ReturnOnTotalAssetsEmployed>
<SalesNetworkingCapital>0</SalesNetworkingCapital>
<StockTurnoverRatio>0</StockTurnoverRatio>
<TotalDebtRatio>0</TotalDebtRatio>
</Ratios>
<SummaryConsolidatedAccount>String</SummaryConsolidatedAccount>
<SummaryCurrency>String</SummaryCurrency>
<SummaryNumberOfWeeks>0</SummaryNumberOfWeeks>
<YearEndDate>0001-01-01T00:00:00</YearEndDate>
<YearEndDateOrder>0</YearEndDateOrder>
</CompanyLookupEnhancedFinancialStatement>
</FinancialStatements>
<GroupStructure>
<ParentCompanies>
<CompanyLookupEnhancedCompany>
<CompanyName>String</CompanyName>
<CompanyNumber>String</CompanyNumber>
<Country>String</Country>
</CompanyLookupEnhancedCompany>
</ParentCompanies>
<SubsidiaryCompanies>
<CompanyLookupEnhancedCompany>
<CompanyName>String</CompanyName>
<CompanyNumber>String</CompanyNumber>
<Country>String</Country>
</CompanyLookupEnhancedCompany>
</SubsidiaryCompanies>
</GroupStructure>
<PreviousNames>
<CompanyLookupEnhancedPreviousName>
<DateChanged>0001-01-01T00:00:00</DateChanged>
<Name>String</Name>
</CompanyLookupEnhancedPreviousName>
</PreviousNames>
<ShareStructure>
<IssuedShareCapital>0</IssuedShareCapital>
<Shareholders>
<CompanyLookupEnhancedShareholder>
<Address1>String</Address1>
<Address2>String</Address2>
<Address3>String</Address3>
<Address4>String</Address4>
<Address5>String</Address5>
<Currency>String</Currency>
<Forename>String</Forename>
<Number>0</Number>
<PostCode>String</PostCode>
<ShareClass>String</ShareClass>
<ShareType>String</ShareType>
<ShareholderType>String</ShareholderType>
<Surname>String</Surname>
<Title>String</Title>
<Value>0</Value>
</CompanyLookupEnhancedShareholder>
</Shareholders>
</ShareStructure>
<SicCodes>
<CompanyLookupEnhancedSicCode>
<SicCode2003>0</SicCode2003>
<SicCode2003Description>String</SicCode2003Description>
<SicCode2007>0</SicCode2007>
<SicCode2007Description>String</SicCode2007Description>
<Status>String</Status>
</CompanyLookupEnhancedSicCode>
</SicCodes>
<Summary>
<Address>String</Address>
<CompanyStatus>String</CompanyStatus>
<Country>String</Country>
<DateOfIncorporation>String</DateOfIncorporation>
<LatestAccounts>
<AccountCategory>String</AccountCategory>
<AccountLastMadeUpDate>0001-01-01T00:00:00</AccountLastMadeUpDate>
<AccountNextDueDate>0001-01-01T00:00:00</AccountNextDueDate>
<AccountRefDay>0</AccountRefDay>
<AccountRefMonth>0</AccountRefMonth>
<CreditLimit>0</CreditLimit>
<CreditRating>0</CreditRating>
<CreditRatingDescription>String</CreditRatingDescription>
<Currency>String</Currency>
<ReturnLastMadeUpDate>0001-01-01T00:00:00</ReturnLastMadeUpDate>
<ShareholdersEquity>0</ShareholdersEquity>
<Turnover>0</Turnover>
</LatestAccounts>
<Name>String</Name>
<PrincipleActivity>String</PrincipleActivity>
<RegistrationNumber>String</RegistrationNumber>
<SicCode>String</SicCode>
<SicDescription>String</SicDescription>
<Telephone>String</Telephone>
<TypeOfIncorporation>String</TypeOfIncorporation>
</Summary>
</EnhancedInformation>
<HasCompanyDetails>false</HasCompanyDetails>
<HasCompanyId>false</HasCompanyId>
<HasCompletedSearches>false</HasCompletedSearches>
<HasEnhancedInformation>false</HasEnhancedInformation>
<HasStartedSearches>false</HasStartedSearches>
<Id>0</Id>
<SearchCriteria>
<Address>String</Address>
<Country>String</Country>
<DateOfBirth>String</DateOfBirth>
<Name>String</Name>
<Nationality>String</Nationality>
<Reference>String</Reference>
</SearchCriteria>
<SelectedLists>
<ListId>String</ListId>
</SelectedLists>
</SearchRecord>
</Data>
</GetCompanyLookupResponse>
</soap12:Body>
</soap12:Envelope>