Data Returned - Limits

Hi All,

I’m new to this but have successfully integrated the beta companies house search.

Is their documentation that advises the max field lengths for the data returned?

Thank you.

Ian.

@ian_merlino

We have not documented max field lengths but are considering providing a data usage guide which may provide amongst other things expected data lengths, character sets, definition and rules.

However, if you could possibly provide us with some information as to what would be most useful we can then look to incorporate this into our thinking and documentation.

Thanks

@mfairhurst

Hi @mfairhurst,

Thanks for the feedback. I supposed the most important items are max/ min lengths and expected formats.

Regards,

Ian.

Hi
We are trying to establish the max or min field length for the fields and any expected formats of the data that is returned from the API, for fields such as First name, middle name , last name (for Directors) and the company address fields ( Property number, street & county) .
When do you think the data usage guide would be available? Would it possible to get something around the mentioned fields in the interim.

Regards
Edith

@mfairhurst would it be possible to get a copy of your data dictionary for the API.

@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 :grinning: 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

hi do you have any further information on the fields lengths on all the fields that will come through the API / snapshot file as we require specifics for storing the data on our system