API BETA
DashboardDocumentationCredits
Documentation

Documentation

Version 1.1.2 BETA

Introduction

The Endole API gives you programmatic access to Endole's commercial database. In this documentation, instructions on how to activate your API application, generate a key, making requests, error handling, rate limiting and more are provided.

The Endole API is RESTful API that provides a simple, easy to use approach for requesting data. For each request, the Endole API returns JSON encoded responses and provides standard HTTP response codes.

Getting Started

You can start integrating corporate data into your app or website as soon as you create an Endole account.

To get started:

  1. First, create a free Endole Account.
  2. Open your API Dashboard and click Make New App to create your Endole API application.
  3. Click View App to obtain your Application Key so that Endole can authenticate your API requests.
  4. Perform a test API request (See Authentication below) to confirm your request was successful.

Authentication

Step 1: API application and your API key
Endole authenticates your API requests using your Application Key provided in your API Dashboard. If you do not include a valid key when making an API request, the request will fail and return an error.

Note: Your Application Key can be found in the Dashboard and is provided when you create an Endole API application.

Step 2: Make a test API request
To check that your integration is working correctly, perform a test API request using your key.

To gain access to the API, you will be required to use Basic Authorisation. Your credentials can be passed as a header or as parameters in a HTTP client. When you pass your credentials in the header, you must Base64-encode them.

Your Credentials

										{your_app_id}:{your_app_key}

										# Below is an example credentials, separated with a colon (:)
										21754:gUbHT4ChpjzHSN7L9QYIdoninSoK3dL0

										# Example of above credentials once Base64-encoded
										MjE3NTQ6Z1ViSFQ0Q2hwanpIU043TDlRWUlkb25pblNvSzNkTDA=
									

The following is an example of an encoded HTTP Basic Authentication header, using the example credentials provided above:

Authorization: Basic MjE3NTQ6Z1ViSFQ0Q2hwanpIU043TDlRWUlkb25pblNvSzNkTDA=

Using clients such as cURL, credentials are added to the request's Authorisation header for you. You pass your credentials with the -u option, as shown in the following example:

cURL

										curl https://api.endole.co.uk/company/00445790 \
										  -u 21754:gUbHT4ChpjzHSN7L9QYIdoninSoK3dL0
									

Once you have successfully made an API request, you’re ready to begin integrating company data using the Endole API.

Sandbox

As part of the API, sandbox testing is included for developers to test premium API calls. All sandbox calls are treated as regular calls and will return data in the same format.

Note: Data that’s provided in response to sandbox calls is sample data and any requests will not affect your credits.

Enabling sandbox
Enabling sandbox testing is done by adding "sandbox" to the query parameter of the call you would like to make. After a successful call, sample data will be returned as shown in the following example:

GET /company/{company_number}?sandbox=true

										curl https://api.endole.co.uk/company/00445790?sandbox=true \
										  -u 12312:gUbHT4ChpjzHSN7L9QYIdoninSoK3dL0
									


Sample Response

										{
											"accounts":{
												"accounting_reference_date":{
													"day":"26",
													"month":"2"
												},
												"last_accounts":{
													"made_up_to":"2020",
													"period_end_on":"2019-02-23",
													"period_start_on":"2018-02-25",
													"type":"group"
												},
												"next_accounts":{
													"due_on":"2019-02-04",
													"overdue":"2020-02-04",
													"period_end_on":"2020-02-04",
													"period_start_on":"2020-02-04"
												},
												"next_due":"2020-02-04",
												"next_made_up_to":"2020-02-04",
												"overdue":"2020-02-04"
											},
											"annual_return":{
												"last_made_up_to":"2020-02-04",
												"next_due":"2020-02-04",
												"next_made_up_to":"2020-02-04",
												"overdue":"false"
											},
											"branch_company_details":{
												"business_activity":"Any And All Legal Purposes",
												"parent_company_name":"ENDOLE PARENT CO LTD",
												"parent_company_number":"4717940"
											},
											"can_file":"true",
											"company_name":"ENDOLE SAMPLE COMPANY PLC",
											"company_number":"00445790",
											"company_status":"active",
											"company_status_detail":"active-proposal-to-strike-off",
											"confirmation_statement":{
												"last_made_up_to":"2020-02-04",
												"next_due":"2020-02-04",
												"next_made_up_to":"2020-02-04",
												"overdue":"2020-02-04"
											},
											"date_of_cessation":"2020-02-04",
											"date_of_creation":"1947-11-27",
											"external_registration_number":"4517940",
											"foreign_company_details":{
												"accounting_requirement":{
													"foreign_account_type":"accounting-requirements-of-originating-country-do-not-apply",
													"terms_of_account_publication":"accounting-reference-date-allocated-by-companies-house"
												},
												"accounts":{
													"account_period_from":{
														"day":"02",
														"month":"04"
													},
													"account_period_to":{
														"day":"02",
														"month":"04"
													},
													"must_file_within":{
														"months":"07"
													}
												},
												"business_activity":"Any And All Legal Purposes",
												"company_type":"group",
												"governed_by":"Delaware, Usa",
												"is_a_credit_finance_institution":true,
												"originating_registry":{
													"country":"Delaware Secretary Of State, Corporations Division",
													"name":"UNITED STATES"
												},
												"registration_number":"4517940"
											},
											"has_been_liquidated":"false",
											"is_community_interest_company":"",
											"jurisdiction":"england-wales",
											"links":{
												"self":"/companies/00445790"
											},
											"partial_data_available":"",
											"previous_company_names":[
												{
													"name":"ENDOLE HOLDINGS LIMITED",
													"ceased_on":"2006-09-01",
													"effective_from":"1981-04-10"
												}
											],
											"registered_office_address":{
												"address_line_1":"Shire Park",
												"address_line_2":"Kestrel Way",
												"care_of":"C/O",
												"country":"United Kingdom",
												"locality":"Welwyn Garden City",
												"po_box":"3653",
												"postal_code":"AL7 1GA",
												"premises":"115",
												"region":"London"
											},
											"registered_office_is_in_dispute":"false",
											"sic_codes":[
												"47110",
												"57802",
												"68795",
												"13059"
											],
											"subtype":"private-fund-limited-partnership",
											"type":"plc",
											"undeliverable_registered_office_address":"false"
										}
									
