removedOutput schema / properties / data / properties
Removed value: -{
- "active_count": {
- "description": "Register-wide count of officers in the register's active bucket. Not a count of the returned page, and not simply 'entries without a resignation date': when a company is dissolved or closed the register moves its serving officers into inactive_count and active_count becomes 0.",
- "type": "integer"
- },
- "company_number": {
- "type": "string"
- },
- "has_more": {
- "description": "Derived; true when officers matching the current filter remain beyond this page — either because more matches were read than limit allows, or because the register list was not exhausted within the three-page read budget. officers.length < limit is NOT a valid end-of-list test, and neither is comparing against total_officers or active_count, which are register-wide.",
- "type": "boolean"
- },
- "inactive_count": {
- "description": "Register-wide count of officers in the register's third bucket — appointments that ended with the company rather than by resignation, which is where the officers of a dissolved or closed company are counted. Null when the register omits the member. Not a count of the returned page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "next_offset": {
- "description": "Derived; the offset to pass to the next request to continue after the last officer returned. Null when has_more is false.",
- "type": [
- "integer",
- "null"
- ]
- },
- "officers": {
- "description": "Officer entries in the register's own order. Resigned entries are omitted unless include_resigned is true; inactive entries (a dissolved company's officers) are always returned, because the register does not treat them as resigned.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "address": {
- "additionalProperties": false,
- "properties": {
- "address_line_1": {
- "type": [
- "string",
- "null"
- ]
- },
- "address_line_2": {
- "type": [
- "string",
- "null"
- ]
- },
- "care_of": {
- "type": [
- "string",
- "null"
- ]
- },
- "country": {
- "type": [
- "string",
- "null"
- ]
- },
- "locality": {
- "type": [
- "string",
- "null"
- ]
- },
- "po_box": {
- "type": [
- "string",
- "null"
- ]
- },
- "postal_code": {
- "type": [
- "string",
- "null"
- ]
- },
- "premises": {
- "type": [
- "string",
- "null"
- ]
- },
- "region": {
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": [
- "object",
- "null"
- ]
- },
- "appointed_on": {
- "format": "date",
- "type": [
- "string",
- "null"
- ]
- },
- "country_of_residence": {
- "type": [
- "string",
- "null"
- ]
- },
- "date_of_birth": {
- "additionalProperties": false,
- "description": "Month and year only, as published on the public register.",
- "properties": {
- "month": {
- "type": "integer"
- },
- "year": {
- "type": "integer"
- }
- },
- "required": [
- "month",
- "year"
- ],
- "type": [
- "object",
- "null"
- ]
- },
- "identification": {
- "additionalProperties": false,
- "description": "Corporate officer identification where the officer is a corporate body.",
- "properties": {
- "identification_type": {
- "type": [
- "string",
- "null"
- ]
- },
- "legal_authority": {
- "type": [
- "string",
- "null"
- ]
- },
- "legal_form": {
- "type": [
- "string",
- "null"
- ]
- },
- "place_registered": {
- "type": [
- "string",
- "null"
- ]
- },
- "registration_number": {
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": [
- "object",
- "null"
- ]
- },
- "is_active": {
- "description": "Derived; true exactly when officer_status is active. It is NOT 'no resignation date recorded': an officer of a dissolved company has no resignation date and is not active.",
- "type": "boolean"
- },
- "name": {
- "description": "Officer name as registered (surname-first for natural persons).",
- "type": "string"
- },
- "nationality": {
- "type": [
- "string",
- "null"
- ]
- },
- "occupation": {
- "type": [
- "string",
- "null"
- ]
- },
- "officer_status": {
- "description": "Derived from the register's own three officer buckets: resigned when the entry carries a resignation date; inactive when it does not but the register reports no active officers and a non-zero inactive_count (the appointment ended with a dissolved or closed company); otherwise active. It describes the register entry, not the company — check company.uk.status for the company's own state.",
- "enum": [
- "active",
- "resigned",
- "inactive"
- ],
- "type": "string"
- },
- "resigned_on": {
- "format": "date",
- "type": [
- "string",
- "null"
- ]
- },
- "role": {
- "corporate-director).": null,
- "description": "Companies House officer_role (e.g. director",
- "llp-member": null,
- "secretary": null,
- "type": "string"
- }
- },
- "required": [
- "name",
- "role",
- "officer_status",
- "is_active",
- "appointed_on",
- "resigned_on"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "offset": {
- "description": "The register index this page started at (the requested offset).",
- "type": "integer"
- },
- "resigned_count": {
- "description": "Register-wide count of resigned officers. Not a count of the returned page.",
- "type": "integer"
- },
- "total_officers": {
- "description": "Total officer entries on the register for this company (active + inactive + resigned). Register-wide",
- "not a count of the returned page.": null,
- "type": "integer"
- }
-}