action credas_search_company {
  label: "Searches for a company based on its Company Number and returns its details."
  description: "If a company appears multiple times within the structure, it will only be detailed in full (i.e. with significant ownership details) in its first instance. Subsequent instances will be 
\n            marked as duplicates.
\n            Whilst duplicate instances of companies can and will be identified, it is not possible to categorically identify duplicated people."
  provider: credas
  method: POST
  path: "/api/companies"
  encoding: json
  input: {
    type: "object"
    properties: {
      apikey: {
        type: "string"
      }
      companyNumber: {
        type: "string"
      }
    }
    required: ["apikey"]
    additionalProperties: false
  }
  output: {
    type: "object"
    properties: {
      addressLine1: {
        type: "string"
      }
      companyName: {
        type: "string"
      }
      companyNumber: {
        type: "string"
      }
      dateOfRegistration: {
        type: "string"
        format: "date-time"
      }
      duplicate: {
        type: "boolean"
      }
      id: {
        type: "string"
        format: "uuid"
      }
      locality: {
        type: "string"
      }
      postCode: {
        type: "string"
      }
      region: {
        type: "string"
      }
      significantParentCompanies: {
        type: "array"
        items: {
          type: "object"
          additionalProperties: true
        }
      }
      significantPeople: {
        type: "array"
        items: {
          type: "object"
          properties: {
            forename: {
              type: "string"
            }
            id: {
              type: "string"
              format: "uuid"
            }
            regEntryId: {
              type: "string"
              format: "uuid"
            }
            surname: {
              type: "string"
            }
          }
        }
      }
    }
  }
}