[+] See all lines

Errors

The API uses conventional HTTP response codes to indicate the success or failure of an API request.

HTTP Status Code Summary
200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable (often due to missing a required parameter).
401 - UnauthorizedNo valid credentials provided.
403 - ForbiddenThe parameters were valid but the request failed, or the request performed did not have permission.
404 - Not FoundThe requested resource doesn't exist.
429 - Too Many RequestsThe API request limit was exceeded (300 requests within a five-minute window).
500, 502, 503, 504 - Server ErrorsSomething went wrong on our end. You may need to contact us if the error persists.

Error Code Enumeration
credentials101Your credentials cannot be matched.
insufficient-credit102You do not have enough credit in your balance.
whitelist-none-saved103You have no whitelisted IP's saved.
whitelist-not-listed104Your IP has not been whitelisted.
throttling-too-many204You have made too many requests. We recommend an exponential backoff of your requests.
api-version-specify205You have not specified an API version in your Endole Developers dashboard.
api-version-no-exist206It appears the API version specified does not exist, please change to a valid API version.
api-version-discontinued207This version has been discontinued. Please refer back to the API documentation.
api-no-call-specify208You have not specified an API call.
company-no-number301You have not specified a company number.
company-no-exist302This company does not exist.
company-no-financials303This company hasn't submitted any financials.
company-no-group-structure304This company does not belong to a corporate group.
company-no-documents305This company has not submitted any documents
search-no-specify401You have not specified a search query.
shareholders-none-found501No shareholders for this company.
credit-check-failed601Retrieving a credit check on this company failed. Please try again later.
document-retrieve-failed701Retrieving company document has failed. Please refer back to the API documentation.
comprehensive-no-result801A comprehensive report could not be generated.
api-error999This call returned an error: '{error_message}'. Please refer back to the API documentation.

Security

We have installed security measures to ensure your application's performance and security isn't compromised. These are outlined below:

Rate Limiting (Throttling)

The Endole API applies rate limiting (throttling) to ensure that your application is protected in the instance of erroneous loops or excessive requests in a short time. This also ensures other API users won't be affected whilst utilising the Endole API.

An application can make up to 300 requests within a five-minute window. If this limit is exceeded, a 429 Too Many Requests HTTP status code will be returned for each request made for the remainder of the five-minute window.

Increasing your rate limit
If you have an application that requires a higher rate limit than the default, get in touch with us.

IP Whitelisting

To safeguard your application, Endole API provides IP whitelisting. IP whitelisting is a security feature that allows you to specify one or more IP addresses that are permitted access to your application. A maximum of five IP addresses can be whitelisted per application.

Pricing

Premium information is accessed on a pay-per-call basis with no commitments, termination fees, or preset usage limits.

Note: Some calls may return an empty result due to the data being unavailable. You will not be charged for these calls.

Credits
To get started accessing premium information through the Endole API, credits are first required. You can view existing and purchase more credits by clicking Credits.
Financials
Understand financial activity with 5Y Full Financial Accounts, including Balance Sheets, P&L Statements and more.
Enquire
Credit Checks
Evaluate creditworthiness with Credit Scores, Borrowing Limits, and County Court Judgements.
Enquire
Shareholders
Discover who decision-makers are with Shareholders Names and Percentage Ownership.
Enquire
Group Structures
See how companies are linked with Parent, Sibling, and Child company connections.
Enquire
Contacts
Connect with companies with updated GDPR-friendly Contact information and Director names.
Enquire
Comprehensive
Get full access to all information available on a company spanning from Financials to Contacts.
Enquire

Volume & Bulk Pricing
For organisations that require volume & bulk pricing, please contact us.

Versions

All Endole API versions are detailed below. If within your applications an older version of the API is being used, we recommend upgrading to the most current version to avoid errors that have since been amended.

VersionCreated DateStatusChange Log
1.101 Feb 20208 months agoactiveView change log for version 1.1
1.001 Nov 201911 months agodeprecatedView change log for version 1.0

Company Profile

To retrieve the details of a company, begin by supplying its unique company number:

GET /company/{company_number}

										curl https://api.endole.co.uk/company/00445790 \
										  -u 12312:gUbHT4ChpjzHSN7L9QYIdoninSoK3dL0
									


Sample Response

										{
											"accounts":{
												"accounting_reference_date":{
													"day":"26",
													"month":"2"
												},
												"last_accounts":{
													"made_up_to":"2020",
													"period_end_on":"2019-02-23",
													"period_start_on":"2018-02-25",
													"type":"group"
												},
												"next_accounts":{
													"due_on":"2020-02-04",
													"overdue":"false",
													"period_end_on":"2020-02-04",
													"period_start_on":"2020-02-04"
												},
												"next_due":"2020-02-04",
												"next_made_up_to":"2020-02-04",
												"overdue":"false"
											},
											"annual_return":{
												"last_made_up_to":"2020-02-04",
												"next_due":"2020-02-04",
												"next_made_up_to":"2020-02-04",
												"overdue":"false"
											},
											"branch_company_details":{
												"business_activity":"",
												"parent_company_name":"",
												"parent_company_number":""
											},
											"can_file":"true",
											"company_name":"TESCO PLC",
											"company_number":"00445790",
											"company_status":"active",
											"company_status_detail":"",
											"company_size":"large",
											"company_size_description":[
												"Turnover is over 36,000,000 GBP",
												"Balance sheet is over 36,000,000 GBP",
												"Over 250 employees"
											],
											"confirmation_statement":{
												"last_made_up_to":"2020-02-04",
												"next_due":"2020-02-04",
												"next_made_up_to":"2020-02-04",
												"overdue":"false"
											},
											"date_of_cessation":"",
											"date_of_creation":"1947-11-27",
											"external_registration_number":"",
											"foreign_company_details":{
												"accounting_requirement":{
													"foreign_account_type":null,
													"terms_of_account_publication":null
												},
												"accounts":{
													"account_period_from":{
														"day":null,
														"month":null
													},
													"account_period_to":{
														"day":null,
														"month":null
													},
													"must_file_within":{
														"months":null
													}
												},
												"business_activity":null,
												"company_type":null,
												"governed_by":null,
												"is_a_credit_finance_institution":null,
												"originating_registry":{
													"country":null,
													"name":null
												},
												"registration_number":null
											},
											"has_been_liquidated":"false",
											"is_community_interest_company":"",
											"jurisdiction":"england-wales",
											"links":{
												"self":"/companies/00445790"
											},
											"partial_data_available":"",
											"previous_company_names":[
												{
													"ceased_on":null,
													"effective_from":null,
													"name":null
												}
											],
											"registered_office_address":{
												"address_line_1":"Tesco House, Shire Park",
												"address_line_2":"Kestrel Way",
												"care_of":"",
												"country":"United Kingdom",
												"locality":"Welwyn Garden City",
												"po_box":"",
												"postal_code":"AL7 1GA",
												"premises":"",
												"region":""
											},
											"registered_office_is_in_dispute":"false",
											"sic_codes":[
												"47110",
												"",
												"",
												""
											],
											"subtype":"",
											"type":"plc",
											"undeliverable_registered_office_address":"false"
										}
									
