CDD Engine Web Service v2.14.0.0

CompaniesHouseRequest

iNASA

The following routes are available for this service:
GET, POST	/CompaniesHouse/{CompanyNumber}
GET, POST	/CompaniesHouse

**CompaniesHouseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyNumber	path	string	Yes	The registered company number.
Csr	body	string	No	The Csr of the application (if available).

**CompaniesHouseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	CompaniesHouseData	Yes	Contains the companies house lookup result when successful.
ResponseStatus	form	ResponseStatus	No	Contains response status, details and errors.

**CompaniesHouseData** Parameters:
Name	Parameter	Data Type	Required
registeredName	form	string	No
address	form	CompaniesHouseAddress	No
dateOfIncorporation	form	CompaniesHouseIncorporationDate	No
shareHolders	form	List<CompaniesHouseShareHolderData>	No
directors	form	List<CompaniesHouseDirectorsData>	No

**CompaniesHouseAddress** Parameters:
Name	Parameter	Data Type	Required
address1	form	string	No
address2	form	string	No
address3	form	string	No
city	form	string	No
postcode	form	string	No

**CompaniesHouseIncorporationDate** Parameters:
Name	Parameter	Data Type	Required
day	form	int	No
month	form	int	No
year	form	int	No

**CompaniesHouseShareHolderData** Parameters:
Name	Parameter	Data Type	Required
title	form	string	No
firstName	form	string	No
middleNames	form	string	No
lastName	form	string	No
percentageOfVotingSharesOwned	form	double?	No

**CompaniesHouseDirectorsData** Parameters:
Name	Parameter	Data Type	Required
title	form	string	No
firstName	form	string	No
middleNames	form	string	No
lastName	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /CompaniesHouse/{CompanyNumber} HTTP/1.1 
Host: wpcdd-featuretest-ws.worldpay.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyNumber: String,
	Csr: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Result: 
	{
		registeredName: String,
		address: 
		{
			address1: String,
			address2: String,
			address3: String,
			city: String,
			postcode: String
		},
		dateOfIncorporation: 
		{
			day: 0,
			month: 0,
			year: 0
		},
		shareHolders: 
		[
			{
				title: String,
				firstName: String,
				middleNames: String,
				lastName: String,
				percentageOfVotingSharesOwned: 0
			}
		],
		directors: 
		[
			{
				title: String,
				firstName: String,
				middleNames: String,
				lastName: String
			}
		]
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}