Sanctions Search API: v2

<back to all web services

GetCompanyLookup

CompanyLookup
The following routes are available for this service:
POST/companylookups/getGet a company lookup
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class GetCompanyLookup : BaseRequest()
{
    @DataMember
    var request:GetCompanyLookupRequest? = null
}

@DataContract
open class BaseRequest : IBaseRequest
{
    /**
    * The authentication credentials
    */
    @DataMember
    @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    var authentication:Authentication? = null
}

@DataContract
open class Authentication
{
    /**
    * The API User ID provided by us when you signed up to use our API
    */
    @DataMember
    @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    var apiUserId:String? = null

    /**
    * The API User Key provided by us when you signed up to use our API
    */
    @DataMember
    @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    var apiUserKey:String? = null
}

open class GetCompanyLookupRequest
{
    /**
    * If the search is being accessed by a sub user, specify their username here to validate they have permissions to view it
    */
    @ApiMember(Description="If the search is being accessed by a sub user, specify their username here to validate they have permissions to view it")
    var subUserName:String? = null

    var id:Int? = null
}

@DataContract
open class GetCompanyLookupResponse
{
    @DataMember
    @SerializedName("data") var Data:GetCompanyLookupData? = null
}

open class GetCompanyLookupData : BaseResponse(), IBaseSearchResponse
{
    var linkedTo:ArrayOfLinkedTo? = null
    var searchRecord:CompanyLookupSearchRecord? = null
}

open class BaseResponse : IBaseDataResponse, IHasResponseStatus
{
    /**
    * The status of the response
    */
    @ApiMember(Description="The status of the response")
    var responseStatus:ResponseStatus? = null
}

open class ArrayOfResponseError : ArrayList<ResponseError>()
{
}

open class ArrayOfLinkedTo : ArrayList<LinkedTo>()
{
}

open class LinkedTo
{
    var clientId:Int? = null
    var id:Long? = null
    @SerializedName("type") var Type:String? = null
    var subtype:String? = null
    var status:String? = null
    var description:String? = null
    var isArchived:Boolean? = null
    var name:String? = null
    var date:Date? = null
}

open class CompanyLookupSearchRecord
{
    var id:Int? = null
    var searchCriteria:SearchCriteria? = null
    var selectedLists:ArrayOfLists? = null
    var date:Date? = null
    var hasCompanyId:Boolean? = null
    var hasCompanyDetails:Boolean? = null
    var hasStartedSearches:Boolean? = null
    var hasCompletedSearches:Boolean? = null
    var companyDirectorsAndShareholders:ArrayList<CompanyDirectorOrShareholder> = ArrayList<CompanyDirectorOrShareholder>()
    var companySearchRecord:SearchListItem? = null
    var hasEnhancedInformation:Boolean? = null
    var enhancedInformation:CompanyLookupEnhanced? = null
}

open class SearchCriteria
{
    var name:String? = null
    var address:String? = null
    var country:String? = null
    var dateOfBirth:String? = null
    var nationality:String? = null
    var reference:String? = null
}

open class ArrayOfLists : ArrayList<String>()
{
}

open class CompanyDirectorOrShareholder
{
    var id:Long? = null
    var searchType:String? = null
    var dateSearched:Date? = null
    var dateUpdated:Date? = null
    var numOfResults:Int? = null
    var clientInResults:Boolean? = null
    var clientNotInResults:Boolean? = null
    var affectedByUpdate:Boolean? = null
    var searchCriteria:SearchCriteria? = null
    var isDirector:Boolean? = null
    var isShareholder:Boolean? = null
}

open class SearchListItem
{
    var id:Long? = null
    var searchType:String? = null
    var dateSearched:Date? = null
    var dateUpdated:Date? = null
    var dateArchived:Date? = null
    var isArchived:Boolean? = null
    var numOfResults:Int? = null
    var clientInResults:Boolean? = null
    var clientNotInResults:Boolean? = null
    var affectedByUpdate:Boolean? = null
    var searchCriteria:SearchCriteria? = null
    var searchSources:ArrayList<SearchSource> = ArrayList<SearchSource>()
}

