The Number One Company Formation Agent!
Contact Formation Company Wizard Contact Us
Company Registration Wizard Resources Resources
Limited Company Wizard Products Products and services
Home - Help - Open Point API Technical Interface Specification (BETA)

Quick Links
menu arrowReseller services
menu itemHow does it work?
menu itemAbout limited companies
menu itemFrequently asked questions
menu itemCompany stationery
menu itemWhite Label Service
menu itemOpen Point API
menu itemCustom Mem & Arts
menu itemCredit accounts
menu itemMoney Laundering Regulations 2007

Open Point API Technical Interface Specification (BETA)

PLEASE NOTE THAT THIS API IS ONLY VALID WITH THE 1985 COMPANIES ACT
We advise clients in the mean time to use our White Label System for deploying a third-party company formation solution.

Further updates will be provided in due course to advise on when the API will be updated.


1. Overview
2. Prerequisites
3. Authentication Mechanism
4. Testing
5. Basic Message Structure
6. Company Name Check
7. Sensitive Word Check
8. New Incorporation



1. Overview


The Company Wizard Open Point API is an extension to the reseller system that enables certain functions to be performed over a remote Web Service. Currently the API supports the following functions.
  • Check company name availability
  • Check company name for sensitive words
  • Submit new Incorporation


As the API evolves additional functions will become available.

2. Prerequisites


To access the API functions you must have a Company Wizard Reseller 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.company-wizard.co.uk/webService/openPoint/API.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 reseller's 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. Company Name Check


The company name check enables the presenter to cross check the availability of a proposed company name against the Companies House register. The use of this method will prevent the likelihood of the application being rejected at a later stage.

During normal service hours with Companies House the method will return a live response as to the availability of a name. Outside service hours the method will check against our backup database. Please note that when the response indicates the check has been done on the backup database there is no guarantee that the name is available. Normal Service hours for a live response are 07:00 to 00:00 Monday to Saturday.

Live Schema
Click here to view the current Schema

Example Request
Click here to view an example request

Request Properties


Property Description Mandatory Type Permissible Values
CompanyName The Company Name to Search Y String (Max 160 Chars) String value, does not need to contain the Limited/LTD suffix
DataSet The Data Set at Companies House to search. Usually LIVE Y String (Max 20 Chars) LIVE, PROPOSED, DISSOLVED, FORMER


7. Sensitive Word Check


Use this method to check the proposed company name for sensitive words. The method will return an iterated response with any sensitive words in the name along with usage instructions and required supporting documentation.

Live Schema
Click here to view the current Schema

Example Request
Click here to view an example request

Request Properties


Property Description Mandatory Type Permissible Values
Matches Indicates whether any sensitive words were found in the name. Y Boolean true/false
Word The sensitive word found in the name Y String (Max 35 Chars) Uppercase String value
Description The requirements setout in the Companies Act for using the word Y String (Max 250 Chars) String
Prompt If the supporting documentation can be supplied inline the prompt will instruct the client what information they need to write in the textbox. N String (Max 250 Chars) May not always be supplied.




8. New Incorporation


This method enables the presenter to submit a new company application for processing. The XML will incorporate the following information.
  • Information about the applicant
  • The proposed company name
  • The registered office address
  • Any mail forwarding address if registered office service address is used (Optional).
  • Delivery address if different from the registered office address (Optional).
  • Share Capital information or objects for limited by guarantee companies.
  • Information on all directors, secretaries and shareholder.
  • Additional items ordered.



White Label Integration
The Open Point API enables you to submit a new company application within the White Label Framework. This ensures that all subsequent client processing and communication can be conducted through a branded portal. By default all submissions will be assumed to be white label unless the ClientAccNumber variable is set to '0000000000' (Ten Zeros). Each new submission will require a unique email and password combination to create an account for the end user client. The email must not have been previously registered on the system and the password must be Base64 Encoded. The tool below will enable you to check your password encryption.

