@edith_manyumwa
The data dictionary for the API is published for each endpoint within the documentation: - https://developer.companieshouse.gov.uk/api/docs/
For each resource returned we provide the following: -
Parameter Name: The name of the field
Type: The data type
Description: A brief description
Additional: Details if its optional
We haven’t published field lengths as we are discussing if todo so and the most appropriate method. The reasoning behind being so reserved is we do not want to restrict ourselves and others with specific field lengths as changing in the future could be classed as a breaking change to the API and we want to limit breaking changes.
However to provide some information, the following details the maximum field lengths, at present, for the specific fields requested, but this may change in the future, so use for guidance, so maybe use double these values This should not be treated as official documentation as we have stated we are currently in the process of evaluating.
address" : {
"address_line_1" : "string", 64 characters
"address_line_2" : "string", 64 characters
"care_of" : "string", 100 characters
"country" : "string", 50 characters
"locality" : "string", 50 characters
"po_box" : "string", 10 characters
"postal_code" : "string", 15 characters
"premises" : "string", 50 characters
"region" : "string" 50 characters
"name_elements" : {
"forename" : "string", 50 characters
"honours" : "string", 50 characters
"other_forenames" : "string", 50 characters
"surname" : "string", 160 characters
"title" : "string" 50 characters
Hope this is of help
Thanks
@mfairhurst