Skip to content
Connect API Catalog/
/
/
GB IDV Response
Last updated

UK IDV Product: Additional Data Details

The additionalData field in company reports for the UK contains director-specific information, including Companies House verification status and appointment details.
This field is polymorphic and may take one of several forms.

Where to Find additionalData

The additionalData field is located in the company report response under the directors section, specifically within current directors.
Look for additionalData inside each current director object.

companiesHouseIdVerified Field

This field indicates the verification status of the director with Companies House:

  • "-" : Not Yet Verified
  • "Yes" : Successfully Verified
  • "No" : Not Verified by required date

Example Structure

{
  "honours": "OBE",
  "presentAppointments": 2,
  "previousAppointments": 5,
  "dissolvedAppointments": 1,
  "disqualified": false,
  "disqualificationEndDate": "2023-12-31T00:00:00Z",
  "disqualificationException": false,
  "occupation": "Director",
  "contactOfResponsibility": "Finance",
  "firstResponsibility": "Accounting",
  "secondResponsibility": "Compliance",
  "companiesHouseIdVerified": "Yes"
}

Schema Overview

additionalData:
  type: object
  oneOf:
    - type: object
      properties:
        honours:
          type: string
          description: Honorary titles or awards held by the director.
        presentAppointments:
          type: integer
          description: Number of current company appointments.
        previousAppointments:
          type: integer
          description: Number of previous company appointments.
        dissolvedAppointments:
          type: integer
          description: Number of dissolved company appointments.
        disqualified:
          type: boolean
          description: Indicates if the director is currently disqualified.
        disqualificationEndDate:
          type: string
          format: date-time
          description: Date when the disqualification ends.
        disqualifiedException:
          type: boolean
          description: Indicates if there is an exception to the disqualification.
        occupation:
          type: string
          description: Director's occupation.
        contactOfResponsibility:
          type: string
          description: Main contact or area of responsibility.
        firstResponsibility:
          type: string
          description: Primary responsibility of the director.
        secondResponsibility:
          type: string
          description: Secondary responsibility of the director.
        companiesHouseIdVerified:
          type: string
          description: |
            Indicates Companies House ID verification status.
            Possible values:
              - "-" : Not Yet Verified
              - "Yes" : Successfully Verified
              - "No" : Not Verified by required date
    - type: object
      properties:
        honours:
          type: string
          description: Honorary titles or awards held by the director.
        companiesHouseIdVerified:
          type: string
          description: |
            Indicates Companies House ID verification status.
            Possible values:
              - "-" : Not Yet Verified
              - "Yes" : Successfully Verified
              - "No" : Not Verified by required date
        disqualified:
          type: boolean
          description: Indicates if the director is currently disqualified.
        disqualificationStartDate:
          type: string
          format: date-time
          description: Date when the disqualification starts.
        disqualificationEndDate:
          type: string
          format: date-time
          description: Date when the disqualification ends.
        sectionOfAct:
          type: string
          description: Section of the act under which the director is disqualified.
        disqualifiedException:
          type: boolean
          description: Indicates if there is an exception to the disqualification.
        disqualifiedExceptions:
          type: array
          description: List of exceptions to the director's disqualification.
          items:
            type: object
            properties:
              companyName:
                type: string
                description: Name of the company related to the exception.
              companyRegistrationNumber:
                type: string
                description: Registration number of the company.
              position:
                type: string
                description: Position held by the director in the company.
              status:
                type: string
                description: Status of the exception.
              endDate:
                type: string
                format: date-time
                description: End date of the exception.
        eircode:
          type: string
          description: Eircode (postcode) of the company or director.
        incorporationDate:
          type: string
          format: date-time
          description: Date the company was incorporated.

Notes

  • The structure of additionalData may change as new products or fields are added.
  • For other countries, the additionalData field may be empty or have a different structure.
  • Always check the country before processing additionalData.
    For details on the company response structure for a defined country, see Company Report Schema by Country.

See Also

Previous page
Next page