Sanctions Search API: v2

GetCompanyLookup

CompanyLookup

The following routes are available for this service:
POST	/companylookups/get	Get a company lookup

**GetCompanyLookup** Parameters:
Name	Parameter	Data Type	Required	Description
Request	body	GetCompanyLookupRequest	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Authentication	header, body	Authentication	Yes	The authentication credentials

**Authentication** Parameters:
Name	Parameter	Data Type	Required	Description
ApiUserId	header, body	string	Yes	The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)
ApiUserKey	header, body	string	Yes	The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)
UserId	header, body	string	No	The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).

**GetCompanyLookupRequest** Parameters:
Name	Parameter	Data Type	Required	Description
SubUserName	form	string	No	If the search is being accessed by a sub user, specify their username here to validate they have permissions to view it
Id	form	int	No

**GetCompanyLookupResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	GetCompanyLookupData	No

**GetCompanyLookupData** Parameters:
Name	Parameter	Data Type	Required	Description
LinkedTo	form	ArrayOfLinkedTo	No
SearchRecord	form	CompanyLookupSearchRecord	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No	The status of the response

**ResponseStatus** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StackTrace	form	string	No
Errors	form	ArrayOfResponseError	No
Meta	form	Dictionary<string, string>	No

**ResponseError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
FieldName	form	string	No
Message	form	string	No
Meta	form	Dictionary<string, string>	No

**LinkedTo** Parameters:
Name	Parameter	Data Type	Required
ClientId	form	int?	No
Id	form	long?	No
Type	form	string	No
Subtype	form	string	No
Status	form	string	No
Description	form	string	No
IsArchived	form	bool?	No
Name	form	string	No
Date	form	DateTime?	No

**CompanyLookupSearchRecord** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
SearchCriteria	form	SearchCriteria	No
SelectedLists	form	ArrayOfLists	No
Date	form	DateTime	No
HasCompanyId	form	bool	No
HasCompanyDetails	form	bool	No
HasStartedSearches	form	bool	No
HasCompletedSearches	form	bool	No
CompanyDirectorsAndShareholders	form	List<CompanyDirectorOrShareholder>	No
CompanySearchRecord	form	SearchListItem	No
HasEnhancedInformation	form	bool	No
EnhancedInformation	form	CompanyLookupEnhanced	No

**SearchCriteria** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Address	form	string	No
Country	form	string	No
DateOfBirth	form	string	No
Nationality	form	string	No
Reference	form	string	No

**CompanyDirectorOrShareholder** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
SearchType	form	string	No
DateSearched	form	DateTime	No
DateUpdated	form	DateTime	No
NumOfResults	form	int	No
ClientInResults	form	bool	No
ClientNotInResults	form	bool	No
AffectedByUpdate	form	bool	No
SearchCriteria	form	SearchCriteria	No
IsDirector	form	bool	No
IsShareholder	form	bool	No

**SearchListItem** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
SearchType	form	string	No
DateSearched	form	DateTime	No
DateUpdated	form	DateTime	No
DateArchived	form	DateTime?	No
IsArchived	form	bool	No
NumOfResults	form	int	No
ClientInResults	form	bool	No
ClientNotInResults	form	bool	No
AffectedByUpdate	form	bool	No
SearchCriteria	form	SearchCriteria	No
SearchSources	form	List<SearchSource>	No

**SearchSource** Parameters:
Name	Parameter	Data Type	Required
ListId	form	string	No
ListName	form	string	No
ListShortName	form	string	No
IsAffectedByListUpdate	form	bool?	No

**CompanyLookupEnhanced** Parameters:
Name	Parameter	Data Type	Required
Summary	form	CompanyLookupEnhancedSummary	No
ContactInformation	form	CompanyLookupEnhancedContactInfo	No
SicCodes	form	List<CompanyLookupEnhancedSicCode>	No
PreviousNames	form	List<CompanyLookupEnhancedPreviousName>	No
ShareStructure	form	CompanyLookupEnhancedShareStructure	No
Directors	form	CompanyLookupEnhancedDirectors	No
GroupStructure	form	CompanyLookupEnhancedStructure	No
CountyCourtJudgements	form	CompanyLookupEnhancedCCJs	No
EventHistory	form	List<CompanyLookupEnhancedEvent>	No
Commentaries	form	List<CompanyLookupEnhancedCommentary>	No
CreditAccounts	form	CompanyLookupEnhancedCreditAccount	No
FinancialStatements	form	List<CompanyLookupEnhancedFinancialStatement>	No

**CompanyLookupEnhancedSummary** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Country	form	string	No
RegistrationNumber	form	string	No
DateOfIncorporation	form	string	No
TypeOfIncorporation	form	string	No
CompanyStatus	form	string	No
Address	form	string	No
Telephone	form	string	No
SicCode	form	string	No
SicDescription	form	string	No
PrincipleActivity	form	string	No
LatestAccounts	form	CompanyLookupEnhancedLatestAccounts	No

