> ## Documentation Index
> Fetch the complete documentation index at: https://docs.baselayer.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get International Search

> Retrieve an international business search by ID.



## OpenAPI

````yaml /api-reference/openapi.json get /international/searches/{id}
openapi: 3.1.0
info:
  title: baselayer-api-service
  version: 0.1.0
servers:
  - url: https://api.baselayer.com/
security: []
paths:
  /international/searches/{id}:
    get:
      tags:
        - International
      summary: Get International Search
      description: Retrieve an international business search by ID.
      operationId: get_international_search_international_searches__id__get
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Search ID
            description: The unique identifier of the international search to retrieve.
            examples:
              - 412a49b5-7466-426b-bf1e-081b00b54576
              - 9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5
          description: The unique identifier of the international search to retrieve.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1.InternationalBusinessSearchResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    v1.InternationalBusinessSearchResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Unique identifier for the international business search.
        user:
          anyOf:
            - $ref: '#/components/schemas/v1.UserAttributionResponse'
            - type: 'null'
          description: Details on the User who performed the search.
        state:
          $ref: '#/components/schemas/TaskState'
          description: The current state of the search.
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: >-
            The name inputted in the search (null for filing-number-only
            searches).
          examples:
            - Acme Corporation
        address:
          anyOf:
            - type: string
            - type: 'null'
          title: Address
          description: >-
            The address string inputted in the search (null for
            filing-number-only searches).
          examples:
            - 1640 Riverside Drive, Hill Valley, CA
        iso2_country_code:
          anyOf:
            - $ref: '#/components/schemas/InternationalSearchISO2CountryCode'
            - type: 'null'
          description: The ISO 2 country code the search ran against.
          examples:
            - GB
        search_address:
          anyOf:
            - $ref: '#/components/schemas/v1.InternationalAddressSummaryResponse'
            - type: 'null'
          description: The sanitized address inputted in the search.
        filing_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Filing Number
          description: The company registration (filing) number inputted in the search.
          examples:
            - '09517735'
        reference_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Reference Id
          description: The reference ID inputted in the search.
          examples:
            - Search1234
        business_name_match:
          anyOf:
            - $ref: '#/components/schemas/MatchType'
            - type: 'null'
          description: >-
            Indicates how close the inputted name matches the found business
            entity.
          examples:
            - EXACT
        business_address_match:
          anyOf:
            - $ref: '#/components/schemas/InternationalAddressMatchType'
            - type: 'null'
          description: >-
            Indicates how close the inputted address matches the found business
            entity.
          examples:
            - EXACT
        filing_number_match:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Filing Number Match
          description: >-
            Whether the inputted filing number found the company at the
            registry. False means the search fell back to the name search; null
            means no filing number was provided.
          examples:
            - true
        created_at:
          type: string
          format: date-time
          title: Created At
          description: The datetime the search was created.
          examples:
            - '2026-08-31T10:31:07.837093'
        updated_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Updated At
          description: >-
            The datetime the search was updated at (generally when the search
            completed).
          examples:
            - '2026-08-31T10:31:07.837103'
        verified:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Verified
          description: >-
            Indicates whether the found business was a close enough match to be
            considered verified.
          examples:
            - true
            - false
        scores:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.ScoreResponse'
              type: array
            - type: 'null'
          title: Scores
          description: An array containing Baselayer's ratings.
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
          description: Any errors that occurred.
        warnings:
          items:
            type: string
          type: array
          title: Warnings
          description: Any warnings that occurred.
          default: []
          examples:
            - Address validation is unavailable.
        options:
          items:
            $ref: '#/components/schemas/InternationalBusinessSearchOptions'
          type: array
          title: Options
          description: Optional, separately-billed add-ons requested for this search.
          examples:
            - - Order.Enhanced
        business:
          anyOf:
            - $ref: '#/components/schemas/v1.InternationalBusinessResponse'
            - type: 'null'
          description: >-
            A summary of the found business. When the enhanced profile add-on is
            ordered, this also includes officers, beneficial owners,
            shareholders, share capital, contact details, and the registered
            agent, along with fuller registry and tax identifiers and classified
            business activities.
        url:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
          title: Url
          description: The API URL to retrieve the search.
          examples:
            - >-
              https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314
      type: object
      required:
        - id
        - state
        - created_at
        - url
      title: InternationalBusinessSearchResponse (v1)
      description: Response model for international business search.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    v1.UserAttributionResponse:
      description: |-
        Response model for user attribution operations.

        This model defines the structure for user attribution API responses.
      properties:
        id:
          description: Unique identifier for the user.
          format: uuid
          title: Id
          type: string
        first_name:
          description: First name of the user.
          examples:
            - Austin
          title: First Name
          type: string
        last_name:
          description: Last name of the user.
          examples:
            - Taylor
          title: Last Name
          type: string
        email:
          description: Email address of the user.
          examples:
            - jessicasimpson@example.com
          title: Email
          type: string
      required:
        - id
        - first_name
        - last_name
        - email
      title: UserAttributionResponse (v1)
      type: object
    TaskState:
      enum:
        - PENDING
        - EXECUTING
        - COMPLETED
        - FAILED
        - CANCELLED
      title: TaskState
      type: string
    InternationalSearchISO2CountryCode:
      description: >-
        Enumeration of ISO 3166-1 alpha-2 country codes supported for
        international searches.


        This is a subset of ISO2CountryCode that includes only jurisdictions
        where

        international search capabilities are available.
      enum:
        - AR
        - AU
        - AT
        - BE
        - BR
        - CA
        - CZ
        - DK
        - FI
        - FR
        - DE
        - IN
        - IE
        - IT
        - JP
        - KE
        - LU
        - MY
        - MX
        - NL
        - NZ
        - NG
        - 'NO'
        - PL
        - PT
        - SA
        - SK
        - ES
        - SE
        - CH
        - TR
        - UA
        - GB
      title: InternationalSearchISO2CountryCode
      type: string
    v1.InternationalAddressSummaryResponse:
      properties:
        premise:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Alphanumeric code for the location (e.g., building number).
          examples:
            - 221B
          title: Premise
        thoroughfare:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Complete street name.
          examples:
            - Baker Street
          title: Thoroughfare
        dependent_thoroughfare:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Secondary street name or cross street.
          examples:
            - Marylebone Road
          title: Dependent Thoroughfare
        locality:
          description: Most common population center (e.g., city name).
          examples:
            - London
          title: Locality
          type: string
        dependent_locality:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Additional locality information (e.g., neighborhood, district).
          examples:
            - Westminster
          title: Dependent Locality
        administrative_area:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Most common administrative division (e.g., province, state, region).
          examples:
            - England
          title: Administrative Area
        postal_code:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Complete postal code.
          examples:
            - NW1 6XE
          title: Postal Code
        country_iso_3:
          description: ISO 3166-1 alpha-3 country code (e.g., 'CAN', 'GBR', 'AUS').
          examples:
            - GBR
          maxLength: 3
          minLength: 3
          title: Country Iso 3
          type: string
        latitude:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: Latitude coordinate of the address.
          examples:
            - 51.5237
          title: Latitude
        longitude:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: Longitude coordinate of the address.
          examples:
            - -0.1585
          title: Longitude
        type:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Registry-provided address type, e.g. Registered Office, Principal
            Place of Business, or SAIL.
          examples:
            - Registered Office
          title: Type
        full_address:
          description: Return the complete formatted address for display.
          readOnly: true
          title: Full Address
          type: string
      required:
        - locality
        - country_iso_3
        - full_address
      title: InternationalAddressSummaryResponse (v1)
      type: object
    MatchType:
      enum:
        - NO_MATCH
        - SIMILAR
        - EXACT
      title: MatchType
      type: string
    InternationalAddressMatchType:
      enum:
        - NO_MATCH
        - REGION
        - CITY
        - COUNTRY
        - EXACT
      title: InternationalAddressMatchType
      type: string
    v1.ScoreResponse:
      properties:
        type:
          $ref: '#/components/schemas/v1.ScoreType'
          description: The type of score.
          examples:
            - risk
        score:
          description: The score value.
          examples:
            - 95
          title: Score
          type: number
        rating:
          description: The rating associated with the score.
          examples:
            - A
            - B
          title: Rating
          type: string
      required:
        - type
        - score
        - rating
      title: ScoreResponse (v1)
      type: object
    InternationalBusinessSearchOptions:
      type: string
      enum:
        - Order.Enhanced
    v1.InternationalBusinessResponse:
      properties:
        name:
          description: The name of the international business.
          examples:
            - Acme Corporation
          title: Name
          type: string
        file_number:
          description: The file number of the registration.
          examples:
            - '867124'
          title: File Number
          type: string
        status:
          $ref: '#/components/schemas/v1.CorporateRegistrationStatus'
          description: >-
            Status field indicating whether the corporate registration filing is
            active or inactive.
          examples:
            - active
            - inactive
            - unknown
        standing:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            The registry's own status wording behind the coarse `status` (e.g.
            'Registered', 'In Liquidation').
          examples:
            - Registered
          title: Standing
        legal_form:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            The registry's legal form / legal structure for the business (e.g.
            'ltd', 'gmbh').
          examples:
            - ltd
          title: Legal Form
        country:
          $ref: '#/components/schemas/v1.InternationalSearchISO2CountryCode'
          description: The country of the international business.
          examples:
            - GB
        issue_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          default: null
          description: The date the registration was issued.
          examples:
            - '2024-01-01'
          title: Issue Date
        incorporation_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          default: null
          description: >-
            The date the international business was incorporated. Often the same
            as the issue date.
          examples:
            - '2024-01-01'
          title: Incorporation Date
        last_annual_account_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          default: null
          description: >-
            The date of the business's most recent annual account filing (a
            data-freshness signal).
          examples:
            - '2024-01-01'
          title: Last Annual Account Date
        dissolution_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          default: null
          description: >-
            The date the business was dissolved, when the registry provides it.
            Populated only when the enhanced profile add-on was ordered.
          examples:
            - '2024-01-01'
          title: Dissolution Date
        dissolved:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Whether the registry data indicates the business is dissolved.
          examples:
            - false
          title: Dissolved
        registration_authority:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Registry authority name, e.g. Companies House, United Kingdom.
          examples:
            - Companies House, United Kingdom
          title: Registration Authority
        registration_authority_code:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Registry authority code where provided, e.g. CA-ON or CA-FE.
          examples:
            - CA-ON
          title: Registration Authority Code
        registration_type:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Registry-provided registration type, e.g. Federal, Extra-Provincial,
            or Registered society.
          examples:
            - Federal
          title: Registration Type
        registry_type:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Registry-provided entity or registry type where distinct from legal
            form.
          examples:
            - Registered society
          title: Registry Type
        addresses:
          default: []
          description: The addresses of the international business.
          examples:
            - administrative_area: CA
              country_iso_3: USA
              dependent_locality: null
              dependent_thoroughfare: null
              full_address: 123, Main St, Anytown, CA, 12345, USA
              latitude: 37.7749
              locality: Anytown
              longitude: -122.4194
              postal_code: '12345'
              premise: '123'
              thoroughfare: Main St
              type: null
          items:
            $ref: '#/components/schemas/v1.InternationalAddressSummaryResponse'
          title: Addresses
          type: array
        alternative_names:
          description: >-
            A list of alternative names (e.g. DBAs, trading names, and former
            registered names) found associated with the business entity.
          examples:
            - - Ramos, Garcia and Good
          items:
            type: string
          title: Alternative Names
          type: array
        officers:
          description: >-
            Directors and officers of the business. Populated only when the
            enhanced profile add-on was ordered.
          items:
            $ref: '#/components/schemas/v1.InternationalOfficer'
          title: Officers
          type: array
        beneficial_owners:
          description: >-
            Ultimate beneficial owners of the business from structured UBO
            filings, plus registry role-based ownership signals such as
            Australian Ultimate Holding Company representatives. Populated only
            when the enhanced profile add-on was ordered.
          items:
            $ref: '#/components/schemas/v1.InternationalBeneficialOwner'
          title: Beneficial Owners
          type: array
        shareholders:
          description: >-
            Shareholders of the business. Populated only when the enhanced
            profile add-on was ordered.
          items:
            $ref: '#/components/schemas/v1.InternationalShareholder'
          title: Shareholders
          type: array
        share_capital:
          description: >-
            Share capital structure of the business. Populated only when the
            enhanced profile add-on was ordered.
          items:
            $ref: '#/components/schemas/v1.InternationalShareCapital'
          title: Share Capital
          type: array
        contact:
          anyOf:
            - $ref: '#/components/schemas/v1.InternationalCompanyContact'
            - type: 'null'
          default: null
          description: >-
            Contact details for the business. Populated only when the enhanced
            profile add-on was ordered.
        identifiers:
          anyOf:
            - $ref: '#/components/schemas/v1.InternationalCompanyIdentifiers'
            - type: 'null'
          default: null
          description: >-
            Additional registry and tax identifiers beyond the top-level file
            number. Fully populated only when the enhanced profile add-on was
            ordered.
        activities:
          description: >-
            Classified business activities (e.g. SIC / NACE codes) for the
            business. Fully populated only when the enhanced profile add-on was
            ordered.
          items:
            $ref: '#/components/schemas/v1.InternationalBusinessActivity'
          title: Activities
          type: array
        registered_agent:
          anyOf:
            - $ref: '#/components/schemas/v1.InternationalRegisteredAgent'
            - type: 'null'
          default: null
          description: >-
            The registered agent listed for the business. Populated only when
            the enhanced profile add-on was ordered.
      required:
        - name
        - file_number
        - status
        - country
      title: InternationalBusinessResponse (v1)
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    v1.ScoreType:
      enum:
        - fraud
        - risk
        - kyb
      title: ScoreType
      type: string
    v1.CorporateRegistrationStatus:
      description: |-
        Status field indicating whether the corporate registration filing is
        active or inactive.
      enum:
        - active
        - inactive
        - unknown
      title: CorporateRegistrationStatus
      type: string
    v1.InternationalSearchISO2CountryCode:
      description: >-
        Enumeration of ISO 3166-1 alpha-2 country codes supported for
        international searches.


        This is a subset of ISO2CountryCode that includes only jurisdictions
        where

        international search capabilities are available.
      enum:
        - AR
        - AU
        - AT
        - BE
        - BR
        - CA
        - CZ
        - DK
        - FI
        - FR
        - DE
        - IN
        - IE
        - IT
        - JP
        - KE
        - LU
        - MY
        - MX
        - NL
        - NZ
        - NG
        - 'NO'
        - PL
        - PT
        - SA
        - SK
        - ES
        - SE
        - CH
        - TR
        - UA
        - GB
      title: InternationalSearchISO2CountryCode
      type: string
    v1.InternationalOfficer:
      description: A director or officer of an international business (enhanced profile).
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Name of the party as recorded in the registry. For a person this is
            their full name; for a corporate party it is the company name.
          title: Name
        entity_type:
          anyOf:
            - $ref: '#/components/schemas/v1.BusinessOrPersonType'
            - type: 'null'
          default: null
          description: >-
            Whether this party is a business or a person. Null when the registry
            does not classify the party as either.
        date_of_birth:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          default: null
          description: >-
            Date of birth of the party when the party is a person. Registries
            commonly disclose only the month and year, in which case the day
            defaults to the first of the month.
          title: Date Of Birth
        nationality:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Nationality of the party when the party is a person.
          title: Nationality
        place_of_residence:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Place of residence of the party when the party is a person, as a
            single formatted address string.
          title: Place Of Residence
        place_of_birth:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Place of birth of the party when the party is a person, as a single
            formatted address string.
          title: Place Of Birth
        address:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Correspondence or registered address of the party, as a single
            formatted address string.
          title: Address
        id_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Registry-assigned identifier for the party (e.g. a personal or
            entity reference number in the source registry).
          title: Id Number
        registration_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Company registration number of the party when the party is itself a
            corporation. Null for individual parties.
          title: Registration Number
        titles:
          description: >-
            The officer's role titles at this business (e.g. "Director",
            "Secretary").
          items:
            type: string
          title: Titles
          type: array
        is_active:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Whether the officer's appointment is currently active.
          title: Is Active
        powers:
          description: >-
            Powers or authorities granted to the officer, as described by the
            registry (e.g. authority to represent the company).
          items:
            type: string
          title: Powers
          type: array
        start_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          default: null
          description: Date the officer's appointment began.
          title: Start Date
        end_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          default: null
          description: Date the officer's appointment ended, if it is no longer active.
          title: End Date
        directorships:
          description: >-
            Other companies at which this officer holds or held a role, when the
            registry discloses them.
          items:
            $ref: '#/components/schemas/v1.InternationalOfficerDirectorship'
          title: Directorships
          type: array
      title: InternationalOfficer
      type: object
    v1.InternationalBeneficialOwner:
      description: >-
        An ultimate beneficial owner of an international business (enhanced
        profile).
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Name of the party as recorded in the registry. For a person this is
            their full name; for a corporate party it is the company name.
          title: Name
        entity_type:
          anyOf:
            - $ref: '#/components/schemas/v1.BusinessOrPersonType'
            - type: 'null'
          default: null
          description: >-
            Whether this party is a business or a person. Null when the registry
            does not classify the party as either.
        date_of_birth:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          default: null
          description: >-
            Date of birth of the party when the party is a person. Registries
            commonly disclose only the month and year, in which case the day
            defaults to the first of the month.
          title: Date Of Birth
        nationality:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Nationality of the party when the party is a person.
          title: Nationality
        place_of_residence:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Place of residence of the party when the party is a person, as a
            single formatted address string.
          title: Place Of Residence
        place_of_birth:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Place of birth of the party when the party is a person, as a single
            formatted address string.
          title: Place Of Birth
        address:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Correspondence or registered address of the party, as a single
            formatted address string.
          title: Address
        id_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Registry-assigned identifier for the party (e.g. a personal or
            entity reference number in the source registry).
          title: Id Number
        registration_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Company registration number of the party when the party is itself a
            corporation. Null for individual parties.
          title: Registration Number
        nature_of_control:
          description: >-
            How the owner exercises control over the business, as described by
            the registry (e.g. ownership-of-shares or voting-rights statements).
          items:
            type: string
          title: Nature Of Control
          type: array
        notified_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          default: null
          description: Date the registry was notified of the beneficial ownership.
          title: Notified Date
        kind:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            The registry's classification of the beneficial owner (e.g. its
            person-with-significant-control kind).
          title: Kind
        start_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          default: null
          description: Date the beneficial ownership began.
          title: Start Date
      title: InternationalBeneficialOwner
      type: object
    v1.InternationalShareholder:
      description: A shareholder of an international business (enhanced profile).
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Name of the party as recorded in the registry. For a person this is
            their full name; for a corporate party it is the company name.
          title: Name
        entity_type:
          anyOf:
            - $ref: '#/components/schemas/v1.BusinessOrPersonType'
            - type: 'null'
          default: null
          description: >-
            Whether this party is a business or a person. Null when the registry
            does not classify the party as either.
        date_of_birth:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          default: null
          description: >-
            Date of birth of the party when the party is a person. Registries
            commonly disclose only the month and year, in which case the day
            defaults to the first of the month.
          title: Date Of Birth
        nationality:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Nationality of the party when the party is a person.
          title: Nationality
        place_of_residence:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Place of residence of the party when the party is a person, as a
            single formatted address string.
          title: Place Of Residence
        place_of_birth:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Place of birth of the party when the party is a person, as a single
            formatted address string.
          title: Place Of Birth
        address:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Correspondence or registered address of the party, as a single
            formatted address string.
          title: Address
        id_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Registry-assigned identifier for the party (e.g. a personal or
            entity reference number in the source registry).
          title: Id Number
        registration_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Company registration number of the party when the party is itself a
            corporation. Null for individual parties.
          title: Registration Number
        percentage:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Percentage of the share class held, as a string exactly as provided
            by the registry (e.g. "50.0").
          title: Percentage
        share_count:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: Number of shares held by the shareholder.
          title: Share Count
        total_nominal_value:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: Total nominal (face) value of the shares held by the shareholder.
          title: Total Nominal Value
        share_class:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Description of the class of shares held (e.g. "Ordinary").
          title: Share Class
        beneficially_held:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: >-
            Whether the shares are held beneficially (for the shareholder's own
            benefit) rather than on behalf of another party.
          title: Beneficially Held
      title: InternationalShareholder
      type: object
    v1.InternationalShareCapital:
      description: >-
        A class of share capital of an international business (enhanced
        profile).
      properties:
        class_code:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Registry code identifying the share class.
          title: Class Code
        class_description:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Human-readable description of the share class (e.g. "Ordinary").
          title: Class Description
        quantity:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: Number of shares issued in this class.
          title: Quantity
        unit_nominal_value:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: Nominal (face) value of a single share in this class.
          title: Unit Nominal Value
        currency:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Currency in which the share values for this class are denominated.
          title: Currency
        total_nominal_value:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: Total nominal (face) value of all shares issued in this class.
          title: Total Nominal Value
        voting_rights:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Voting rights attached to shares in this class, as described by the
            registry.
          title: Voting Rights
      title: InternationalShareCapital
      type: object
    v1.InternationalCompanyContact:
      description: Contact details for an international business (enhanced profile).
      properties:
        email:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Contact email address on file for the business.
          title: Email
        phone:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Contact telephone number on file for the business.
          title: Phone
        fax:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Fax number on file for the business.
          title: Fax
        website:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Website on file for the business.
          title: Website
      title: InternationalCompanyContact
      type: object
    v1.InternationalCompanyIdentifiers:
      description: >-
        Extra registry and tax identifiers for an international business.


        The primary registration number is the top-level ``file_number``; these
        are

        the *additional* identifiers (tax id, secondary registration number, and
        any

        other registry-specific identifiers), enriched by the enhanced profile
        add-on.
      properties:
        tax_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Tax identifier registered for the business (e.g. VAT or other
            national tax number), where the registry provides one.
          title: Tax Id
        secondary_registration_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            An additional registration number distinct from the primary file
            number, where the registry provides one.
          title: Secondary Registration Number
        other_identifiers:
          description: >-
            Any further registry-specific identifiers associated with the
            business.
          items:
            type: string
          title: Other Identifiers
          type: array
      title: InternationalCompanyIdentifiers
      type: object
    v1.InternationalBusinessActivity:
      description: >-
        A classified business activity (e.g. SIC / NACE) for an international
        business.
      properties:
        code:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Classification code for the activity (e.g. a SIC or NACE code). Null
            when the registry files the activity as a free-text declaration
            rather than a coded classification.
          title: Code
        description:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Human-readable description of the business activity.
          title: Description
      title: InternationalBusinessActivity
      type: object
    v1.InternationalRegisteredAgent:
      description: >-
        The registered agent listed for an international business (enhanced
        profile).
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Name of the registered agent listed for the business.
          title: Name
        address:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Address of the registered agent, as a single formatted address
            string.
          title: Address
      title: InternationalRegisteredAgent
      type: object
    v1.BusinessOrPersonType:
      enum:
        - Business
        - Person
      title: BusinessOrPersonType
      type: string
    v1.InternationalOfficerDirectorship:
      description: >-
        Another company at which an officer holds (or held) a role (enhanced
        profile).
      properties:
        company_name:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Name of the other company at which the officer holds or held a role.
          title: Company Name
        company_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Registration number of that other company in its home registry.
          title: Company Number
        title:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: The officer's role at that other company (e.g. "Director").
          title: Title
        is_active:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: >-
            Whether the officer's role at that other company is currently
            active.
          title: Is Active
      title: InternationalOfficerDirectorship
      type: object
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````