open class SearchSource
{
    var listId:String? = null
    var listName:String? = null
    var listShortName:String? = null
    var isAffectedByListUpdate:Boolean? = null
}

open class CompanyLookupEnhanced
{
    var summary:CompanyLookupEnhancedSummary? = null
    var contactInformation:CompanyLookupEnhancedContactInfo? = null
    var sicCodes:ArrayList<CompanyLookupEnhancedSicCode> = ArrayList<CompanyLookupEnhancedSicCode>()
    var previousNames:ArrayList<CompanyLookupEnhancedPreviousName> = ArrayList<CompanyLookupEnhancedPreviousName>()
    var shareStructure:CompanyLookupEnhancedShareStructure? = null
    var directors:CompanyLookupEnhancedDirectors? = null
    var groupStructure:CompanyLookupEnhancedStructure? = null
    var countyCourtJudgements:CompanyLookupEnhancedCCJs? = null
    var eventHistory:ArrayList<CompanyLookupEnhancedEvent> = ArrayList<CompanyLookupEnhancedEvent>()
    var commentaries:ArrayList<CompanyLookupEnhancedCommentary> = ArrayList<CompanyLookupEnhancedCommentary>()
    var creditAccounts:CompanyLookupEnhancedCreditAccount? = null
    var financialStatements:ArrayList<CompanyLookupEnhancedFinancialStatement> = ArrayList<CompanyLookupEnhancedFinancialStatement>()
}

open class CompanyLookupEnhancedSummary
{
    var name:String? = null
    var country:String? = null
    var registrationNumber:String? = null
    var dateOfIncorporation:String? = null
    var typeOfIncorporation:String? = null
    var companyStatus:String? = null
    var address:String? = null
    var telephone:String? = null
    var sicCode:String? = null
    var sicDescription:String? = null
    var principleActivity:String? = null
    var latestAccounts:CompanyLookupEnhancedLatestAccounts? = null
}

open class CompanyLookupEnhancedLatestAccounts
{
    var currency:String? = null
    var turnover:BigDecimal? = null
    var shareholdersEquity:BigDecimal? = null
    var creditRating:Int? = null
    var creditLimit:Int? = null
    var creditRatingDescription:String? = null
    var accountRefDay:Int? = null
    var accountRefMonth:Int? = null
    var accountNextDueDate:Date? = null
    var accountLastMadeUpDate:Date? = null
    var accountCategory:String? = null
    var returnLastMadeUpDate:Date? = null
}

open class CompanyLookupEnhancedContactInfo
{
    var registeredAddress:CompanyLookupEnhancedAddress? = null
    var tradingAddresses:ArrayList<CompanyLookupEnhancedAddress> = ArrayList<CompanyLookupEnhancedAddress>()
    var websites:ArrayList<CompanyLookupEnhancedWebsite> = ArrayList<CompanyLookupEnhancedWebsite>()
    var additionalContactInfo:CompanyLookupEnhancedAdditionalContact? = null
}

open class CompanyLookupEnhancedAddress
{
    var fullAddress:String? = null
    var address1:String? = null
    var address2:String? = null
    var address3:String? = null
    var address4:String? = null
    var postCode:String? = null
    var telephone:String? = null
}

open class CompanyLookupEnhancedWebsite
{
    var website:String? = null
}

open class CompanyLookupEnhancedAdditionalContact
{
    var telephone:String? = null
    var faxNumber:String? = null
    var emailAddress:String? = null
    var webAddress:String? = null
    var twitter:String? = null
    var facebook:String? = null
    var googlePlus:String? = null
    var linkedIn:String? = null
    var contactName:String? = null
    var businessClassification:String? = null
}

open class CompanyLookupEnhancedSicCode
{
    var sicCode2003:Int? = null
    var sicCode2003Description:String? = null
    var sicCode2007:Int? = null
    var sicCode2007Description:String? = null
    var status:String? = null
}

open class CompanyLookupEnhancedPreviousName
{
    var dateChanged:Date? = null
    var name:String? = null
}