[+] See all lines

Company Financials

Retrieve the financials of a company by supplying its unique company number. Each response returns 10 years of full company financials where available (ordered by newest first).

An example response of one year company financials can be seen below:

GET /company/{company_number}/financials

										curl https://api.endole.co.uk/company/00445790/financials \
										  -u 12312:gUbHT4ChpjzHSN7L9QYIdoninSoK3dL0
									


Sample Response

										{
											"period_ended":{
												"date_ended":"201902",
												"no_of_months":"12"
											},
											"overview":{
												"consolidated":"Y",
												"currency":"GBP",
												"no_of_employees":"464505",
												"turnover":"63911000000",
												"total_assets_less_current_liabilities":"28367000000",
												"shareholders_funds":"14858000000"
											},
											"profit_loss":{
												"turnover":{
													"turnover":"63911000000",
													"uk_turnover":"0",
													"export_turnover":"0"
												},
												"cost_of_sales":{
													"cost_of_sales":"-59767000000",
													"operational_expenses":"46000000"
												},
												"gross_profit":"4144000000",
												"other_expenses":"-2010000000",
												"operating_profit":{
													"operating_profit":"2153000000",
													"other_income":"35000000",
													"exceptional_items":"0"
												},
												"profit_before_interest":{
													"profit_before_interest":"2210000000",
													"interest_paid":"-536000000"
												},
												"profit_before_tax":{
													"profit_before_tax":"-354000000",
													"taxation":"-354000000"
												},
												"profit_after_tax":1320000000,
												"extraordinary_items":"0",
												"minority_interests":"2000000",
												"profit_for_period":608000000,
												"dividends":"-357000000",
												"retained_profit":"965000000",
												"discontinued_operation":"0",
												"depreciation":"1125000000",
												"auditors_fee":"8000000"
											},
											"employees_directors":{
												"no_of_employees":"464505",
												"total_remuneration":{
													"total_remuneration":"6447000000",
													"wages_salaries":"6447000000",
													"social_security_costs":"520000000",
													"pension_costs":"410000000"
												},
												"total_directors_pay":"8819000",
												"highest_paid_director":"4600000"
											},
											"balance_sheet":{
												"fixed_assets":{
													"tangible_assets":{
														"tangible_assets":"19023000000",
														"land_building":"16850000000",
														"fixtures_fittings":"0",
														"plant_vehicles":"0",
														"other_fixed":"2173000000"
													},
													"intangible_assets":"6264000000",
													"investments":"11092000000",
													"total_fixed_assets":"36379000000"
												},
												"current_assets":{
													"stock_wip":{
														"stock_wip":"2617000000",
														"stock":"0",
														"wip":"6000000"
													},
													"trade_debtors":"598000000",
													"bank_deposits":"2916000000",
													"other_current_assets":{
														"other_current_assets":"5930000000",
														"group_loans_asset":"170000000",
														"directors_loans_asset":"0",
														"investm_other_current_assets":"607000000"
													},
													"total_current_assets":"12668000000"
												},
												"current_liabilities":{
													"trade_creditors":"-5750000000",
													"short_term_loans_overdrafts":{
														"short_term_loans_overdrafts":"-10451000000",
														"bank_overdrafts":"-387000000",
														"group_loans":"-20000000",
														"director_loans":"0",
														"hire_purchases_lease":"-36000000",
														"hire_purchase":"0",
														"leasing":"-36000000",
														"other_short_term_loans":"-10008000000"
													},
													"total_other_current_liabilities":{
														"total_other_current_liabilities":"-4479000000",
														"corporation_tax":"-325000000",
														"dividends":"-357000000",
														"accruals_def_inc_short_term":"-1230000000",
														"social_securities_vat":"-521000000",
														"other_current_liabilities":"-2403000000"
													},
													"total_current_liabilities":"-20680000000"
												},
												"long_term_liabilities":{
													"long_term_debt":"-8969000000",
													"group_loans":"0",
													"director_loans":"0",
													"hire_purchases_lease":{
														"hire_purchases_lease":"-36000000",
														"hire_purchase":"0",
														"leasing":"-36000000"
													},
													"other_long_term_loans":"-8876000000",
													"total_other_long_term_liab":{
														"total_other_long_term_liab":"-4564000000",
														"accruals_def_income":"0",
														"other_long_term_liab":"-773000000",
														"provisions_for_other_liab":"-983000000",
														"deferred_tax":"-236000000",
														"other_provisions":"-747000000",
														"balance_sheet_minorities":"24000000"
													},
													"total_long_term_liabilities":"-13509000000",
													"total_assets":49047000000,
													"total_liabilities":-34189000000,
													"net_assets":"14858000000",
													"shareholders_equity":"14858000000",
													"net_current_assets_working_capital":"-8012000000",
													"total_assets_less_current_liabilities":"28367000000"
												},
												"capital_reserves":{
													"issued_capital":"490000000",
													"total_reserves":{
														"total_reserves":"14368000000",
														"share_premium_account":"5165000000",
														"revaluation_reserves":"0",
														"profit_account":"5405000000",
														"other_reserves":"3798000000"
													},
													"shareholders_funds":"14858000000"
												},
												"cash_flow":{
													"net_cash_flow_from_operations":"2642000000",
													"net_cash_flow_return_on_invest":"-247000000",
													"taxation":"-370000000",
													"net_cash_flow_from_investing_activ":"-1202000000",
													"capital_expenditure_financ_invest":"0",
													"acquisition_disposal":"0",
													"equity_dividends_paid":"-357000000",
													"management_of_liquid_resources":"0",
													"net_cash_flow_from_financing":"-1624000000",
													"increase_in_cash_equivalents":"-1158000000"
												},
												"ratios_percentages":{
													"gross_profit_margin":6.48,
													"operating_profit_margin":3.36,
													"profit_margin_before_tax":2.61,
													"profit_margin_after_tax":2.06,
													"current_ratio":0.61,
													"liquidity_ratio":0.48,
													"asset_turnover_ratio":1.30,
													"interest_coverage_ratio":4.01,
													"return_on_assets":4.38,
													"return_on_net_assets":14.49,
													"return_on_equity":8.88,
													"return_on_capital_employed":7.58,
													"debtor_days":3.41,
													"creditor_days":35.11,
													"gearing_total_liabilities":230.10,
													"debt_to_capital_ratio":69.70,
													"debt_to_equity_ratio":230.10,
													"turnover_per_employee":137589.47,
													"profit_per_employee":1308.92,
													"average_pay_per_employee":16460.53,
													"shareholders_funds_per_employee":31986.73,
													"working_capital_per_employee":-17248.46,
													"total_assets_per_employee":105589.82
												}
											}
										}
									
