Prefer to talk?
9:00 to 17:30 (Weekdays)
Menu

WLS Data API Technical Interface Specification

1. Overview



The White Label System (WLS) API enables account holders to programmatically access information on their respective client accounts and company incorporations. The service is accessible over a remote web service.

The WLS Data API currently supports the following functions:
  • Client account search (By date range)
  • New incorporation search (By date range)
  • Full company data.

2. Prerequisites



To access the API functions you must have an active Company Wizard white label account. Communication with the web service is made via the Simple Object Access Protocol (SOAP) Standard with the data encapsulated into XML feeds and delivered via HTTP.

All the methods available through the API can be previewed from here:
http://www.companywizard.co.uk/webservice/wls/dataAccess.asmx

3. Authentication Mechanism



The API uses a simple authentication mechanism to validate each request. The authentication credentials are embedded within the header of each submission.

The API uses the following details to authenticate the submission

Account Number
The resellers unique account number.

Account Password
The password associated with the account

Submission Number
An alphanumeric string issued by the presenter that uniquely identifies every submission. The same submission number cannot be used more than once on the API.

MD5 Encrypted Authentication Key
This is an MD5 encryption of the Account Number, password and submission number. The three values are concatenated and then hashed using the MD5 algorithm. The submission number is used to salt the encryption so it cannot be intercepted and reused.

For Example....Account Number: 123456789
Password: asparagus22
Submission Number: 00001

This would be concatenated to: 123456789asparagus2200001
The resulting MD5 Hash would be: 089ef626788b8bfdc9f813864df62085



The following online tool can be used to MD5 encrypt your string:
http://www.logicalpackets.com/md5.asp

4. Basic Message Structure



Each submission on the API adheres to a basic format which includes a header and footer section. The header will encapsulate any information relating to the type of message, the authentication data, the unique submission number and whether the submission is for a test or live transaction. The body contains content specific to the type of request being made. The API response follows a similar format with a header and body section.

Submission Numbers
Each call to the API must be made with a unique submission number. If a duplicate submission number is transmitted then the API will return an error. This rule however is not enforced for the purpose of testing the gateway, therefore please ensure the TestMode tag is set to true while developing against the API.

5. Testing



When testing your application you should set the TestMode tag to 'true'. This will negate the requirement to use unique submission numbers.

The following tool is provided to enable you to submit your xml documents against the API.

API Test Utility

6. Client Account Search



The client account search enables the presenter to retrieve all client accounts created over a specified time period. This function will also show the company profiles associated with each respective account.

Live Schema
Click here to view the current Schema

Example Request
Click here to view an example request

Request Properties

PropertyDescriptionMandatoryTypePermissible Values
MasterAccNumberThe parent account you wish to searchYString (Max 50 Chars)String value
StartDateThe start date for the period you wish to search.YDateTimee.g. 2001-10-26T21:32:52
EndDateThe end date for the period you wish to search.YDateTimee.g. 2008-10-26T21:32:52

7. Incorporated Company Search



The incorporated company search enables the presenter to retrieve all companies incorporated on all associated accounts over a specified time period. This function will return the company name, number, incorporation date, authorisation code and account details.

Live Schema
Click here to view the current Schema

Example Request
Click here to view an example request

Request Properties

PropertyDescriptionMandatoryTypePermissible Values
MasterAccNumberThe parent account you wish to searchYString (Max 50 Chars)String value
StartDateThe start date for the period you wish to search.YDateTimee.g. 2001-10-26T21:32:52
EndDateThe end date for the period you wish to search.YDateTimee.g. 2008-10-26T21:32:52

8. Full Company Data Request



The full company data request enables the presenter to retrieve the source XML for a given company. The response contains all the information filed in relation to the company name, registered office, statement of capital, director details, shareholdings and authentication data. This function requires a document request key that is supplied in the response for an incorporated company search response.

Live Schema
Click here to view the current Schema

Example Request
Click here to view an example request

Request Properties

PropertyDescriptionMandatoryTypePermissible Values
DocKeyThe request key to obtain the company data. This is supplied in the incorporated company search response.YString (Max 100 Chars)String value
Recent Support Articles