open class CompanyLookupEnhancedShareStructure
{
    var issuedShareCapital:BigDecimal? = null
    var shareholders:ArrayList<CompanyLookupEnhancedShareholder> = ArrayList<CompanyLookupEnhancedShareholder>()
}

open class CompanyLookupEnhancedShareholder
{
    var title:String? = null
    var forename:String? = null
    var surname:String? = null
    var address1:String? = null
    var address2:String? = null
    var address3:String? = null
    var address4:String? = null
    var address5:String? = null
    var postCode:String? = null
    var shareType:String? = null
    var number:BigDecimal? = null
    var value:BigDecimal? = null
    var currency:String? = null
    var shareholderType:String? = null
    var shareClass:String? = null
}

open class CompanyLookupEnhancedDirectors
{
    var currentDirectors:ArrayList<CompanyLookupEnhancedDirector> = ArrayList<CompanyLookupEnhancedDirector>()
    var previousDirectors:ArrayList<CompanyLookupEnhancedDirector> = ArrayList<CompanyLookupEnhancedDirector>()
}

open class CompanyLookupEnhancedDirector
{
    var name:String? = null
    var address:String? = null
    var gender:String? = null
    var appointmentDate:Date? = null
    var resignationDate:Date? = null
    var dateOfBirth:Date? = null
    var position:String? = null
    var idNumber:Int? = null
    var currentDirectorships:Int? = null
    var previousDirectorships:Int? = null
    var totalDirectorships:Int? = null
}

open class CompanyLookupEnhancedStructure
{
    var parentCompanies:ArrayList<CompanyLookupEnhancedCompany> = ArrayList<CompanyLookupEnhancedCompany>()
    var subsidiaryCompanies:ArrayList<CompanyLookupEnhancedCompany> = ArrayList<CompanyLookupEnhancedCompany>()
}

open class CompanyLookupEnhancedCompany
{
    var country:String? = null
    var companyName:String? = null
    var companyNumber:String? = null
}

open class CompanyLookupEnhancedCCJs
{
    var possibleCCJs:ArrayList<CompanyLookupEnhancedCCJ> = ArrayList<CompanyLookupEnhancedCCJ>()
    var exactCCJs:ArrayList<CompanyLookupEnhancedCCJ> = ArrayList<CompanyLookupEnhancedCCJ>()
}

open class CompanyLookupEnhancedCCJ
{
    var date:Date? = null
    var court:String? = null
    var amount:BigDecimal? = null
    var caseNumber:String? = null
    var status:String? = null
    var datePaid:String? = null
    var incomingRecordDetails:String? = null
}

open class CompanyLookupEnhancedEvent
{
    var date:Date? = null
    var description:String? = null
}

open class CompanyLookupEnhancedCommentary
{
    var text:String? = null
    var positiveOrNegative:String? = null
    var priority:Int? = null
}

open class CompanyLookupEnhancedCreditAccount
{
    var creditLimitHistory:ArrayList<CompanyLookupEnhancedCreditLimit> = ArrayList<CompanyLookupEnhancedCreditLimit>()
    var creditRatingHistory:ArrayList<CompanyLookupEnhancedCreditRating> = ArrayList<CompanyLookupEnhancedCreditRating>()
}

open class CompanyLookupEnhancedCreditLimit
{
    var date:Date? = null
    var dateOrder:Int? = null
    var amount:Int? = null
}

open class CompanyLookupEnhancedCreditRating
{
    var date:Date? = null
    var dateOrder:Int? = null
    var amount:Int? = null
    var shortDescription:String? = null
    var description:String? = null
}

open class CompanyLookupEnhancedFinancialStatement
{
    var yearEndDateOrder:Int? = null
    var yearEndDate:Date? = null
    var summaryNumberOfWeeks:Int? = null
    var summaryCurrency:String? = null
    var summaryConsolidatedAccount:String? = null
    var profitAndLoss:CompanyLookupFinancialProfit? = null
    var balanceSheet:CompanyLookupFinancialBalance? = null
    var capitalAndReserves:CompanyLookupFinancialCapital? = null
    var other:CompanyLookupFinancialOther? = null
    var cash:CompanyLookupFinancialCash? = null
    var misc:CompanyLookupFinancialMisc? = null
    var ratios:CompanyLookupFinancialRatios? = null
}