[+] See all lines

Company Officers

Retrieve Company Officer details by first supplying the company's unique number. Optional query parameters that can be used to manage and refine results are detailed below:

Optional Query Parameters
items_per_pageThe number of officers to return per result.
register_typeThe register_type determines which officer type is returned.

Accepted values are:
directors
secretaries
llp-members
The register_type field will only work if registers_view is set to true.
register_viewUsed to display specific register information. For example, if registers_view is defined as true and the directors register_type is specified, only active directors will be returned, including their full date of birth.

Accepted values are:
true
false
By default, this value is defined as false.
start_indexUsed to begin results from an offset start position, i.e start results from position 5.
order_byThe field by which the order of the results are set. Possible values are:
appointed_on
resigned_on
surname

GET /company/{company_number}/officers?items_per_page=2&start_index=0

										curl https://api.endole.co.uk/company/00445790/officers?items_per_page=2&start_index=0 \
										  -u 12312:gUbHT4ChpjzHSN7L9QYIdoninSoK3dL0
									


Sample Response

										{
											"active_count":"14",
											"items":[
												{
													"address":{
														"address_line_1":"Tesco House, Shire Park",
														"address_line_2":"Kestrel Way",
														"country":"United Kingdom",
														"locality":"Welwyn Garden City",
														"postal_code":"AL7 1GA"
													},
													"appointed_on":"2016-08-10",
													"name":"WELCH, Robert John",
													"officer_role":"secretary"
												},
												{
													"address":{
														"address_line_1":"Tesco House, Shire Park",
														"address_line_2":"Kestrel Way",
														"country":"United Kingdom",
														"locality":"Welwyn Garden City",
														"postal_code":"AL7 1GA"
													},
													"appointed_on":"2015-03-01",
													"country_of_residence":"England",
													"date_of_birth":{
														"month":"8",
														"year":"1948"
													},
													"name":"ALLAN, John Murray",
													"nationality":"British",
													"occupation":"Chairman",
													"officer_role":"director"
												}
											],
											"items_per_page":"2",
											"kind":"officer-list",
											"links":"/company/00445790/officers",
											"resigned_count":"49",
											"total_results":"63"
										}
									
[+] See all lines

Company Shareholders

Supply a company's unique number to retrieve data on its Shareholders, as displayed below:

GET /company/{company_number}/shareholders

										curl https://api.endole.co.uk/company/02462858/shareholders \
										  -u 12312:gUbHT4ChpjzHSN7L9QYIdoninSoK3dL0
									


Sample Response

										{
											"items":[
												{
													"title":"",
													"first_name":"",
													"last_name":"SPEN HILL PROPERTIES (HOLDINGS) PLC",
													"company_name":"SPEN HILL PROPERTIES (HOLDINGS) PLC",
													"type":"ORDINARY",
													"shares":"5",
													"currency":"GBP",
													"shareholding":"5 ORDINARY \u00a3 1.000000"
												},
												{
													"title":"",
													"first_name":"",
													"last_name":"TESCO PLC",
													"company_name":"TESCO PLC",
													"type":"ORDINARY",
													"shares":"95",
													"currency":"GBP",
													"shareholding":"95 ORDINARY \u00a3 1.000000"
												}
											],
											"latest_confirmation":"2019-06-07",
											"total_shares":"100",
											"issued_capital":"100"
										}
									
[+] See all lines

Company Credit Checks

Supply a company's unique number to perform a credit check, as displayed below:

GET /company/{company_number}/credit_checks

										curl https://api.endole.co.uk/company/00445790/credit_checks \
										  -u 12312:gUbHT4ChpjzHSN7L9QYIdoninSoK3dL0
									


Sample Response

										{
											"credit_scores":{
												"adverse_info":"This Company has had a Winding Up Petition in the last 6 weeks",
												"current_year_band":"Caution",
												"current_year_score":"38",
												"current_year_year_end":"2018-03-31",
												"previous_year_band":"High Risk",
												"previous_year_score":"0",
												"previous_year_year_end":"2017-03-31",
												"rating":"500",
												"ultimateOwnerName":"Test Company Plc",
												"ultimateOwnerNo":"12345678"
											},
											"ccj_cases":[
												{
													"amount":"3785",
													"case_number":"43QZ2Z6F",
													"court":"COUNTY COURT BUSINESS CENTRE",
													"judgement_date":"2018-12-02",
													"paid_date":"0",
													"satisfied_or_outstanding":"outstanding",
													"status_code":"J"
												},
												{
													"amount":"18000",
													"case_number":"BHM-A1491-",
													"court":"BIRMINGHAM",
													"judgement_date":"2018-01-17",
													"paid_date":"2018-04-10",
													"satisfied_or_outstanding":"satisfied",
													"status_code":"SS"
												},
												{
													"amount":"32958",
													"case_number":"F35YM782",
													"court":"COUNTY COURT MONEY CLAIMS CENT",
													"judgement_date":"2018-12-19",
													"paid_date":"0",
													"satisfied_or_outstanding":"outstanding",
													"status_code":"JG"
												}
											],
											"gazettes":[
												{
													"publication_date":"2020-02-19",
													"category":"Corporate Insolvency",
													"type":"Petitions to Wind Up (Companies)",
													"notice_link":"https://www.thegazette.co.uk/notice/12345678"
												}
											]
										}
									