**CompanyLookupEnhancedLatestAccounts** Parameters:
Name	Parameter	Data Type	Required
Currency	form	string	No
Turnover	form	decimal?	No
ShareholdersEquity	form	decimal?	No
CreditRating	form	int?	No
CreditLimit	form	int?	No
CreditRatingDescription	form	string	No
AccountRefDay	form	int?	No
AccountRefMonth	form	int?	No
AccountNextDueDate	form	DateTime?	No
AccountLastMadeUpDate	form	DateTime?	No
AccountCategory	form	string	No
ReturnLastMadeUpDate	form	DateTime?	No

**CompanyLookupEnhancedContactInfo** Parameters:
Name	Parameter	Data Type	Required
RegisteredAddress	form	CompanyLookupEnhancedAddress	No
TradingAddresses	form	List<CompanyLookupEnhancedAddress>	No
Websites	form	List<CompanyLookupEnhancedWebsite>	No
AdditionalContactInfo	form	CompanyLookupEnhancedAdditionalContact	No

**CompanyLookupEnhancedAddress** Parameters:
Name	Parameter	Data Type	Required
FullAddress	form	string	No
Address1	form	string	No
Address2	form	string	No
Address3	form	string	No
Address4	form	string	No
PostCode	form	string	No
Telephone	form	string	No

**CompanyLookupEnhancedWebsite** Parameters:
Name	Parameter	Data Type	Required	Description
Website	form	string	No

**CompanyLookupEnhancedAdditionalContact** Parameters:
Name	Parameter	Data Type	Required
Telephone	form	string	No
FaxNumber	form	string	No
EmailAddress	form	string	No
WebAddress	form	string	No
Twitter	form	string	No
Facebook	form	string	No
GooglePlus	form	string	No
LinkedIn	form	string	No
ContactName	form	string	No
BusinessClassification	form	string	No

**CompanyLookupEnhancedSicCode** Parameters:
Name	Parameter	Data Type	Required
SicCode2003	form	int?	No
SicCode2003Description	form	string	No
SicCode2007	form	int?	No
SicCode2007Description	form	string	No
Status	form	string	No

**CompanyLookupEnhancedPreviousName** Parameters:
Name	Parameter	Data Type	Required	Description
DateChanged	form	DateTime?	No
Name	form	string	No

**CompanyLookupEnhancedShareStructure** Parameters:
Name	Parameter	Data Type	Required	Description
IssuedShareCapital	form	decimal?	No
Shareholders	form	List<CompanyLookupEnhancedShareholder>	No

**CompanyLookupEnhancedShareholder** Parameters:
Name	Parameter	Data Type	Required
Title	form	string	No
Forename	form	string	No
Surname	form	string	No
Address1	form	string	No
Address2	form	string	No
Address3	form	string	No
Address4	form	string	No
Address5	form	string	No
PostCode	form	string	No
ShareType	form	string	No
Number	form	decimal?	No
Value	form	decimal?	No
Currency	form	string	No
ShareholderType	form	string	No
ShareClass	form	string	No

**CompanyLookupEnhancedDirectors** Parameters:
Name	Parameter	Data Type	Required	Description
CurrentDirectors	form	List<CompanyLookupEnhancedDirector>	No
PreviousDirectors	form	List<CompanyLookupEnhancedDirector>	No

**CompanyLookupEnhancedDirector** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Address	form	string	No
Gender	form	string	No
AppointmentDate	form	DateTime?	No
ResignationDate	form	DateTime?	No
DateOfBirth	form	DateTime?	No
Position	form	string	No
IdNumber	form	int?	No
CurrentDirectorships	form	int?	No
PreviousDirectorships	form	int?	No
TotalDirectorships	form	int?	No

**CompanyLookupEnhancedStructure** Parameters:
Name	Parameter	Data Type	Required	Description
ParentCompanies	form	List<CompanyLookupEnhancedCompany>	No
SubsidiaryCompanies	form	List<CompanyLookupEnhancedCompany>	No

**CompanyLookupEnhancedCompany** Parameters:
Name	Parameter	Data Type	Required
Country	form	string	No
CompanyName	form	string	No
CompanyNumber	form	string	No

**CompanyLookupEnhancedCCJs** Parameters:
Name	Parameter	Data Type	Required	Description
PossibleCCJs	form	List<CompanyLookupEnhancedCCJ>	No
ExactCCJs	form	List<CompanyLookupEnhancedCCJ>	No

**CompanyLookupEnhancedCCJ** Parameters:
Name	Parameter	Data Type	Required
Date	form	DateTime?	No
Court	form	string	No
Amount	form	decimal?	No
CaseNumber	form	string	No
Status	form	string	No
DatePaid	form	string	No
IncomingRecordDetails	form	string	No

**CompanyLookupEnhancedEvent** Parameters:
Name	Parameter	Data Type	Required	Description
Date	form	DateTime?	No
Description	form	string	No

**CompanyLookupEnhancedCommentary** Parameters:
Name	Parameter	Data Type	Required
Text	form	string	No
PositiveOrNegative	form	string	No
Priority	form	int?	No

**CompanyLookupEnhancedCreditAccount** Parameters:
Name	Parameter	Data Type	Required	Description
CreditLimitHistory	form	List<CompanyLookupEnhancedCreditLimit>	No
CreditRatingHistory	form	List<CompanyLookupEnhancedCreditRating>	No