Click here to encrypt or decrypt your password

Live Schema
Click here to view the current Schema

Example Request
Click here to view an example request

Request Properties


Property Description Mandatory Type Permissible Values
Applicant Data
LoginCredentials An email and password combination used to create a new White Label Account C XML Nodes The email must not already be registered with Company Wizard. The password must be between 6 and 20 characters long.
ClientAccNumber A valid White Label Account number already lodged by the presenter. C String Input 0000000000 if the company application should be lodged on the presenters account.
Company Data
CompanyName The Proposed Company Name Y String (Max 160 Chars) String value, must contain Limited/LTD suffix for companies limited by shares
RegisteredOffice The registered office address in England/Scotland Y Nodes Full postal address in England/Wales. PO BOX not permitted
MailForwardingAddress An address where mail will be forwarded if the serviced office address is selected N Nodes Full postal address. The K character must also be included in the order string.
DeliveryAddress An address where the deliverables will be sent if different from the registered office address. N Nodes Full postal address. UK Only. If not supplied the RO address will be used
Share Capital
Currency The 3 character ISO code for the currency used in the share capital. C String(3) Please refer to the full ISO code list
AuthorisedShares The total number of shares in the share capital C Integer MAX(999,999,999)
NominalShareValue The nominal value of each share C Double Default is 1.00
IssuedShares The number of shares issued from the share capital C Integer Must be at least 1 and cannot exceed the number of authorised shares
Objects
Object A sentence or paragraph to define an element of what the company will do. Applicable only to Limited By Guarantee companies. C String(500) Must be at least 1.
Authentication
PersonalAttribute The type of question used for personal authenitcation. Y String BIRTOWN, TEL, NATINS, PASSNO, MUM, EYE, DAD
PersonalData The response to the corresponding personal authentication question. Y String(3) First three letters only.
Director Details
DOB Date of Birth. C DateTime YYYY-MM-DD
Nationality Nationality of the director. C String(30) -
Occupation Occupation of the director. C String(30) -
Other Directorships
CompanyName The name of the company for which the directorship is held. C String(100) -
CompanyNumber The registration number of the company for which the directorship is held. C String(8) Please add leading zeros to ensure the length is fixed at 8
Order Data
PackID The code used to identify which package should be ordered. Y String(8) Please refer to Appendix A
OrderString A collection of characters used to indicate which additional items are to be ordered. Y String(25) Please do not include items which are already included by default in your selected PackID. Please refer to Appendix B


Appendix A


The following list shows the permisable identifying codes for the PackID tag.

reg01 - Basic Incorporation Package
No OrderString items to exclude

reg02 - Standard Incorporation Package
Exclude A and B from the OrderString

reg03 - Executive Incorporation Package
Exclude A, B, C, D and E from the OrderString

reg04 - Guarantee Incorporation Package
Exclude A and B from the OrderString

Appendix B


The following list shows the characters that must be included in the OrderString tag for all the items available on the gateway.

A. Two bound copies of the memorandum and articles
B. Printed certificate of incorporation
C. Combined company register
D. Plier style company seal
E. First board minutes
F. Directors service agreement
G. Employment contract
H. Brass name plate
I. SiteWizard Web Design services
K. London registered office service
M. 0871 Call handling package
N. Alliance and Leicester free business banking
O. SMS Text Alert on completion
Back
   
Company Formation - Employment Contracts - Company Seals - Company Registration Pack - XML Sitemap -
Limited by Guarantee - Confidentiality Agreement - Sitemap - Terms of use - Money Laundering Regulations 2007 - RSS Feed
 
The Company Wizard is registered under the HM Revenue & Customs Money Laundering Scheme (Reg: 12336259)  
Registered Office: 219 Kensington High Street, Kensington, London W8 6BD  
The Company Wizard Limited - Registered in England & Wales - Reg No: 5100477 - ©2013 all rights reserved