Output XML Gateway Name Search

Hello all,

Currently we use the beta rest api to perform naming checking. We want to implement the NameSearch.xsd request for the XML Output gateway (endpoint: https://xmlgw.companieshouse.gov.uk/v1-0/xmlgw/Gateway).

I have been testing a Name Search post request but the request is timing out. Any ideas ?

BTW this is testing in Postman. Also we have production implementation targeting the input gateway.

XML Payload as follows:

<?xml version="1.0" encoding="UTF-8"?>
<GovTalkMessage xsi:schemaLocation="http://www.govtalk.gov.uk/schemas/govtalk/govtalkheader http://xmlgw.companieshouse.gov.uk/v1-0/schema/Egov_ch.xsd" xmlns="http://www.govtalk.gov.uk/schemas/govtalk/govtalkheader" xmlns:dsig="http://www.w3.org/2000/09/xmldsig#" xmlns:gt="http://www.govtalk.gov.uk/schemas/govtalk/core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
  <EnvelopeVersion>1.0</EnvelopeVersion>
  <Header>
    <MessageDetails>
      <Class>NameSearch</Class>
      <Qualifier>request</Qualifier>
      <TransactionID>1</TransactionID>
    </MessageDetails>
    <SenderDetails>
      <IDAuthentication>
        <SenderID>Our Presenter ID</SenderID>
        <Authentication>
          <Method>clear</Method>
          <Value>Our Password</Value>
        </Authentication>
      </IDAuthentication>
      <EmailAddress></EmailAddress>
    </SenderDetails>
  </Header>
  <GovTalkDetails>
    <Keys/>
  </GovTalkDetails>
  <Body>
    <NameSearchRequest xmlns="http://xmlgw.companieshouse.gov.uk/v1-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlgw.companieshouse.gov.uk/v1-0/schema/NameSearch.xsd">
  <CompanyName>Smarta</CompanyName>
  <DataSet>LIVE</DataSet>
  <SameAs>0</SameAs>
  <SearchRows>20</SearchRows>
</NameSearchRequest>
  </Body>
</GovTalkMessage>

So after a bit of digging… SSL is not supported on this endpoint :frowning:

Connecting over http and using MD5SIGN seems to work with the XMLGatewayTestUserID but not our presenter id.

MD5SIGN: MD5 Hash of

This is my working payload using XMLGatewayTestUserID

<?xml version="1.0" encoding="UTF-8"?>
<GovTalkMessage xsi:schemaLocation="http://www.govtalk.gov.uk/schemas/govtalk/govtalkheader http://xmlgw.companieshouse.gov.uk/v1-0/schema/Egov_ch.xsd" xmlns="http://www.govtalk.gov.uk/schemas/govtalk/govtalkheader" xmlns:dsig="http://www.w3.org/2000/09/xmldsig#" xmlns:gt="http://www.govtalk.gov.uk/schemas/govtalk/core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
  <EnvelopeVersion>1.0</EnvelopeVersion>
  <Header>
    <MessageDetails>
      <Class>NameSearch</Class>
      <Qualifier>request</Qualifier>
      <TransactionID>123</TransactionID>
    </MessageDetails>
    <SenderDetails>
      <IDAuthentication>
        <SenderID>XMLGatewayTestUserID</SenderID>
        <Authentication>
          <Method>MD5SIGN</Method>
          <Value>21850fdb5d03af338550fa46903a3d83</Value>
        </Authentication>
      </IDAuthentication>
      <EmailAddress></EmailAddress>
    </SenderDetails>
  </Header>
  <GovTalkDetails>
    <Keys/>
  </GovTalkDetails>
  <Body>
    <NameSearchRequest xmlns="http://xmlgw.companieshouse.gov.uk/v1-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlgw.companieshouse.gov.uk/v1-0/schema/NameSearch.xsd">
  <CompanyName>Smarta Enterprises</CompanyName>
  <DataSet>LIVE</DataSet>
  <SameAs>1</SameAs>
  <SearchRows>20</SearchRows>
</NameSearchRequest>
  </Body>
</GovTalkMessage>

Are you trying to submit this XML Output submission with your XML Input (Filing) credentials please Clive? If so, this is the reason for the failure. INPUT and OUTPUT are separate CH products that require very different presenter and authentication credentials.

SDN

Thanks Simon,

Is this an additional cost ?

Reason I ask is we have been using the beta rest api for company name checking and were looking to moving over to the xml output gateway.

Cheers

There is a small monthly subscription to pay, and certain items are chargeable. I have now supplied the relevant application form to you via e-mail.

SDN

Hi Simon,

Is there a way you can supply that relevant information here?
Funny enough I was having the same issue while trying to implement the NameSearch.xsd today.

Any help would be much appreciated

Hi Simon,

Any update regarding the subscription for this api… Can you please send the details to my email please

Hello David,

Our XML Gateway based Output service is available as a chargeable product (a limited number of features remain chargeable and a small monthly subscription of £4.70 is required), although the name checker element is free of charge - it is essential that anyone wishing to develop access to the Companies House XML Gateway has sound experience in developing software that uses HTTP and XML - the full technical interface specification, data schemas, prices, details of the information you can access through the Gateway and FAQ’s can be found on our website via the following link. You can access all relevant XML Gateway information here:
http://xmlgw.companieshouse.gov.uk/

Th specification of the authentication can be supplied on request – you will need to employ this method to access the Gateway. This method offers a secure route, employing MD5 encryption, into the Gateway. Failure to use it correctly will result in ‘502’ error messages.

To allow you to test the XML Gateway service, I have included details of a test account for the XML gateway below.

Sender ID = XMLGatewayTestUserID Password = XMLGatewayTestPassword

Please note whatever company information you request using these test credentials, we will return data relating to Millennium Stadium Plc only. Once you’ve confirm that you have successfully used the test account, and have provided us with examples of company/information data download, I will send you an application form for a live account, which you’ll need to complete, sign and return for my private and personal attention to the address below.

I would add that the recently introduced API will fully replace the XML Gateway at a yet to be determined point in the future.

SDN

Many Thanks about the information. I will send a request regarding the live account to you after we had tested everything using our test account.

When you are ready, please provide evidence of your successful testing to snicholas@companieshouse.gov.uk

Thanks
SDN

Hi Simon,

I get a time out error every time I try.

Thanks

Below is the xml request. I could not find any errors with it can you please help

<?xml version="1.0"?>


1.0


NameSearch
request
123



XMLGatewayTestUserID

MD5SIGN
e55ab63de721da504158471518b443e9









ABC LTD
LIVE
0
20


Hello David,

I note you have e-mailed me as well.

I will respond to your e-mail as soon as I am able.

SDN

Hello Simon,

Many thanks

Regards
David