**CompanyLookupEnhancedCreditLimit** Parameters:
Name	Parameter	Data Type	Required
Date	form	DateTime?	No
DateOrder	form	int?	No
Amount	form	int?	No

**CompanyLookupEnhancedCreditRating** Parameters:
Name	Parameter	Data Type	Required
Date	form	DateTime?	No
DateOrder	form	int?	No
Amount	form	int?	No
ShortDescription	form	string	No
Description	form	string	No

**CompanyLookupEnhancedFinancialStatement** Parameters:
Name	Parameter	Data Type	Required
YearEndDateOrder	form	int?	No
YearEndDate	form	DateTime?	No
SummaryNumberOfWeeks	form	int?	No
SummaryCurrency	form	string	No
SummaryConsolidatedAccount	form	string	No
ProfitAndLoss	form	CompanyLookupFinancialProfit	No
BalanceSheet	form	CompanyLookupFinancialBalance	No
CapitalAndReserves	form	CompanyLookupFinancialCapital	No
Other	form	CompanyLookupFinancialOther	No
Cash	form	CompanyLookupFinancialCash	No
Misc	form	CompanyLookupFinancialMisc	No
Ratios	form	CompanyLookupFinancialRatios	No

**CompanyLookupFinancialProfit** Parameters:
Name	Parameter	Data Type	Required
Turnover	form	decimal?	No
Export	form	decimal?	No
CostOfSales	form	decimal?	No
GrossProfit	form	decimal?	No
WagesAndSalaries	form	decimal?	No
DirectorEmolument	form	decimal?	No
OperatingProfit	form	decimal?	No
Depreciation	form	decimal?	No
AuditFees	form	decimal?	No
InterestPayments	form	decimal?	No
PretaxProfit	form	decimal?	No
Taxation	form	decimal?	No
ProfitAfterTax	form	decimal?	No
DividendsPayable	form	decimal?	No
RetainedProfit	form	decimal?	No

**CompanyLookupFinancialBalance** Parameters:
Name	Parameter	Data Type	Required
TangibleAccounts	form	decimal?	No
IntangibleAssets	form	decimal?	No
TotalFixedAssets	form	decimal?	No
Stock	form	decimal?	No
TradeDebtors	form	decimal?	No
Cash	form	decimal?	No
OtherDebtors	form	decimal?	No
MiscCurrentAssets	form	decimal?	No
TotalCurrentAssets	form	decimal?	No
TradeCreditors	form	decimal?	No
BankLoansAndOverdrafts	form	decimal?	No
OtherShortTermFinance	form	decimal?	No
MiscCurrentLiabilities	form	decimal?	No
TotalCurrentLiabilities	form	decimal?	No
BankLoansAndOverdraftsAndLTL	form	decimal?	No
OtherLongTermFinance	form	decimal?	No
TotalLongTermFinance	form	decimal?	No

**CompanyLookupFinancialCapital** Parameters:
Name	Parameter	Data Type	Required
CalledUpSharedCapital	form	decimal?	No
ProfitAndLossAccountReserve	form	decimal?	No
RevaluationReserve	form	decimal?	No
SundryReserves	form	decimal?	No
ShareholderFunds	form	decimal?	No

**CompanyLookupFinancialOther** Parameters:
Name	Parameter	Data Type	Required
NetWorth	form	decimal?	No
NetAssets	form	decimal?	No
WorkingCapital	form	decimal?	No
TotalAssets	form	decimal?	No
TotalLiabilities	form	decimal?	No

**CompanyLookupFinancialCash** Parameters:
Name	Parameter	Data Type	Required
NetCashFlowFromOperations	form	decimal?	No
NetCashFlowBeforeFinancing	form	decimal?	No
NetCashFlowFromFinancing	form	decimal?	No
IncreaseInCash	form	decimal?	No

**CompanyLookupFinancialMisc** Parameters:
Name	Parameter	Data Type	Required
ContingentLiability	form	string	No
CapitalEmployed	form	decimal?	No
NumberOfEmployees	form	decimal?	No
Auditors	form	string	No
AuditorComments	form	string	No
Bankers	form	string	No
BankBranchCode	form	string	No

**CompanyLookupFinancialRatios** Parameters:
Name	Parameter	Data Type	Required
PreTaxProfitMargin	form	decimal?	No
CurrentRatio	form	decimal?	No
SalesNetworkingCapital	form	decimal?	No
Gearing	form	decimal?	No
Equity	form	decimal?	No
CreditorDays	form	decimal?	No
DebtorDays	form	decimal?	No
LiquidityAcidTest	form	decimal?	No
ReturnOnCapitalEmployed	form	decimal?	No
ReturnOnNetAssetsEmployed	form	decimal?	No
ReturnOnTotalAssetsEmployed	form	decimal?	No
CurrentDebtRatio	form	decimal?	No
TotalDebtRatio	form	decimal?	No
StockTurnoverRatio	form	decimal?	No

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","userId":"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"}}}}