GET, POST | /CompaniesHouse/{CompanyNumber} | ||
---|---|---|---|
GET, POST | /CompaniesHouse |
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). |
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. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
registeredName | form | string | No | |
address | form | CompaniesHouseAddress | No | |
dateOfIncorporation | form | CompaniesHouseIncorporationDate | No | |
shareHolders | form | List<CompaniesHouseShareHolderData> | No | |
directors | form | List<CompaniesHouseDirectorsData> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
address1 | form | string | No | |
address2 | form | string | No | |
address3 | form | string | No | |
city | form | string | No | |
postcode | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
day | form | int | No | |
month | form | int | No | |
year | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
title | form | string | No | |
firstName | form | string | No | |
middleNames | form | string | No | |
lastName | form | string | No | |
percentageOfVotingSharesOwned | form | double? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 .csv suffix or ?format=csv
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: wp-cddws-test.worldpay.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"CompanyNumber":"String","Csr":"String"}
HTTP/1.1 200 OK Content-Type: text/csv 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"}}}