CDD Engine Web Service v2.14.0.0

<back to all web services

CompaniesHouseRequest

iNASA
Requires Authentication
The following routes are available for this service:
GET, POST/CompaniesHouse/{CompanyNumber}
GET, POST/CompaniesHouse
CompaniesHouseRequest Parameters:
NameParameterData TypeRequiredDescription
CompanyNumberpathstringYesThe registered company number.
CsrbodystringNoThe Csr of the application (if available).
CompaniesHouseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformCompaniesHouseDataYesContains the companies house lookup result when successful.
ResponseStatusformResponseStatusNoContains response status, details and errors.
CompaniesHouseData Parameters:
NameParameterData TypeRequiredDescription
registeredNameformstringNo
addressformCompaniesHouseAddressNo
dateOfIncorporationformCompaniesHouseIncorporationDateNo
shareHoldersformList<CompaniesHouseShareHolderData>No
directorsformList<CompaniesHouseDirectorsData>No
CompaniesHouseAddress Parameters:
NameParameterData TypeRequiredDescription
address1formstringNo
address2formstringNo
address3formstringNo
cityformstringNo
postcodeformstringNo
CompaniesHouseIncorporationDate Parameters:
NameParameterData TypeRequiredDescription
dayformintNo
monthformintNo
yearformintNo
CompaniesHouseShareHolderData Parameters:
NameParameterData TypeRequiredDescription
titleformstringNo
firstNameformstringNo
middleNamesformstringNo
lastNameformstringNo
percentageOfVotingSharesOwnedformdouble?No
CompaniesHouseDirectorsData Parameters:
NameParameterData TypeRequiredDescription
titleformstringNo
firstNameformstringNo
middleNamesformstringNo
lastNameformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"CompanyNumber":"String","Csr":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}