API Issues when sending key

[development]

Hi All,

I am trying to connect to the API but keep getting authentication issues.

Can someone please advise?

//$jsonurl = “https://api.companieshouse.gov.uk/company/08117687”;
//$json = file_get_contents($jsonurl);
//debug(json_decode($json));

I am not sure how to send my key with the request?

[csmith]

Hi.

Authentication is described in the getting started guide, along with some detailed discussions on this forum. Do a search on the forum for “authentication”, there is a whole heap of detailed help.

I have noticed that the API Explorer does not show all of the request headers that are sent, one of which is the Authentication header, which would perhaps have been helpful. I will have that looked at.

Here are some key topic posts that should help you authenticate correctly.

Authorisation

I would recommend posting any follow-up questions to the following post:

Getting invalid authorization

The existing XML Gateway API employs a custom authentication mechanism unique to Companies House, and involves the complex MD5 hashing of passwords and transaction ID's. The new Companies House REST API uses standard Basic HTTP Authorisation. This makes API key authentication as simple as the following curl command: curl -v -uYOUR_APIKEY_FOLLOWED_BY_A_COLON: https://api.companiseshouse.gov.uk/company/00002065 You may have to do a little more work in code, depending on whether your client f…

Help with Document API & Fetch a Document

Paul, Assuming you have identified the document you want from the filing history response, the steps are: Set your mandatory HTTP request headers. Accept: application/pdf Authorization: Basic your_encoded_key_goes_here Invoke https://document-api.companieshouse.gov.uk/document/{transaction_id}/content where transaction_id relates to the document of interest in filing history response. E.g. https://document-api.companieshouse.gov.uk/document/n1EjP_MALLs8xZp5hs86iHcYDli0TE-n6t4HUDeZuq8/…

Best regards,
Chris