[+] See all lines

Company Group Structures

Supply a company's unique number to return the company's group structure where available, as displayed below:

GET /company/{company_number}/group_structures

										curl https://api.endole.co.uk/company/03977902/group_structures \
										  -u 12312:gUbHT4ChpjzHSN7L9QYIdoninSoK3dL0
									


Sample Response

										{
											"company_number":"#0095309",
											"company_name":"ALPHABET INC",
											"country_name":"USA",
											"subsidaries":[
												{
													"company_number":"#0102339",
													"company_name":"ALPHABET HOLDINGS LLC",
													"country_name":"USA",
													"subsidaries":[
														{
															"company_number":"09183796",
															"company_name":"GV UK MANAGEMENT COMPANY, LIMITED",
															"country_name":"UK"
														}
													]
												},
												{
													"company_number":"#0110057",
													"company_name":"ELASTIFILE LTD",
													"country_name":"ISRAEL",
													"subsidaries":[
														{
															"company_number":"10577381",
															"company_name":"ELASTIFILE UK LIMITED",
															"country_name":"UK"
														}
													]
												},
												{
													"company_number":"#0046479",
													"company_name":"GOOGLE INC",
													"country_name":"USA",
													"subsidaries":[
														{
															"company_number":"#0049656",
															"company_name":"GOOGLE INTERNATIONAL LLC",
															"country_name":"USA",
															"subsidaries":[
																{
																	"company_number":"05903713",
																	"company_name":"GOOGLE PAYMENT LIMITED",
																	"country_name":"UK"
																},
																{
																	"company_number":"03977902",
																	"company_name":"GOOGLE UK LIMITED",
																	"country_name":"UK"
																},
																{
																	"company_number":"IE459359",
																	"company_name":"GOOGLE VOICE LIMITED",
																	"country_name":"IRELAND"
																}
															]
														},
														{
															"company_number":"#0035190",
															"company_name":"MOTOROLA MOBILITY HOLDINGS LLC",
															"country_name":"USA",
															"subsidaries":[
																{
																	"company_number":"#0033053",
																	"company_name":"DP ACQUISITION 2006 LLC",
																	"country_name":"USA"
																}
															]
														}
													]
												},
												{
													"company_number":"#0113618",
													"company_name":"VERILY LIFE SCIENCES LLC",
													"country_name":"USA",
													"subsidaries":[
														{
															"company_number":"IE585119",
															"company_name":"VERILY IRELAND LIMITED",
															"country_name":"IRELAND"
														}
													]
												}
											]
										}
									
[+] See all lines

Company Filing History

Supply a company's unique number to return the company's filing history where available. Optional query parameters that can be used to manage and refine results, as displayed below.

GET /company/{company_number}/filing_history?&items_per_page=10&start_index=0

										curl https://api.endole.co.uk/company/03977902/filing_history?&items_per_page=2&start_index=0 \
										  -u 12312:gUbHT4ChpjzHSN7L9QYIdoninSoK3dL0
									


Sample Response

										{
											"total_count":"152",
											"start_index":"0",
											"items_per_page":"2",
											"items":[
												{
													"action_date":"2019-04-20",
													"category":"confirmation-statement",
													"description":{
														"type":"confirmation-statement-with-updates",
														"text":"Confirmation statement made on 20 April 2019 with updates",
														"html_formatted":"<strong>Confirmation statement</strong> made on <em>20 April 2019</em> with updates"
													},
													"date":"2019-04-29",
													"type":"CS01",
													"pages":"4",
													"transaction_id":"MzIzMzEzNDYzOWFkaXF6a2N4",
													"links":{
														"document":"/company/03977902/document/MzIzMzEzNDYzOWFkaXF6a2N4"
													}
												},
												{
													"action_date":"2019-01-14",
													"category":"officers",
													"description":{cc
														"type":"appoint-person-director-company-with-name-date",
														"text":"Appointment of Amitesh Bhushan as a director on 14 January 2019",
														"html_formatted":"<strong>Appointment</strong> of <em>Amitesh Bhushan</em> as a director on <em>14 January 2019</em>"
													},
													"date":"2019-04-25",
													"type":"AP01",
													"pages":"2",
													"transaction_id":"MzIyNTQxOTMxNGFkaXF6a2N4",
													"annotations":{
														"description":"Rectified The AP01 was removed from the public register on 25/04/2019 as it was factually inaccurate or was derived from something factually inaccurate."
													},
													"links":{
														"document":"/company/03977902/document/MzIyNTQxOTMxNGFkaXF6a2N4"
													}
												}
											]
										}
									
[+] See all lines

Company Document

Supply a company's unique number and its transaction ID to return the link of the company document, as displayed below:

GET /company/{company_number}/document/{transaction_id}

										curl https://api.endole.co.uk/company/03977902/document/MzIyNTQxOTMxNGFkaXF6a2N4 \
										  -u 12312:gUbHT4ChpjzHSN7L9QYIdoninSoK3dL0
									


