Version : 0.0.1 [v.1]
Base URL : https://public-api.crunch.co.uk/v1/company-details
GET /
HTTP Code | Description | Schema |
---|---|---|
200 | The user’s company data has been returned | ResponseWrapper |
404 | The user data could not be found | No Content |
500 | An unexpected error occurred while processing the request for company details. | No Content |
Type | Name | Scopes |
---|---|---|
Unknown | oauth2-authorisation-code | read:all |
/
{
"content" : [ {
"businessAddress" : {
"addressCity" : "string",
"addressCountry" : "string",
"addressLine1" : "string",
"addressPostCode" : "string"
},
"companyName" : "string",
"companyNumber" : "string",
"registeredAddress" : {
"addressCity" : "string",
"addressCountry" : "string",
"addressLine1" : "string",
"addressPostCode" : "string"
},
"vatRegistrationNumber" : "string",
"vatSchemeChanges" : [ {
"dateFrom" : "string",
"dateTo" : "string",
"industry" : "string",
"limitedCostTrader" : true,
"vatScheme" : "string"
} ]
} ]
}
Name | Description | Schema |
---|---|---|
addressCity optional |
Length : 1 - 40 Example : "string" |
string |
addressCountry optional |
Length : 1 - 80 Example : "string" |
string |
addressLine1 optional |
Length : 1 - 255 Example : "string" |
string |
addressPostCode optional |
Length : 1 - 20 Example : "string" |
string |
Name | Description | Schema |
---|---|---|
businessAddress optional |
Example : "[address](#address)" |
Address |
companyName optional |
Example : "string" |
string |
companyNumber optional |
Example : "string" |
string |
registeredAddress optional |
Example : "[address](#address)" |
Address |
vatRegistrationNumber optional |
Example : "string" |
string |
vatSchemeChanges optional |
Example : [ "[vatschemechange](#vatschemechange)" ] |
< VatSchemeChange > array |
Name | Description | Schema |
---|---|---|
content optional |
Example : [ "[companydetails](#companydetails)" ] |
< CompanyDetails > array |
Name | Description | Schema |
---|---|---|
dateFrom optional |
Example : "string" |
string (date-time) |
dateTo optional |
Example : "string" |
string (date-time) |
industry optional |
Example : "string" |
string |
limitedCostTrader optional |
Example : true |
boolean |
vatScheme optional |
Example : "string" |
string |