Sanctions Search API: v2

<back to all web services

AddCompanyLookup

CompanyLookup
The following routes are available for this service:
POST/companylookups/createCreate 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 AddCompanyLookupData 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 AddCompanyLookupResponse {
    /** @param {{data?:AddCompanyLookupData}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AddCompanyLookupData} */
    data;
}
export class AddCompanyLookupRequest {
    /** @param {{subUserName?:string,companyLookupId?:number,companyRegistrationNumber?:string,companyName?:string,companyAddress?:string,companyCountry?:string,performEnhancedSearch?: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 {?number} */
    companyLookupId;
    /** @type {string} */
    companyRegistrationNumber;
    /** @type {string} */
    companyName;
    /** @type {string} */
    companyAddress;
    /** @type {string} */
    companyCountry;
    /** @type {boolean} */
    performEnhancedSearch;
    /** @type {ArrayOfLists} */
    selectedLists;
    /**
     * @type {ArrayOfLinkedTo}
     * @description If the search should be linked to other searches, specify the them here */
    linkedTo;
}
export class AddCompanyLookup extends BaseRequest {
    /** @param {{request?:AddCompanyLookupRequest,authentication?:Authentication}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {AddCompanyLookupRequest} */
    request;
}

JavaScript AddCompanyLookup DTOs

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /companylookups/create HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"subUserName":"String","companyLookupId":0,"companyRegistrationNumber":"String","companyName":"String","companyAddress":"String","companyCountry":"String","performEnhancedSearch":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,"searchCriteria":{"name":"String","address":"String","country":"String","dateOfBirth":"String","nationality":"String","reference":"String"},"selectedLists":["String"],"date":"\/Date(-62135596800000-0000)\/","hasCompanyId":false,"hasCompanyDetails":false,"hasStartedSearches":false,"hasCompletedSearches":false,"companyDirectorsAndShareholders":[{"id":0,"searchType":"String","dateSearched":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","numOfResults":0,"clientInResults":false,"clientNotInResults":false,"affectedByUpdate":false,"searchCriteria":{"name":"String","address":"String","country":"String","dateOfBirth":"String","nationality":"String","reference":"String"},"isDirector":false,"isShareholder":false}],"companySearchRecord":{"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"},"searchSources":[{"listId":"String","listName":"String","listShortName":"String","isAffectedByListUpdate":false}]},"hasEnhancedInformation":false,"enhancedInformation":{"summary":{"name":"String","country":"String","registrationNumber":"String","dateOfIncorporation":"String","typeOfIncorporation":"String","companyStatus":"String","address":"String","telephone":"String","sicCode":"String","sicDescription":"String","principleActivity":"String","latestAccounts":{"currency":"String","turnover":0,"shareholdersEquity":0,"creditRating":0,"creditLimit":0,"creditRatingDescription":"String","accountRefDay":0,"accountRefMonth":0,"accountNextDueDate":"\/Date(-62135596800000-0000)\/","accountLastMadeUpDate":"\/Date(-62135596800000-0000)\/","accountCategory":"String","returnLastMadeUpDate":"\/Date(-62135596800000-0000)\/"}},"contactInformation":{"registeredAddress":{"fullAddress":"String","address1":"String","address2":"String","address3":"String","address4":"String","postCode":"String","telephone":"String"},"tradingAddresses":[{"fullAddress":"String","address1":"String","address2":"String","address3":"String","address4":"String","postCode":"String","telephone":"String"}],"websites":[{"website":"String"}],"additionalContactInfo":{"telephone":"String","faxNumber":"String","emailAddress":"String","webAddress":"String","twitter":"String","facebook":"String","googlePlus":"String","linkedIn":"String","contactName":"String","businessClassification":"String"}},"sicCodes":[{"sicCode2003":0,"sicCode2003Description":"String","sicCode2007":0,"sicCode2007Description":"String","status":"String"}],"previousNames":[{"dateChanged":"\/Date(-62135596800000-0000)\/","name":"String"}],"shareStructure":{"issuedShareCapital":0,"shareholders":[{"title":"String","forename":"String","surname":"String","address1":"String","address2":"String","address3":"String","address4":"String","address5":"String","postCode":"String","shareType":"String","number":0,"value":0,"currency":"String","shareholderType":"String","shareClass":"String"}]},"directors":{"currentDirectors":[{"name":"String","address":"String","gender":"String","appointmentDate":"\/Date(-62135596800000-0000)\/","resignationDate":"\/Date(-62135596800000-0000)\/","dateOfBirth":"\/Date(-62135596800000-0000)\/","position":"String","idNumber":0,"currentDirectorships":0,"previousDirectorships":0,"totalDirectorships":0}],"previousDirectors":[{"name":"String","address":"String","gender":"String","appointmentDate":"\/Date(-62135596800000-0000)\/","resignationDate":"\/Date(-62135596800000-0000)\/","dateOfBirth":"\/Date(-62135596800000-0000)\/","position":"String","idNumber":0,"currentDirectorships":0,"previousDirectorships":0,"totalDirectorships":0}]},"groupStructure":{"parentCompanies":[{"country":"String","companyName":"String","companyNumber":"String"}],"subsidiaryCompanies":[{"country":"String","companyName":"String","companyNumber":"String"}]},"countyCourtJudgements":{"possibleCCJs":[{"date":"\/Date(-62135596800000-0000)\/","court":"String","amount":0,"caseNumber":"String","status":"String","datePaid":"String","incomingRecordDetails":"String"}],"exactCCJs":[{"date":"\/Date(-62135596800000-0000)\/","court":"String","amount":0,"caseNumber":"String","status":"String","datePaid":"String","incomingRecordDetails":"String"}]},"eventHistory":[{"date":"\/Date(-62135596800000-0000)\/","description":"String"}],"commentaries":[{"text":"String","positiveOrNegative":"String","priority":0}],"creditAccounts":{"creditLimitHistory":[{"date":"\/Date(-62135596800000-0000)\/","dateOrder":0,"amount":0}],"creditRatingHistory":[{"date":"\/Date(-62135596800000-0000)\/","dateOrder":0,"amount":0,"shortDescription":"String","description":"String"}]},"financialStatements":[{"yearEndDateOrder":0,"yearEndDate":"\/Date(-62135596800000-0000)\/","summaryNumberOfWeeks":0,"summaryCurrency":"String","summaryConsolidatedAccount":"String","profitAndLoss":{"turnover":0,"export":0,"costOfSales":0,"grossProfit":0,"wagesAndSalaries":0,"directorEmolument":0,"operatingProfit":0,"depreciation":0,"auditFees":0,"interestPayments":0,"pretaxProfit":0,"taxation":0,"profitAfterTax":0,"dividendsPayable":0,"retainedProfit":0},"balanceSheet":{"tangibleAccounts":0,"intangibleAssets":0,"totalFixedAssets":0,"stock":0,"tradeDebtors":0,"cash":0,"otherDebtors":0,"miscCurrentAssets":0,"totalCurrentAssets":0,"tradeCreditors":0,"bankLoansAndOverdrafts":0,"otherShortTermFinance":0,"miscCurrentLiabilities":0,"totalCurrentLiabilities":0,"bankLoansAndOverdraftsAndLTL":0,"otherLongTermFinance":0,"totalLongTermFinance":0},"capitalAndReserves":{"calledUpSharedCapital":0,"profitAndLossAccountReserve":0,"revaluationReserve":0,"sundryReserves":0,"shareholderFunds":0},"other":{"netWorth":0,"netAssets":0,"workingCapital":0,"totalAssets":0,"totalLiabilities":0},"cash":{"netCashFlowFromOperations":0,"netCashFlowBeforeFinancing":0,"netCashFlowFromFinancing":0,"increaseInCash":0},"misc":{"contingentLiability":"String","capitalEmployed":0,"numberOfEmployees":0,"auditors":"String","auditorComments":"String","bankers":"String","bankBranchCode":"String"},"ratios":{"preTaxProfitMargin":0,"currentRatio":0,"salesNetworkingCapital":0,"gearing":0,"equity":0,"creditorDays":0,"debtorDays":0,"liquidityAcidTest":0,"returnOnCapitalEmployed":0,"returnOnNetAssetsEmployed":0,"returnOnTotalAssetsEmployed":0,"currentDebtRatio":0,"totalDebtRatio":0,"stockTurnoverRatio":0}}]}},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}