Sample Response

										{
											"links":{
												"document":"https://s3.eu-west-2.amazonaws.com/document-api-images-live.ch.gov.uk/docs/Zt-1gZVmsFXxvEUuoLKZ6PxLnocpRJK-wrS65SZMonc/application-pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=ASIAWRGBDBV3MUON6TW6%2F20200305%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20200305T132250Z&X-Amz-Expires=60&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCWV1LXdlc3QtMiJIMEYCIQC%2FU0Y0pVugGn08aYHOOP2sNTIZAMnYLa0uREI6OXOyfwIhAKUGNvWJvCdV7epthIjIR%2B29lERBVumOyxtSFqXvWnxLKrQDCHQQAhoMNDQ5MjI5MDMyODIyIgz7QDkLRQOIDspYp%2FgqkQOEV7GwfZvbWZogYppQ1mZ6URSdkLnMcmteqDJbaxVKd7awrMZd565BpE15d5BkSILk8mvgkhKaMWDpgTTQ3aefHWh4htThpzluBpJKGLzPap3t%2B2xfvXxPcrQoaHDMczEp5t1lMM29SCYNfDnz7FayuzUf3kSRb1k4YtJc68O6PqtshbzllzvFOh%2BERf1yvnc5qu1YI%2FGc8qUtg32oadPp6WHGivWnMLjnzSQEBk%2FstvfXw4LqWyywmz0XndPQVSfbV4jFBh3kdR8qv%2BuBkxVR465YAtWQ3%2BEamPhofAS%2BQ6k1IwcG2vihKV%2B69l8ksPNcJN1ufhY0ua9GcOOjVTQhBO4j63%2FX13VXy4oYayALhnqt2dLTEYeVavv5zMYFqh3nTkKq6%2F9bs6xj57VWj6SjbU6cGZxjJuoDA9iKzIIlOGARjt8R1ssvHcXnLIGfIJz0ffFGKc%2FDDwqz3WTm32Z%2BPSIdO3Gm5qFpI1Dd9kHSqtA%2Bl49EiQr1GewYjfNj8Qa9DYz6nL3zkUM4s2rROhiwRTDvuYPzBTrqAb7OHB5xWiBBe4jXW70JJsZkLMrSNCjBbAzbxIhocHYdEG6Nt6OtuG2l7sxTmVBQ%2FXYVf0ZMigYIl8mbWZQNDgTnjRQnwlzUWaUFknXWGZVKPLTiBebwGkI6CRX%2FFlmsPhRl6RArbjyh7xIuxzrZMt680DSv4pCNyIn1PNWMfgb965X4lURmE0AstxAzYl0RbNeQYnOCKZi%2F84%2BI%2Fu5L95jmZtxYsyGDUtmJ5r8xU%2FGPQAIhApcyEPRINNwksClE7AnHb05dwp2SH9kuqkj9PIVB0c9r0P0nTDEBHsgVfbuWAoJv48km3BjPSg%3D%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=5d6f15dd1517f262991753028a7ddbe8f4d4ecd39ff4c9028838c9281ff8947e"
											}
										}
									
[+] See all lines

Company Comprehensive

Supply a company's unique number to retrieve a comprehensive report containing company profile, financials, credit checks, shareholders, officers, group structures and filing history, as displayed below:

Note: items with multiple results in each section will be limited to 20. For example, officers will present a maximum of 20 results.

GET /company/{company_number}/comprehensive

											curl https://api.endole.co.uk/company/03977902/comprehensive \
											  -u 12312:gUbHT4ChpjzHSN7L9QYIdoninSoK3dL0
										