open class CompanyLookupFinancialProfit
{
    var turnover:BigDecimal? = null
    var export:BigDecimal? = null
    var costOfSales:BigDecimal? = null
    var grossProfit:BigDecimal? = null
    var wagesAndSalaries:BigDecimal? = null
    var directorEmolument:BigDecimal? = null
    var operatingProfit:BigDecimal? = null
    var depreciation:BigDecimal? = null
    var auditFees:BigDecimal? = null
    var interestPayments:BigDecimal? = null
    var pretaxProfit:BigDecimal? = null
    var taxation:BigDecimal? = null
    var profitAfterTax:BigDecimal? = null
    var dividendsPayable:BigDecimal? = null
    var retainedProfit:BigDecimal? = null
}

open class CompanyLookupFinancialBalance
{
    var tangibleAccounts:BigDecimal? = null
    var intangibleAssets:BigDecimal? = null
    var totalFixedAssets:BigDecimal? = null
    var stock:BigDecimal? = null
    var tradeDebtors:BigDecimal? = null
    var cash:BigDecimal? = null
    var otherDebtors:BigDecimal? = null
    var miscCurrentAssets:BigDecimal? = null
    var totalCurrentAssets:BigDecimal? = null
    var tradeCreditors:BigDecimal? = null
    var bankLoansAndOverdrafts:BigDecimal? = null
    var otherShortTermFinance:BigDecimal? = null
    var miscCurrentLiabilities:BigDecimal? = null
    var totalCurrentLiabilities:BigDecimal? = null
    var bankLoansAndOverdraftsAndLTL:BigDecimal? = null
    var otherLongTermFinance:BigDecimal? = null
    var totalLongTermFinance:BigDecimal? = null
}

open class CompanyLookupFinancialCapital
{
    var calledUpSharedCapital:BigDecimal? = null
    var profitAndLossAccountReserve:BigDecimal? = null
    var revaluationReserve:BigDecimal? = null
    var sundryReserves:BigDecimal? = null
    var shareholderFunds:BigDecimal? = null
}

open class CompanyLookupFinancialOther
{
    var netWorth:BigDecimal? = null
    var netAssets:BigDecimal? = null
    var workingCapital:BigDecimal? = null
    var totalAssets:BigDecimal? = null
    var totalLiabilities:BigDecimal? = null
}

open class CompanyLookupFinancialCash
{
    var netCashFlowFromOperations:BigDecimal? = null
    var netCashFlowBeforeFinancing:BigDecimal? = null
    var netCashFlowFromFinancing:BigDecimal? = null
    var increaseInCash:BigDecimal? = null
}

open class CompanyLookupFinancialMisc
{
    var contingentLiability:String? = null
    var capitalEmployed:BigDecimal? = null
    var numberOfEmployees:BigDecimal? = null
    var auditors:String? = null
    var auditorComments:String? = null
    var bankers:String? = null
    var bankBranchCode:String? = null
}

open class CompanyLookupFinancialRatios
{
    var preTaxProfitMargin:BigDecimal? = null
    var currentRatio:BigDecimal? = null
    var salesNetworkingCapital:BigDecimal? = null
    var gearing:BigDecimal? = null
    var equity:BigDecimal? = null
    var creditorDays:BigDecimal? = null
    var debtorDays:BigDecimal? = null
    var liquidityAcidTest:BigDecimal? = null
    var returnOnCapitalEmployed:BigDecimal? = null
    var returnOnNetAssetsEmployed:BigDecimal? = null
    var returnOnTotalAssetsEmployed:BigDecimal? = null
    var currentDebtRatio:BigDecimal? = null
    var totalDebtRatio:BigDecimal? = null
    var stockTurnoverRatio:BigDecimal? = null
}

Kotlin GetCompanyLookup 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/get HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"subUserName":"String","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,"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"}}}}