Sample Response

											{
												"company_profile":{
													"accounts":{
														"accounting_reference_date":{
															"day":"26",
															"month":"2"
														},
														"last_accounts":{
															"made_up_to":"2020",
															"period_end_on":"2019-02-23",
															"period_start_on":"2018-02-25",
															"type":"group"
														},
														"next_accounts":{
															"due_on":"2019-02-04",
															"overdue":"2020-02-04",
															"period_end_on":"2020-02-04",
															"period_start_on":"2020-02-04"
														},
														"next_due":"2020-02-04",
														"next_made_up_to":"2020-02-04",
														"overdue":"2020-02-04"
													},
													"annual_return":{
														"last_made_up_to":"2020-02-04",
														"next_due":"2020-02-04",
														"next_made_up_to":"2020-02-04",
														"overdue":"false"
													},
													"branch_company_details":{
														"business_activity":"Any And All Legal Purposes",
														"parent_company_name":"ENDOLE PARENT CO LTD",
														"parent_company_number":"4717940"
													},
													"can_file":"true",
													"company_name":"ENDOLE SAMPLE COMPANY PLC",
													"company_number":"00445790",
													"company_status":"active",
													"company_status_detail":"active-proposal-to-strike-off",
													"confirmation_statement":{
														"last_made_up_to":"2020-02-04",
														"next_due":"2020-02-04",
														"next_made_up_to":"2020-02-04",
														"overdue":"2020-02-04"
													},
													"date_of_cessation":"2020-02-04",
													"date_of_creation":"1947-11-27",
													"external_registration_number":"4517940",
													"foreign_company_details":{
														"accounting_requirement":{
															"foreign_account_type":"accounting-requirements-of-originating-country-do-not-apply",
															"terms_of_account_publication":"accounting-reference-date-allocated-by-companies-house"
														},
														"accounts":{
															"account_period_from":{
																"day":"02",
																"month":"04"
															},
															"account_period_to":{
																"day":"02",
																"month":"04"
															},
															"must_file_within":{
																"months":"07"
															}
														},
														"business_activity":"Any And All Legal Purposes",
														"company_type":"group",
														"governed_by":"Delaware, Usa",
														"is_a_credit_finance_institution":true,
														"originating_registry":{
															"country":"Delaware Secretary Of State, Corporations Division",
															"name":"UNITED STATES"
														},
														"registration_number":"4517940"
													},
													"has_been_liquidated":"false",
													"is_community_interest_company":"",
													"jurisdiction":"england-wales",
													"links":{
														"self":"/companies/00445790"
													},
													"partial_data_available":"",
													"previous_company_names":[
														{
															"name": "ENDOLE HOLDINGS LIMITED",
															"ceased_on": "2006-09-01",
															"effective_from": "1981-04-10"
														}
													],
													"registered_office_address":{
														"address_line_1":"Shire Park",
														"address_line_2":"Kestrel Way",
														"care_of":"C/O",
														"country":"United Kingdom",
														"locality":"Welwyn Garden City",
														"po_box":"3653",
														"postal_code":"AL7 1GA",
														"premises":"115",
														"region":"London"
													},
													"registered_office_is_in_dispute":"false",
													"sic_codes":[
														"47110",
														"57802",
														"68795",
														"13059"
													],
													"subtype":"private-fund-limited-partnership",
													"type":"plc",
													"undeliverable_registered_office_address":"false"
												},
												"financials":[
													{
														"period_ended":{
															"date_ended":"201902",
															"no_of_months":"12"
														},
														"overview":{
															"consolidated":"Y",
															"currency":"GBP",
															"no_of_employees":"464505",
															"turnover":"63911000000",
															"total_assets_less_current_liabilities":"28367000000",
															"shareholders_funds":"14858000000"
														},
														"profit_loss":{
															"turnover":{
																"turnover":"63911000000",
																"uk_turnover":"63911000",
																"export_turnover":"6391000000"
															},
															"cost_of_sales":{
																"cost_of_sales":"-59767000000",
																"operational_expenses":"46000000"
															},
															"gross_profit":"4144000000",
															"other_expenses":"-2010000000",
															"operating_profit":{
																"operating_profit":"2153000000",
																"other_income":"35000000",
																"exceptional_items":"37000000"
															},
															"profit_before_interest":{
																"profit_before_interest":"2210000000",
																"interest_paid":"-536000000"
															},
															"profit_before_tax":{
																"profit_before_tax":"-354000000",
																"taxation":"-354000000"
															},
															"profit_after_tax":1320000000,
															"extraordinary_items":"2000000",
															"minority_interests":"2000000",
															"profit_for_period":608000000,
															"dividends":"-357000000",
															"retained_profit":"965000000",
															"discontinued_operation":"2000000",
															"depreciation":"1125000000",
															"auditors_fee":"8000000"
														},
														"employees_directors":{
															"no_of_employees":"464505",
															"total_remuneration":{
																"total_remuneration":"6447000000",
																"wages_salaries":"6447000000",
																"social_security_costs":"520000000",
																"pension_costs":"410000000"
															},
															"total_directors_pay":"8819000",
															"highest_paid_director":"4600000"
														},
														"balance_sheet":{
															"fixed_assets":{
																"tangible_assets":{
																	"tangible_assets":"19023000000",
																	"land_building":"16850000000",
																	"fixtures_fittings":"1231231",
																	"plant_vehicles":"2331231",
																	"other_fixed":"2173000000"
																},
																"intangible_assets":"6264000000",
																"investments":"11092000000",
																"total_fixed_assets":"36379000000"
															},
															"current_assets":{
																"stock_wip":{
																	"stock_wip":"2617000000",
																	"stock":"2611000000",
																	"wip":"6000000"
																},
																"trade_debtors":"598000000",
																"bank_deposits":"2916000000",
																"other_current_assets":{
																	"other_current_assets":"5930000000",
																	"group_loans_asset":"170000000",
																	"directors_loans_asset":"120000000",
																	"investm_other_current_assets":"607000000"
																},
																"total_current_assets":"12668000000"
															},
															"current_liabilities":{
																"trade_creditors":"-5750000000",
																"short_term_loans_overdrafts":{
																	"short_term_loans_overdrafts":"-10451000000",
																	"bank_overdrafts":"-387000000",
																	"group_loans":"-20000000",
																	"director_loans":"0",
																	"hire_purchases_lease":"-36000000",
																	"hire_purchase":"-36000000",
																	"leasing":"-36000000",
																	"other_short_term_loans":"-10008000000"
																},
																"total_other_current_liabilities":{
																	"total_other_current_liabilities":"-4479000000",
																	"corporation_tax":"-325000000",
																	"dividends":"-357000000",
																	"accruals_def_inc_short_term":"-1230000000",
																	"social_securities_vat":"-521000000",
																	"other_current_liabilities":"-2403000000"
																},
																"total_current_liabilities":"-20680000000"
															},
															"long_term_liabilities":{
																"long_term_debt":"-8969000000",
																"group_loans":"-8969000000",
																"director_loans":"-36000000",
																"hire_purchases_lease":{
																	"hire_purchases_lease":"-36000000",
																	"hire_purchase":"-36000000",
																	"leasing":"-36000000"
																},
																"other_long_term_loans":"-8876000000",
																"total_other_long_term_liab":{
																	"total_other_long_term_liab":"-4564000000",
																	"accruals_def_income":"-4564000000",
																	"other_long_term_liab":"-773000000",
																	"provisions_for_other_liab":"-983000000",
																	"deferred_tax":"-236000000",
																	"other_provisions":"-747000000",
																	"balance_sheet_minorities":"24000000"
																},
																"total_long_term_liabilities":"-13509000000",
																"total_assets":49047000000,
																"total_liabilities":-34189000000,
																"net_assets":"14858000000",
																"shareholders_equity":"14858000000",
																"net_current_assets_working_capital":"-8012000000",
																"total_assets_less_current_liabilities":"28367000000"
															},
															"capital_reserves":{
																"issued_capital":"490000000",
																"total_reserves":{
																	"total_reserves":"14368000000",
																	"share_premium_account":"5165000000",
																	"revaluation_reserves":"5165000000",
																	"profit_account":"5405000000",
																	"other_reserves":"3798000000"
																},
																"shareholders_funds":"14858000000"
															},
															"cash_flow":{
																"net_cash_flow_from_operations":"2642000000",
																"net_cash_flow_return_on_invest":"-247000000",
																"taxation":"-370000000",
																"net_cash_flow_from_investing_activ":"-1202000000",
																"capital_expenditure_financ_invest":"-1202000000",
																"acquisition_disposal":"-1202000000",
																"equity_dividends_paid":"-357000000",
																"management_of_liquid_resources":"-1202000000",
																"net_cash_flow_from_financing":"-1624000000",
																"increase_in_cash_equivalents":"-1158000000"
															},
															"ratios_percentages":{
																"gross_profit_margin":6.48,
																"operating_profit_margin":3.36,
																"profit_margin_before_tax":2.61,
																"profit_margin_after_tax":2.06,
																"current_ratio":0.61,
																"liquidity_ratio":0.48,
																"asset_turnover_ratio":1.30,
																"interest_coverage_ratio":4.01,
																"return_on_assets":4.38,
																"return_on_net_assets":14.49,
																"return_on_equity":8.88,
																"return_on_capital_employed":7.58,
																"debtor_days":3.41,
																"creditor_days":35.11,
																"gearing_total_liabilities":230.10,
																"debt_to_capital_ratio":69.70,
																"debt_to_equity_ratio":230.10,
																"turnover_per_employee":137589.47,
																"profit_per_employee":1308.92,
																"average_pay_per_employee":16460.53,
																"shareholders_funds_per_employee":31986.73,
																"working_capital_per_employee":-17248.46,
																"total_assets_per_employee":105589.82
															}
														}
													}
												],
												"credit_checks":{
													"credit_scores":{
														"adverse_info":"There are NO liquidation, receivership ,administration or winding-up documents recorded by Companies House.",
														"current_year_band":"Caution",
														"current_year_score":"38",
														"current_year_year_end":"2018-05-31",
														"previous_year_band":"High Risk",
														"previous_year_score":"20",
														"previous_year_year_end":"2017-05-31",
														"rating":"500",
														"ultimateOwnerName":"Tesco Plc",
														"ultimateOwnerNo":"12345678"
													},
													"ccj_cases":[
														{
															"amount":"1452",
															"case_number":"FAQZ7A2J",
															"court":"COUNTY COURT BUSINESS CENTRE",
															"judgement_date":"2017-07-27",
															"paid_date":"2017-07-27",
															"satisfied_or_outstanding":"outstanding",
															"status_code":"JG"
														}
													],
													"gazettes":[
														{
															"publication_date":"2020-02-19",
															"category":"Corporate Insolvency",
															"type":"Petitions to Wind Up (Companies)",
															"notice_link":"https://www.thegazette.co.uk/notice/12345678"
														}
													]
												},
												"shareholders":{
													"items":[
														{
															"title":"",
															"first_name":"",
															"last_name":"SPEN HILL PROPERTIES (HOLDINGS) PLC",
															"company_name":"SPEN HILL PROPERTIES (HOLDINGS) PLC",
															"type":"ORDINARY",
															"shares":"5",
															"currency":"GBP",
															"shareholding":"5 ORDINARY \u00a3 1.000000"
														},
														{
															"title":"MR",
															"first_name":"JOHN",
															"last_name":"DOE",
															"type":"ORDINARY",
															"shares":"95",
															"currency":"GBP",
															"shareholding":"95 ORDINARY \u00a3 1.000000"
														}
													],
													"latest_confirmation":"2019-06-07",
													"total_shares":"100",
													"issued_capital":"100"
												},
												"officers":{
													"active_count":1,
													"inactive_count":0,
													"items":{
														"address":{
															"address_line_1":"St John Street",
															"address_line_2":"Kestrel Way",
															"care_of":"C/O",
															"country":"Uk",
															"locality":"Welwyn Garden City",
															"po_box":"3653",
															"postal_code":"EC1V 4PY",
															"premises":"145",
															"region":"London"
														},
														"appointed_on":"2013-11-13",
														"country_of_residence":"England",
														"date_of_birth":{
															"day":26,
															"month":8,
															"year":1948
														},
														"former_names":{
															"forename":"Murray",
															"surname":"ALLAN"
														},
														"identification":{
															"identification_type":"eea",
															"legal_authority":"Unreported",
															"legal_form":"Unreported",
															"place_registered":"ENGLAND",
															"registration_number":"07906215"
														},
														"name":"ALLAN, John",
														"nationality":"British",
														"occupation":"Chairman",
														"officer_role":"director",
														"resigned_on":"2015-03-01"
													},
													"items_per_page":10,
													"kind":"officer-list",
													"links":"/company/00445790/officers",
													"resigned_count":0,
													"start_index":0,
													"total_results":1
												},
												"group_structures":{
													"company_number":"#0403209",
													"company_name":"ABC INC",
													"country_name":"USA",
													"subsidaries":[
														{
															"company_number":"#0303209",
															"company_name":"ABC HOLDINGS LLC",
															"country_name":"USA",
															"subsidaries":[
																{
																	"company_number":"12345678",
																	"company_name":"DEF UK MANAGEMENT COMPANY, LIMITED",
																	"country_name":"UK"
																}
															]
														},
														{
															"company_number":"87654321",
															"company_name":"GHI LTD",
															"country_name":"UK"
														},
														{
															"company_number":"#45678954",
															"company_name":"JKL INC",
															"country_name":"USA",
															"subsidaries":[
																{
																	"company_number":"#0503209",
																	"company_name":"ABC INTERNATIONAL LLC",
																	"country_name":"USA",
																	"subsidaries":[
																		{
																			"company_number":"021458796",
																			"company_name":"ABC PAYMENT LIMITED",
																			"country_name":"UK"
																		},
																		{
																			"company_number":"698547894",
																			"company_name":"ABC UK LIMITED",
																			"country_name":"UK"
																		},
																		{
																			"company_number":"IE987564",
																			"company_name":"ABC VOICE LIMITED",
																			"country_name":"IRELAND"
																		}
																	]
																},
																{
																	"company_number":"#6587456",
																	"company_name":"XYZ MOBILITY HOLDINGS LLC",
																	"country_name":"USA",
																	"subsidaries":[
																		{
																			"company_number":"#9854785",
																			"company_name":"AH ACQUISITION LLC",
																			"country_name":"USA"
																		}
																	]
																}
															]
														}
													]
												},
												"filing_history":{
													"total_count":"152",
													"start_index":"0",
													"items_per_page":"2",
													"items":[
														{
															"action_date":"2019-04-20",
															"category":"confirmation-statement",
															"description":{
																"type":"confirmation-statement-with-updates",
																"text":"Confirmation statement made on 20 April 2019 with updates",
																"html_formatted":"<strong>Confirmation statement</strong> made on <em>20 April 2019</em> with updates"
															},
															"date":"2019-04-29",
															"type":"CS01",
															"pages":"4",
															"transaction_id":"MzIzMzEYNDYzOWFkaXF6a2N4",
															"links":{
																"document":"/company/00445790/document/MzIzMzEYNDYzOWFkaXF6a2N4"
															}
														},
														{
															"action_date":"2019-01-14",
															"category":"officers",
															"description":{
																"type":"appoint-person-director-company-with-name-date",
																"text":"Appointment of John Doe as a director on 14 January 2019",
																"html_formatted":"<strong>Appointment</strong> of <em>John Doe</em> as a director on <em>14 January 2019</em>"
															},
															"date":"2019-04-25",
															"type":"AP01",
															"pages":"2",
															"transaction_id":"MzIyNTQxOdMxNGFkaXF6a2N4",
															"annotations":{
																"description":"Rectified The AP01 was removed from the public register on 25/04/2019 as it was factually inaccurate or was derived from something factually inaccurate."
															},
															"links":{
																"document":"/company/00445790/document/MzIyNTQxOdMxNGFkaXF6a2N4"
															}
														}
													]
												}
											}
										
[+] See all lines