openapi: 3.1.0
info:
  x-metadata:
    tags:
      - Featured
  version: 1.0.1
  title: Credit and Risk
  description: >

    The Credit and Risk API provides access to a comprehensive suite of
    endpoints designed to deliver critical business insights. 

    This API enables users to authenticate, search for companies and directors,
    retrieve detailed credit and risk reports, 

    access official company filing documents, and manage fresh investigation
    requests for companies not available in the instant database.
      
    {% admonition type="info" name="OAS 3.0.4 Trial Availability" %}
      The OAS 3.0.4 version of this API specification is provided for trial purposes only. While every effort is made to ensure its accuracy, the OAS 3.1.0 version is the primary managed and maintained specification and is recommended for all integrations and production use.
    {% /admonition %}
tags:
  - name: Authentication
    description: Endpoints to authenticate and generate an Authentication Token.
  - name: Search And Report Schemas/Criteria
    description: >-
      Endpoints to retrieve the structure of the Company and Director Search
      Criteria,  Report Schemas, and available Report Languages for a specific
      country. <br><br> These endpoints provide the necessary information to
      validate responses,  understand search parameters, and determine
      localization options for reports.
  - name: Companies
    description: >-
      Endpoints to search for Companies in the Creditsafe Global Company
      Database. Companies are uniquely identified by the `connectId` - the
      identifier used to order a Company Credit Report. The Company Credit
      Report is a JSON object comprising of key business and financial data
      points such as Credit Score & Limit, Industry Code, Directors, Balance
      Sheet and Negative Information. A full list of Company data points can be
      found in the Data Matrix, in the help resources.
  - name: People/Directors
    description: >-
      Endpoints to find People/Directors and order Director Reports. A Director
      Report will contain a person's registered information and Active &
      Previous Directorships, where available. This endpoint is not advised to
      get a list of directors for a specific Company. Instead, order a Company
      Credit Report using the [Companies Report
      Endpoint](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/companies/companycreditreport), 
      and use the `directors` section in the report response.
  - name: Images
    description: |
      Endpoints to order official Company Image/Filing Documents from
      source. Company Filings such as Annual Account Statements, Annual Returns,
      Liquidations and Changes of Registered Information can be downloaded as
      PDFs, and are typically used as a resource in extended company
      auditing/compliance. <br>
  - name: Fresh Investigations
    description: >-
      Endpoints to manage Fresh Investigation requests. With the need for
      accurate data, you can check on any company that is not available within
      our instant online database by placing a Fresh Investigation (Offline
      Order). Depending on the market, the information we obtain will vary.
      Using official sources and registries we are able to quickly answer
      questions about a company's stability and financial health. Where official
      information is not available we will conduct a direct interview with the
      business.
servers:
  - url: https://connect.sandbox.creditsafe.com/v1
    description: Sandbox server
  - url: https://connect.creditsafe.com/v1
    description: Production server
paths:
  /authenticate:
    post:
      operationId: authenticate
      summary: Authenticate
      security: []
      tags:
        - Authentication
      description: |
        Supply username and password to generate Authentication Token.
          
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectAuthenticationAuthRequest'
        required: false
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectAuthenticationAuthResponse'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
  /access/countries/{countryCode}/reportLanguages:
    get:
      tags:
        - Search And Report Schemas/Criteria
      description: >
        Endpoint which returns available languages for a report.   The JSON
        structure of the report is language invariant, but field content will
        return in the selected language where available.  

        > Note: The availability of field content in a specific language depends
        on the data source. If certain properties in the report are not
        available in the chosen language, they will default to English. As a
        result, only a certain percentage of the report may appear in the
        selected language.
      summary: Return Languages Available For Company Reports For Selected Country
      operationId: userAccessReportLanguages
      parameters:
        - name: countryCode
          in: path
          example: NL
          description: Accepts valid iso-2 country code
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  reportLanguages:
                    type: array
                    items:
                      type: string
                      example: NL
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /companies/searchcriteria:
    get:
      operationId: companySearchCriteria
      summary: Company Search Criteria
      tags:
        - Search And Report Schemas/Criteria
      description: >-
        Returns the set of available Company Search parameters/fields for a
        provided list of countries.
      parameters:
        - name: countries
          required: true
          in: query
          description: >-
            A comma separated list of ISO/Alpha 2 format country codes, or
            singular country Code. e.g. US,GB will return the common searchable
            Company fields in the United States and Great Britain.
          schema:
            type: string
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountry
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /people/searchcriteria:
    get:
      tags:
        - Search And Report Schemas/Criteria
      description: >-
        Returns the set of available People Search parameters/fields for a
        provided list of countries.
      operationId: people/DirectorSearchCriteria
      summary: People/Director Search Criteria
      parameters:
        - name: countries
          in: query
          description: >-
            A comma separated list of ISO/Alpha 2 format country codes, or
            singular country Code. e.g. US,GB will return the common searchable
            People/Director fields in the United States and Great Britain.
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaSetDirector
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /companies:
    get:
      tags:
        - Companies
      description: >-
        Endpoint to search for Companies according to the provided Search
        Criteria. To get the most relevant results, it is recommended to use a
        unique identifier such as `regNo` where available. If a unique
        identifier is not available, use a combination of the companies
        registered `postCode` and `name` for the next best hit rate.
      summary: Company Search
      operationId: companySearch
      security:
        - bearerToken: []
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: countries
          in: query
          example: GB,FR
          description: >-
            comma-separated list of iso-2 country codes.<br>The code `PLC` can
            be used here to search for companies of this type across all
            countries.
          required: true
          schema:
            $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
        - name: language
          in: query
          description: >-
            Only used for Countries where more than one Company Name exists for
            different languages e.g.  Japanese Kanji and English.<br>Country - 
            Languages Available<br>Japan [JP] - EN & JA 
          schema:
            type: string
            nullable: true
            default: null
            maxLength: 2
            minLength: 2
        - name: id
          in: query
          description: >-
            connectId - The primary Company identifier that is used to uniquely
            identify all companies across Creditsafe's Universe and Partner
            Network. This is returned on all Company Search Results. Use this
            field to use in other operations such as Ordering Company Credit
            Report by Id, and Adding Company to Monitoring Portfolio.
          schema:
            type: string
            nullable: true
            default: null
        - name: safeNo
          in: query
          description: >-
            Safe Number - Identifier for Companies in Creditsafe's Home
            Countries.
          schema:
            type: string
            nullable: true
        - name: regNo
          in: query
          description: >-
            Local Company Identifier - The Company identifier associated with
            it's Domestic Filing Agency. i.e. French SIREN/SIRET, United Kingdom
            Companies House CRN.
          schema:
            type: string
            nullable: true
        - name: vatNo
          in: query
          description: Company VAT Number
          schema:
            type: string
            nullable: true
        - name: name
          in: query
          description: Company Name
          schema:
            type: string
            nullable: true
        - name: tradeName
          in: query
          description: >-
            Trade Name of the Company, typically used in Countries where Name is
            not uniquely registered.
          schema:
            type: string
            nullable: true
        - name: acronym
          in: query
          description: >-
            A (non-unique) identifier to look for Companies by their more
            commonly known acronym rather than their lesser known full name.
            Acronym is predominantly available on French Companies.
          schema:
            type: string
            nullable: true
        - name: exact
          in: query
          description: >-
            Provide as `true` to find Companies matching a Name exactly.<br>A
            list of countries this is available at <a
            href="https://help.creditsafeuk.com/en/support/solutions/articles/7000083702-company-search-exact-parameter-availability"
            target="_blank">Here</a>.
          schema:
            type: boolean
            nullable: true
        - name: address
          in: query
          schema:
            type: string
            nullable: true
        - name: street
          in: query
          description: Address part identifier - Street of the Company
          schema:
            type: string
            nullable: true
            default: null
        - name: houseNo
          in: query
          description: Address part identifier - House/Building Number of the Company
          schema:
            type: string
            nullable: true
        - name: city
          in: query
          description: Address part identifier - City of the Company
          schema:
            type: string
            nullable: true
        - name: postCode
          in: query
          description: >-
            Address part identifier - Postcode/Zip Code of the Company. Can be
            provided partially to extend to a region with a * as a wildcard.
            I.e. CF* can represent all postcodes starting with CF.
          schema:
            type: string
            nullable: true
        - name: province
          in: query
          description: Address part identifier - Province/State of the Company
          schema:
            type: string
            nullable: true
        - name: callRef
          in: query
          description: >-
            This parameter allows users to assign a unique identifier to their
            API queries. By using a callRef, it facilitates easier tracking and
            logging within Connect. If you provide a callRef, the Connect team
            can later retrieve and identify the specific requests associated
            with that identifier, enabling detailed tracing of interactions.
          schema:
            type: string
            nullable: true
            default: null
        - name: officeType
          in: query
          schema:
            $ref: '#/components/schemas/CreditsafeGlobalDataOfficeType'
            nullable: true
        - name: phoneNo
          in: query
          description: Provides Array of phone numbers or Null
          schema:
            type: array
            items:
              type: string
            nullable: true
        - name: status
          in: query
          schema:
            $ref: '#/components/schemas/CreditsafeGlobalDataCompanyStatus'
            nullable: true
        - name: type
          in: query
          schema:
            $ref: '#/components/schemas/CreditsafeGlobalDataCompanyType'
          allowEmptyValue: true
        - name: website
          in: query
          schema:
            type: string
            nullable: true
        - name: customData
          in: query
          description: Not currently used.
          schema:
            type: string
            nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCompanySearchResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /companies/schema/{countryCode}:
    get:
      operationId: reportSchema
      summary: Report Schema Structure Per Country
      tags:
        - Search And Report Schemas/Criteria
      description: >-
        Returns the Company Report JSON schema of the provided country. Largely
        redundant as the Company Report 200 response is defined as a superset of
        all country's JSON schemas and can be used for any country.
      parameters:
        - name: section
          required: true
          in: query
          description: >-
            Use `CompanyReportResponse` for the Company Credit Report JSON
            schema. 
          schema:
            type: string
            enum:
              - CompanyReportResponse
        - name: template
          in: query
          description: |
            For Templated Company Report JSON Schemas.
            Selection of templates can be found here: 
              <a href="https://help.creditsafeuk.com/en/support/solutions/articles/7000063360-connect-report-templates-glossary-availability"
              target="_blank"> Templates</a>
          schema:
            type: string
        - name: countryCode
          in: path
          description: ISO2 / Alpha 2 Country Code
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
  /companies/{connectId}:
    get:
      operationId: companyCreditReport
      summary: Company Credit Report
      tags:
        - Companies
      description: >-
        Orders a Company Credit Report by connectId.<br><br> To acquire a PDF
        version of the report use the optional request in 'Header'.<br><br> This
        request will provide a 'Base64-encoded' script to convert to a PDF, this
        will appear at the end of the JSON response.<br><br>

        The response properties listed for this endpoint represent the core
        global company fields.  For country-specific fields and a complete list
        of all possible properties for a given country,  use the [Report Schema
        endpoint](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/search-and-report-schemascriteria/reportschema). 
        Not all properties will be returned in every response—fields with no
        value are omitted by design. <br><br> In OpenAPI, properties not listed
        as `required` are optional.


        Refer to the [Companies help
        documentation](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/documentation/companies/companies).
      security:
        - bearerToken: []
      parameters:
        - name: Accept
          in: header
          required: false
          description: Specifies the desired response format.
          schema:
            oneOf:
              - type: string
                title: PDF
                enum:
                  - application/pdf
              - type: string
                title: HTML
                enum:
                  - application/html
              - type: string
                title: PDF + HTML
                enum:
                  - application/pdf+html
              - type: string
                title: JSON + PDF
                enum:
                  - application/json+pdf
              - type: string
                title: JSON + HTML
                enum:
                  - application/json+html
            example: application/pdf
        - name: language
          in: query
          description: >-
            Report Language - The JSON structure of the Report is language
            invariant, but field content will return as the given language,
            where available.
          schema:
            pattern: ^[a-zA-Z]{2}$
            type: string
            default: en
            nullable: true
        - name: template
          in: query
          description: >-
            Optional parameter to request a Templated Company Report. A Template
            adds/reduces sections of the Credit Report depending on your
            subscription. Do not include this parameter if you have not been
            given a template to use.<br> <a
            href="https://help.creditsafeuk.com/en/support/solutions/articles/7000063360-connect-report-templates-glossary-availability"
            target="_blank"> Connect Report Templates </a>
          schema:
            type: string
            default: full
            nullable: true
        - name: includeIndicators
          in: query
          description: >-
            Optional parameter to include the indicator scores in to a company
            report -`fsi = Financial Strength` , `pbi = Payment Behaviour
            Indicator`, `eti = Estimated Turnover`, `pei = Payment Expectation
            Indicator`<br><br> Addition information on indicator acronyms can be
            found <a
            href="https://help.creditsafeuk.com/en/support/solutions/articles/7000084411-connect-report-indicator-definitions"
            target="_blank">HERE.</a><br><br> Addition information on
            understanding indicators can be found <a
            href="https://help.creditsafeuk.com/en/support/solutions/articles/7000078780-what-are-indicators-in-the-scores-and-indicators-tab-"
            target="_blank">HERE.</a>
          schema:
            type: boolean
            default: false
        - name: customData
          in: query
          description: >-
            Additional Report Parameters e.g.  German Report Reason Code value
            is `de_reason_code::1` . Use /reportcustomdata/{country} endpoint to
            see all values.
          schema:
            type: string
            nullable: true
        - name: callRef
          in: query
          description: >-
            This parameter allows users to assign a unique identifier to their
            API queries. By using a callRef, it facilitates easier tracking and
            logging within Connect. If you provide a callRef, the Connect team
            can later retrieve and identify the specific requests associated
            with that identifier, enabling detailed tracing of interactions.
          schema:
            type: string
            default: null
            nullable: true
          required: false
        - name: connectId
          in: path
          description: >-
            The connectId (optionally Safe Number where available) of the
            Company required to order their Credit Report. Obtained from
            `/companies` search results.
          required: true
          example: GB-0-03836192
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse
            application/json+pdf:
              schema:
                $ref: >-
                  #/components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachmentjson
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /companies/match:
    get:
      tags:
        - Companies
      description: >-
        Supply all company search criteria to find potential company matches
        ranked by a `single score`.   - <a
        href="https://creditsafe.freshdesk.com/en/support/solutions/articles/7000059769-interpreting-confidence-match-scores"
        target="_blank">See here for more information</a>.
      operationId: confidenceMatchSearch
      summary: Confidence Match Search
      parameters:
        - name: country
          in: query
          example: GB
          description: Iso-2 country code
          required: true
          schema:
            type: string
        - name: matchThreshold
          in: query
          example: 905
          required: true
          description: Minimum threshold value `893`, maximum threshold value `999`.
          schema:
            type: integer
        - name: regNo
          in: query
          description: >-
            Local Company Identifier - The Company identifier associated with
            it's Domestic Filing Agency. i.e. French SIREN/SIRET, United Kingdom
            Companies House CRN.
          schema:
            type: string
            nullable: true
        - name: vatNo
          in: query
          description: Company VAT Number
          schema:
            type: string
            nullable: true
        - name: name
          in: query
          required: true
          description: Company Name
          schema:
            type: string
            nullable: true
        - name: street
          in: query
          description: Address part identifier - Street of the Company
          schema:
            type: string
            nullable: true
            default: null
        - name: houseNo
          in: query
          description: Address part identifier - House/Building Number of the Company
          schema:
            type: string
            nullable: true
        - name: city
          in: query
          description: Address part identifier - City of the Company
          schema:
            type: string
            nullable: true
        - name: postCode
          in: query
          description: Address part identifier - Postcode/Zip Code of the Company.
          schema:
            type: string
            nullable: true
        - name: province
          in: query
          description: Address part identifier - Province of the Company
          schema:
            type: string
            nullable: true
        - name: phoneNo
          in: query
          schema:
            type: string
            nullable: true
        - name: reference1
          in: query
          description: Customer supplied free text reference 1 of 3
          example: free text 1
          schema:
            type: string
        - name: reference2
          in: query
          description: Customer supplied free text reference 2 of 3
          example: free text 2
          schema:
            type: string
        - name: reference3
          in: query
          description: Customer supplied free text reference 3 of 3
          example: free text 3
          schema:
            type: string
        - name: callRef
          in: query
          description: >-
            This parameter allows users to assign a unique identifier to their
            API queries. By using a callRef, it facilitates easier tracking and
            logging within Connect. If you provide a callRef, the Connect team
            can later retrieve and identify the specific requests associated
            with that identifier, enabling detailed tracing of interactions.
          schema:
            type: string
            nullable: true
            default: null
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ConnectConfidenceMatchMatchResults'
                  - $ref: '#/components/schemas/ConnectConfidenceMatchNoResults'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /people:
    get:
      tags:
        - People/Directors
      description: >-
        Endpoint to find Directors based on search criteria to order a
        Creditsafe Director Report.
      operationId: directorSSearch
      summary: Director Search
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: countries
          in: query
          example: GB,FR
          description: comma-separated list of iso-2 country codes
          required: true
          schema:
            type: object
            items:
              $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
        - name: peopleId
          in: query
          description: Person/Director Identifier - used to order a Director Report.
          schema:
            type: string
        - name: firstName
          in: query
          description: Person's First Name.
          schema:
            type: string
        - name: lastName
          in: query
          description: Person's Last Name
          schema:
            type: string
        - name: localDirectorNumber
          in: query
          description: Local Identifier of the Director, the PNR in GB.
          schema:
            type: string
            nullable: true
        - name: dateOfBirth
          in: query
          description: Person DOB - provide YYYY-MM-DD or YYYY-MM format.
          schema:
            type: string
        - name: callRef
          in: query
          description: >-
            This parameter allows users to assign a unique identifier to their
            API queries. By using a callRef, it facilitates easier tracking and
            logging within Connect. If you provide a callRef, the Connect team
            can later retrieve and identify the specific requests associated
            with that identifier, enabling detailed tracing of interactions.
          schema:
            type: string
            nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: >-
                      #/components/schemas/CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataDirectorSearchData
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /people/{peopleId}:
    get:
      tags:
        - People/Directors
      operationId: directorReport
      summary: Director Report
      description: Returns a report from the ID supplied to the search.
      parameters:
        - name: language
          in: query
          description: >-
            Report Language - The JSON structure of the Report is language
            invariant, but field content will return as the given language,
            where available.
          schema:
            pattern: ^[a-zA-Z]{2}$
            type: string
            default: en
        - name: callRef
          in: query
          description: >-
            This parameter allows users to assign a unique identifier to their
            API queries. By using a callRef, it facilitates easier tracking and
            logging within Connect. If you provide a callRef, the Connect team
            can later retrieve and identify the specific requests associated
            with that identifier, enabling detailed tracing of interactions.
          schema:
            type: string
        - name: peopleId
          in: path
          description: >-
            Identifier of the Person/Director required to order their Director
            Report. Obtained from `/people` search results.
          required: true
          schema:
            pattern: ^[a-zA-Z]{2}([0-9]{1,3})?[-]{1}[a-zA-Z0-9$]+$
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReportResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /images/companies:
    get:
      tags:
        - Images
      description: Returns the available Images for a given Company connectId.
      operationId: companyImageDocuments
      summary: Company Image Documents
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: id
          in: query
          description: The company's connectId.
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectImagesCompanyImages'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /images/companies/types:
    get:
      tags:
        - Images
      description: Lists available Image Document formats, types and languages per country.
      operationId: imageDocumentCategoryTypes
      summary: Image Document Category Types
      parameters:
        - name: countries
          in: query
          description: Filter Images by country.
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectImagesCompanyImageTypes'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /images/{imageId}:
    get:
      tags:
        - Images
      description: Endpoint to order an Image Document by Image ID.
      operationId: companyImage
      summary: Company Image
      parameters:
        - name: imageId
          in: path
          description: Image ID retrieved from `images/companies`
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Image object as a binary stream.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachment
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /freshinvestigations:
    post:
      operationId: createFreshInvestigation
      summary: Create Fresh Investigation
      tags:
        - Fresh Investigations
      description: >-
        Places an order for a Fresh Investigation (Offline Report). Providing as
        much detail as possible about the Company, our team will use official
        sources and registries to quickly answer questions about a company's
        stability and financial health. Fresh Investigations take 5.5 days on
        average to complete. By adding `consent:true` to the request, you are
        allowing Creditsafe to disclose your company details to the company you
        have requested the Investigation against, to be used only in the aim of
        improving our Investigation report.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectFreshInvCreateInvestigation'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectFreshInvInvestigationConfirmed'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    get:
      operationId: getFreshInvestigations
      summary: Get Fresh Investigations
      tags:
        - Fresh Investigations
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: transactionId
          in: query
          description: >-
            Fresh Investigation Identifier used internally and with our data
            partners.
          schema:
            type: string
        - name: reportCreatedAfter
          in: query
          schema:
            type: string
          description: Returns Fresh Investigations processed after this date
          example: '2020-01-01T11:23:56Z'
        - name: reportCreatedBefore
          in: query
          schema:
            type: string
          description: >-
            Returns ordered Fresh Investigations that were processed before this
            date
          example: '2020-01-01T11:23:56Z'
        - name: createdBefore
          in: query
          schema:
            type: string
          description: Returns Fresh Investigations created before this date
        - name: createdSince
          in: query
          schema:
            type: string
          description: Returns ordered Fresh Investigations created after this date
        - name: lookUpOrderBy
          description: >-
            Use to search for your Fresh Investigations by either the returned
            Company Details in the `GET` `freshInvestigations/{orderId}`
            endpoint or your supplied Search Criteria in the `POST`
            `/freshInvestigations` endpoint
          in: query
          schema:
            type: string
            enum:
              - CompanyDetails
              - SearchCriteria
        - name: companyDetailsCountry
          in: query
          description: >-
            Looks for your returned Fresh Investigations where the returned
            Company Country is named this. Use with lookUpOrderBy=CompanyDetails
          schema:
            type: string
        - name: companyDetailsName
          in: query
          description: >-
            Looks for your returned Fresh Investigations where the returned
            Company Name is named this. Use with lookUpOrderBy=CompanyDetails
          schema:
            type: string
        - name: searchCriteriaCountry
          in: query
          description: >-
            Looks for your returned Fresh Investigations where your submitted
            Search Criteria Company Country is this. Use with
            lookUpOrderBy=searchCriteria
          schema:
            type: string
        - name: searchCriteriaName
          in: query
          description: >-
            Looks for your Fresh Investigations where your submitted Search
            Criteria Company Name is this. Use with lookUpOrderBy=searchCriteria
          schema:
            type: string
        - name: sortBy
          in: query
          description: Sorts  returned Fresh Investigations by this field
          schema:
            type: string
            enum:
              - creationDate
              - lastStatusChangeDate
              - orderID
              - status
        - $ref: '#/components/parameters/sortDir'
      description: Returns a list of your submitted Fresh Investigation Orders.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectFreshInvListInvestigations'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /freshinvestigations/{orderId}:
    get:
      operationId: retrieveFreshInvestigationOrder
      summary: Retrieve FreshInvestigation Order
      tags:
        - Fresh Investigations
      description: Returns a specific Fresh Investigation order.
      parameters:
        - name: orderId
          in: path
          required: true
          schema:
            type: string
        - name: sections
          in: query
          description: >-
            Specify a value to return a single section, or multiple-comma
            separated sections of the completed Fresh Investigation. Leave null
            to return all sections. Available sections; -
            `companyIdentification` - `creditScore` - `contactInformation` -
            `directors` - `otherInformation` - `groupStructure` -
            `extendedGroupStructure` - `financialStatements` -
            `negativeInformation` - `additionalInformation`- `directorships` -
            `localFinancialStatements` - `paymentData` - `companySummary` -
            `alternateSummary`
          schema:
            type: string
          example: companyIdentification,creditScore
        - name: comments
          in: query
          description: >-
            Selects number of comments which should be returned with the order
            details.
          schema:
            type: string
            enum:
              - last
              - recent
              - none
            default: last
      responses:
        '200':
          description: >-
            Returns a specific Fresh Investigation Order. For completed orders
            this will contain the Investigation content as Report Sections.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectFreshInvCompletedInvestigation'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    delete:
      operationId: deleteFreshInvestigations
      summary: Delete Fresh Investigations
      tags:
        - Fresh Investigations
      description: Deletes specified investigations.
      parameters:
        - name: orderId
          in: path
          required: true
          description: Investigation id.
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteFreshInvetigationsByOrderId'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    patch:
      operationId: updateFreshInvestigationReportContent
      summary: Update FreshInvestigation Report Content
      tags:
        - Fresh Investigations
      description: >-
        Update the Fresh Investigation Report data for a specific order, after
        the order has a status of delivered.
      parameters:
        - name: orderId
          description: Fresh investigation orderId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectUpdateFreshInvestigation'
      responses:
        '200':
          description: Investigation Report.
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    description: Success response of updated fresh investigation.
                    example: FreshInvestigation OrderId is being updated
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /freshinvestigations/{orderId}/attachments:
    post:
      operationId: uploadAttachmentsForFreshInvestigationOrderId
      summary: Upload attachments for fresh investigation orderId
      tags:
        - Fresh Investigations
      description: Returns the status of attachment upload for the particular order.
      parameters:
        - name: orderId
          description: Fresh investigation orderId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: >-
                #/components/schemas/FreshInvestigationAttachmentUploadForOrderRequest
            example:
              file: FILE_PATH
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/FreshInvestigationAttachmentUploadForOrderResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    get:
      operationId: getAttachmentsForTheGivenFreshInvestigationOrderId
      summary: Get attachments for the given fresh investigation orderId
      tags:
        - Fresh Investigations
      description: Returns attachments available for that particular order.
      parameters:
        - name: orderId
          description: fresh investigation orderId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/FreshInvestigationGetAttachmentsForOrderResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /freshinvestigations/{orderId}/attachments/{id}:
    get:
      operationId: getAttachmentForTheGivenFreshInvestigationAttachmentId
      summary: Get attachment for the given fresh investigation attachment Id
      tags:
        - Fresh Investigations
      description: Retrieve attachment for the given attachmentId.
      parameters:
        - name: orderId
          description: fresh investigation orderId
          in: path
          required: true
          schema:
            type: string
        - name: id
          description: fresh investigation attachment id for the given order
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Attachment as a binary stream.
          content:
            application/*:
              schema:
                $ref: >-
                  #/components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment
            text/*:
              schema:
                $ref: >-
                  #/components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment
            image/*:
              schema:
                $ref: >-
                  #/components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /freshinvestigations/{orderId}/comments:
    post:
      operationId: commentsForFreshInvestigationOrderId
      summary: Comments for fresh investigation orderId
      tags:
        - Fresh Investigations
      description: Returns the status of comments for the particular order.
      parameters:
        - name: orderId
          description: fresh investigation orderId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FreshInvestigationCommentsForOrderRequest'
            example:
              comments: comments by user
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/FreshInvestigationCommentsForOrderResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    get:
      operationId: retrieveCommentsOfSpecifiedFreshInvestigationReport
      summary: Retrieve comments of specified FreshInvestigation Report
      tags:
        - Fresh Investigations
      description: Returns the Fresh Investigation Report comments for a specific order.
      parameters:
        - name: orderId
          in: path
          required: true
          description: FreshInvestigation Report Id
          schema:
            type: string
      responses:
        '200':
          description: Investigation Report.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetFreshInvestigationCommentsByOrderIdResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /freshinvestigations/{orderId}/report:
    get:
      operationId: retrieveFreshInvestigationReportContent
      summary: Retrieve FreshInvestigation Report Content
      tags:
        - Fresh Investigations
      description: >-
        Returns the Fresh Investigation Report data for a specific order, after
        the order has a status of delivered.
      parameters:
        - name: orderId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Investigation Report.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
components:
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        This API requires authentication for access to protected endpoints.
        Authentication is performed by providing a valid JWT token in the
        `Authorization` header of each request.
  schemas:
    ConnectAuthenticationAuthRequest:
      type: object
      properties:
        username:
          type: string
          description: Credentials assigned upon sign up
          example: username@domain.com
        password:
          type: string
          example: ^1gHySRA56aj>tf421o
    ConnectAuthenticationAuthResponse:
      type: object
      properties:
        token:
          type: string
          description: Authentication Token
          example: >-
            eyJhbGciOiJSUzI1NiIsImtpZCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyIsInR5cCI6IkpXVCIsIng1dCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyJ9.eyJuYmYiOjE1OTU0MTYyMDksImV4cCI6MTU5NTQxOTgwOSwiaXNzIjoiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20iLCJhdWQiOlsiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20vcmVzb3VyY2VzIiwiY29ubmVjdF9hcGkiLCJ1Ym9fYXBpX2dhdGV3YXkiXSwiY2xpZW50X2lkIjoiY29ubmVjdC5hcGkuY2xpZW50Iiwic3ViIjoiMTAxNTIwMjg1IiwiYXV0aF90aW1lIjoxNTk1NDE2MjA5LCJpZHAiOiJsb2NhbCIsInVzZXJuYW1lIjoiQ29ubmVjdHUxIiwiZW1haWwiOiJDb25uZWN0MUBnbWFpbC5jb20iLCJjdXN0b21lcklkIjoiMTAxNzY0NDA1IiwiY291bnRyeSI6IkMwIiwidXNlclJvbGUiOiJDcm1BZG1pblBsdXMiLCJzYl9jb3VudHJ5IjoiVVMiLCJzY29wZSI6WyJjb25uZWN0X2FwaSIsInVib19hcGlfZ2F0ZXdheSJdLCJhbXIiOlsicHdkIl19.p8kPAlKNB9iWEKiQbfbRXBoLQuBG7NuEDN__A8AQ55CL-gcIwkS1717Af1f9W0uifwIQ6HAZQR_x191LVkvuWD94Zw8zLzzr1ioUIhQny_zYuAS3G6EFNaTHh_mvOQ9XVi1FyuIy6YYcYcNLNZurFuITF2w5LuX4YQBjQy3rhEAdRoKcUKbtCClMFaH2dV35jiX2d7BqyhtJ8GeZyJ6yfMfdzznqxlJ4Osf5aasKUy8RYKEpjU2pkCURojoy5_oviGs8X4U9mJWcuajmPF3i5DHkqbhq1Mp0UZrDyoq_0BDStV5xqRgq6aOY8mc45kX7cwY3O2hPeGE7Ak8YtKFbA
    ConnectErrorResponsesInvalidToken:
      type: object
      properties:
        error:
          type: string
      description: >-
        401 - Authorization Token has either expired or is not a valid Connect
        Token
    ConnectErrorResponsesBadRequest:
      type: object
      description: Bad Request
      properties:
        correlationId:
          type: string
          description: A unique ID assigned to this request.
        message:
          type: string
        details:
          type: string
          description: Provides further information on why the request was rejected
    ConnectErrorResponsesAccessForbidden:
      type: object
      description: 403 - Access Forbidden
      properties:
        message:
          type: string
          example: Access forbidden
    ConnectErrorResponsesResourceNotFoundRequest:
      type: object
      description: 404 - Not Found
      properties:
        correlationId:
          type: string
          description: A unique ID assigned to this request.
          format: uuid
        message:
          type: string
        details:
          type: string
          description: Provides further information on why the request was rejected
    CreditsafeGlobalDataCountryCode:
      description: Country where the company is registered.
      enum:
        - AF
        - AX
        - AL
        - DZ
        - AS
        - AD
        - AO
        - AI
        - AQ
        - AG
        - AR
        - AM
        - AW
        - AU
        - AT
        - AZ
        - BS
        - BH
        - BD
        - BB
        - BY
        - BE
        - BZ
        - BJ
        - BM
        - BT
        - BO
        - BA
        - BW
        - BV
        - BR
        - IO
        - BN
        - BG
        - BF
        - BI
        - KH
        - CM
        - CA
        - CV
        - KY
        - CF
        - TD
        - CL
        - CN
        - CX
        - CC
        - CO
        - KM
        - CG
        - CD
        - CK
        - CR
        - CI
        - HR
        - CU
        - CY
        - CZ
        - DK
        - DJ
        - DM
        - DO
        - EC
        - EG
        - SV
        - GQ
        - ER
        - EE
        - ET
        - FK
        - FO
        - FJ
        - FI
        - FR
        - GF
        - PF
        - TF
        - GA
        - GM
        - GE
        - DE
        - GH
        - GI
        - GR
        - GL
        - GD
        - GP
        - GU
        - GT
        - GG
        - GN
        - GW
        - GY
        - HT
        - HM
        - HN
        - HK
        - HU
        - IS
        - IN
        - ID
        - IR
        - IQ
        - IE
        - IM
        - IT
        - JM
        - JP
        - JE
        - JO
        - KZ
        - KE
        - KI
        - KP
        - KR
        - KW
        - KG
        - LA
        - LV
        - LB
        - LS
        - LR
        - LY
        - LI
        - LT
        - LU
        - MO
        - MK
        - MG
        - MW
        - MY
        - MV
        - ML
        - MT
        - MH
        - MQ
        - MR
        - MU
        - YT
        - MX
        - FM
        - MD
        - ME
        - MS
        - MA
        - MZ
        - MM
        - NA
        - NR
        - NP
        - NL
        - AN
        - NC
        - NZ
        - NI
        - NE
        - NG
        - NU
        - NF
        - MP
        - 'NO'
        - OM
        - PK
        - PW
        - PS
        - PA
        - PG
        - PY
        - PE
        - PH
        - PN
        - PL
        - PT
        - PR
        - QA
        - RE
        - RO
        - RU
        - RW
        - BL
        - SH
        - KN
        - LC
        - MF
        - PM
        - VC
        - WS
        - ST
        - SA
        - SN
        - RS
        - SC
        - SL
        - SG
        - SK
        - SI
        - SB
        - SO
        - ZA
        - GS
        - ES
        - LK
        - SD
        - SR
        - SJ
        - SZ
        - SE
        - CH
        - SY
        - TW
        - TJ
        - TZ
        - TH
        - TL
        - TG
        - TK
        - TO
        - TT
        - TN
        - TR
        - TM
        - TC
        - TV
        - UG
        - UA
        - AE
        - GB
        - US
        - UM
        - UY
        - UZ
        - VU
        - VA
        - VE
        - VN
        - VG
        - VI
        - WF
        - EH
        - YE
        - ZM
        - ZW
        - XK
        - SS
        - SX
        - CW
        - BQ
        - WW
        - PLC
      type: string
    CreditsafeGlobalDataSearchCriteriaSchemaBase:
      type: object
    CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString:
      type: object
      properties:
        required:
          type: boolean
        minLength:
          type: integer
          format: int32
          nullable: true
        maxLength:
          type: integer
          format: int32
          nullable: true
        allowedValues:
          type: array
          items:
            type: string
        validationRegExp:
          type: string
    CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema:
      allOf:
        - $ref: >-
            #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString
    CreditsafeGlobalDataCompanyType:
      description: '`NonLtdNonReg` is only available for countries in Norway.'
      enum:
        - NotSet
        - Ltd
        - NonLtd
        - NonLtdNonReg
      type: string
    CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyType:
      type: object
      properties:
        optional:
          type: boolean
        minLength:
          type: integer
          format: int32
          nullable: true
        maxLength:
          type: integer
          format: int32
          nullable: true
        allowedValues:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataCompanyType'
        validationRegExp:
          type: string
    CreditsafeGlobalDataOfficeType:
      enum:
        - Registered
        - Trading
        - HeadOffice
        - Branch
        - Subsidiary
        - Franchise
        - Franchisor
        - SingleOffice
        - Other
      type: string
    CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataOfficeType:
      type: object
      properties:
        optional:
          type: boolean
        minLength:
          type: integer
          format: int32
          nullable: true
        maxLength:
          type: integer
          format: int32
          nullable: true
        allowedValues:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataOfficeType'
        validationRegExp:
          type: string
    CreditsafeGlobalDataCompanyStatus:
      description: >-
        High-level status. Values include "Active", "NonActive", "Pending" and
        "Other". Note - “Pending” indicates that the entity has entered into a
        legal process such as insolvency or liquidation, and “Other” indicates
        an unknown status.
      enum:
        - Active
        - NonActive
        - Pending
        - Other
      type: string
    CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyStatus:
      type: object
      properties:
        optional:
          type: boolean
        minLength:
          type: integer
          format: int32
          nullable: true
        maxLength:
          type: integer
          format: int32
          nullable: true
        allowedValues:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataCompanyStatus'
        validationRegExp:
          type: string
    CreditsafeGlobalDataAddressCriteriaSchema:
      type: object
      properties:
        simpleValue:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema
        street:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString
        houseNo:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString
        city:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString
        postCode:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString
        province:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString
    CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemBoolean:
      type: object
      properties:
        optional:
          type: boolean
        minLength:
          type: integer
          format: int32
          nullable: true
        maxLength:
          type: integer
          format: int32
          nullable: true
        allowedValues:
          type: array
          items:
            type: boolean
        validationRegExp:
          type: string
    CreditsafeGlobalDataSearchCriteriaSchema:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaBase'
        - type: object
          properties:
            id:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString
            safeNo:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString
            regNo:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString
            vatNo:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString
            name:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema
            type:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyType
            officeType:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataOfficeType
            status:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyStatus
            address:
              $ref: '#/components/schemas/CreditsafeGlobalDataAddressCriteriaSchema'
            phoneNumber:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString
            website:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString
            includeTradingNames:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemBoolean
            includeTradingAddresses:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemBoolean
    CreditsafeGlobalDataSearchCriteriaSchemaCountry:
      type: object
      properties:
        correlationId:
          type: string
          description: A unique ID assigned to this request.
        countries:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
        languages:
          type: array
          description: >-
            Available languages to perform a company search in the country
            queried
          items:
            type: string
        criteriaSets:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema'
    CreditsafeGlobalDataMessageType:
      enum:
        - Information
        - Warning
        - Error
      type: string
    CreditsafeGlobalDataMessageCode:
      enum:
        - NoResults
        - TooManyResults
        - ReportUnavailable
        - ReportUnavailableDueToLegal
        - ReportUnavailableOnline
        - LegalNotice
        - InvalidCredentials
        - AccessRestricted
        - AccessLimitsNearing
        - InsufficientCustomerData
        - ReportboxAlmostFull
        - ReportboxFull
        - InvalidRequestXml
        - InvalidOperationParameters
        - OperationNotSupported
        - InvalidCustomData
        - ChangeNotification
        - TemporarySystemProblem
        - EndpointShutdown
        - UnexpectedInternalError
        - Other
        - DataServiceAccessProblems
        - DataServiceInvalidResponse
      type: string
    CreditsafeGlobalDataMessage:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CreditsafeGlobalDataMessageType'
        code:
          $ref: '#/components/schemas/CreditsafeGlobalDataMessageCode'
        text:
          type: string
    CreditsafeGlobalDataServiceResponse:
      type: object
      properties:
        messages:
          description: Provides information about the request and the response.
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataMessage'
    CreditsafeGlobalDataSearchCriteriaSchemaDirector:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaBase'
        - type: object
          properties:
            id:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString
            firstName:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema
            lastName:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema
            companyId:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString
            companyName:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema
            companyType:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyType
            companyRegistrationNumber:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString
            address:
              $ref: '#/components/schemas/CreditsafeGlobalDataAddressCriteriaSchema'
            status:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString
    CreditsafeGlobalDataSearchCriteriaSchemaCountryDirector:
      type: object
      properties:
        country:
          $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
        schemas:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaDirector
    CreditsafeGlobalDataCustomDataEntrySchema:
      type: object
      properties:
        key:
          type: string
        optional:
          type: boolean
        allowedValues:
          type: array
          items:
            type: string
        description:
          type: string
    CreditsafeGlobalDataSearchCriteriaSchemaSetDirector:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataServiceResponse'
        - type: object
          properties:
            countriesCriteria:
              description: >-
                The list of available parameters for the search in the given
                country.
              type: array
              items:
                $ref: >-
                  #/components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountryDirector
            customData:
              type: array
              items:
                $ref: '#/components/schemas/CreditsafeGlobalDataCustomDataEntrySchema'
    CreditsafeGlobalDataReportsIdType:
      description: >-
        Description for the ID, to describe the type of ID presented e.g. Person
        number, Tax ID (if a company), Company Registration Number etc.
      enum:
        - Other
        - SafeNumber
        - RegistrationNumber
        - VATNumber
        - TaxID
        - PersonNumber
        - ExternalID
        - InternalID
      type: string
    CreditsafeGlobalDataAdditionalInformation:
      type: object
      properties:
        isPLC:
          type: string
        coefficientLinear:
          type: number
    CreditsafeGlobalDataSearchAddressData:
      type: object
      properties:
        type:
          type: string
          description: >-
            Address type description. Examples-  "Registered Office", "Trading
            Address", "Postal Address", "Service Address" etc.
        simpleValue:
          type: string
          description: >-
            (Optionally populated) Registered address of the company. Whole
            string address if Creditsafe is unable to accurately assign values
            to specific address fields, or when specific local address formats
            need to be observed.
        street:
          type: string
          description: >-
            Street portion of the address line. Can also, optionally contain,
            the house number alongside the street.
        houseNo:
          type: string
          description: House number portion of the address line.
        city:
          type: string
          description: City portion of the address line.
        postCode:
          type: string
          description: Postal code portion of the address line.
        province:
          type: string
          description: Province portion of the address line.
        telephone:
          type: string
          description: Registered telephone number.
        directMarketingOptOut:
          type: boolean
          nullable: true
          description: >-
            Boolean [true/false]. Where set to true, the subject has "opted out"
            via a central register, and they must not be contacted for
            commercial marketing purposes.
        directMarketingOptIn:
          type: boolean
          nullable: true
        country:
          $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
    CreditsafeGlobalDataCompanyActivityClassification:
      type: object
      description: >-
        Main activity classification being used for the company’s main activity,
        including the code, industry sector, and description.
      properties:
        code:
          type: string
          description: Main activity code used in that country e.g. SIC / NACE.
        industrySector:
          type: string
          description: >-
            (Optionally populated) A high-level description, describing the
            industry sector/division in which the company operates.
        description:
          type: string
          description: Description of main activity.
        classification:
          type: string
          description: >-
            The type of activity classification being used for the main
            activity. E.g SIC07, NACE Rev2 etc. Where possible includes the
            version/revision date.
    CreditsafeGlobalDataReportsAdditionalData:
      type: object
      description: A free-flowing section, containing country specific elements.
    CreditsafeGlobalDataCompanyDataAdditionalData:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsAdditionalData'
        - type: object
    CreditsafeGlobalDataCompanyData:
      type: object
      properties:
        id:
          type: string
          description: Connect Id.
        country:
          $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
        regNo:
          type: string
          description: Official registration number.
        safeNo:
          type: string
          description: Creditsafe global identifier, called the Safe Number.
        idType:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsIdType'
        name:
          type: string
          description: Full company name of Ultimate Holding Company.
        type:
          $ref: '#/components/schemas/CreditsafeGlobalDataCompanyType'
        officeType:
          $ref: '#/components/schemas/CreditsafeGlobalDataOfficeType'
        status:
          $ref: '#/components/schemas/CreditsafeGlobalDataCompanyStatus'
        vatNo:
          description: Local VAT Number.
          oneOf:
            - type: string
              nullable: true
            - type: array
              items:
                type: string
                nullable: true
        additionalInformation:
          $ref: '#/components/schemas/CreditsafeGlobalDataAdditionalInformation'
        address:
          $ref: '#/components/schemas/CreditsafeGlobalDataSearchAddressData'
        activity:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataCompanyActivityClassification
        legalForm:
          type: string
        additionalData:
          $ref: '#/components/schemas/CreditsafeGlobalDataCompanyDataAdditionalData'
    CreditsafeGlobalDataCompany:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataCompanyData'
        - type: object
          properties:
            dateOfLatestAccounts:
              type: string
              format: date-time
              nullable: true
            dateOfLatestChange:
              type: string
              format: date-time
              nullable: true
            phoneNumbers:
              type: array
              items:
                type: string
            activityCode:
              type: string
              nullable: true
    CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataCompany:
      allOf:
        - type: object
          properties:
            correlationId:
              type: string
              description: A unique ID assigned to this request.
            messages:
              type: array
              items:
                $ref: '#/components/schemas/CreditsafeGlobalDataMessage'
            totalSize:
              type: integer
              format: int32
            companies:
              type: array
              items:
                $ref: '#/components/schemas/CreditsafeGlobalDataCompany'
    ConnectCompanySearchNoResults:
      type: object
      properties:
        totalSize:
          type: number
        companies:
          type: object
        messages:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataMessage'
    ConnectCompanySearchResponse:
      oneOf:
        - $ref: >-
            #/components/schemas/CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataCompany
        - $ref: '#/components/schemas/ConnectCompanySearchNoResults'
    CreditsafeGlobalDataReportsReportSection:
      enum:
        - CompanySummary
        - CompanySummaryExtra
        - AlternateSummary
        - CompanyIdentification
        - CompanyIdentificationExtra
        - CreditScore
        - CreditScoreExtra
        - ContactInformation
        - ContactInformationExtra
        - ShareCapitalStructure
        - ShareCapitalStructureExtra
        - Directors
        - DirectorsExtra
        - Directorships
        - DirectorshipsExtra
        - OtherInformation
        - OtherInformationExtra
        - GroupStructure
        - GroupStructureExtra
        - ExtendedGroupStructure
        - ExtendedGroupStructureExtra
        - GlobalFinancialStatements
        - GlobalFinancialStatementsExtra
        - LocalFinancialStatements
        - LocalFinancialStatementsExtra
        - PaymentData
        - PaymentDataExtra
        - NegativeInformation
        - NegativeInformationExtra
        - AdditionalInformation
        - AdditionalInformationExtra
        - UPPData
        - Unused
      type: string
    CreditsafeGlobalDataLanguage:
      enum:
        - OM
        - AB
        - AA
        - AF
        - SQ
        - AM
        - AR
        - HY
        - AS
        - AY
        - AZ
        - BA
        - EU
        - BN
        - DZ
        - BH
        - BI
        - BR
        - BG
        - MY
        - BE
        - KM
        - CA
        - ZH
        - CO
        - HR
        - CS
        - DA
        - NL
        - EN
        - EO
        - ET
        - FO
        - FJ
        - FI
        - FR
        - FY
        - GL
        - KA
        - DE
        - EL
        - KL
        - GN
        - GU
        - HA
        - HE
        - HI
        - HU
        - IS
        - ID
        - IA
        - IE
        - IK
        - IU
        - GA
        - IT
        - JA
        - JW
        - KN
        - KS
        - KK
        - RW
        - KY
        - RN
        - KO
        - KU
        - LO
        - LA
        - LV
        - LN
        - LT
        - MK
        - MG
        - MS
        - ML
        - MT
        - MI
        - MR
        - MO
        - MN
        - NA
        - NE
        - 'NO'
        - OC
        - OR
        - PS
        - FA
        - PL
        - PT
        - PA
        - QU
        - RM
        - RO
        - RU
        - SM
        - SG
        - SA
        - GD
        - SR
        - SH
        - ST
        - TN
        - SN
        - SD
        - SI
        - SS
        - SK
        - SL
        - SO
        - ES
        - SU
        - SW
        - SV
        - TL
        - TG
        - TA
        - TT
        - TE
        - TH
        - BO
        - TI
        - TO
        - TS
        - TR
        - TK
        - TW
        - UG
        - UK
        - UR
        - UZ
        - VI
        - VO
        - CY
        - WO
        - XH
        - YI
        - YO
        - ZA
        - ZU
      type: string
    CreditsafeGlobalDataReportsCompanyStatusDescription:
      type: object
      description: >-
        High-level status of the company, such as 'Active', 'NonActive',
        'Pending', or 'Other'.
      properties:
        status:
          $ref: '#/components/schemas/CreditsafeGlobalDataCompanyStatus'
        providerStatus:
          type: string
          description: >-
            (Optionally populated) high-level local status. E.g. may contain a
            registry status, such as "Active" for a "Non-Trading" company,
            whereas the common "status" will say “NonActive".
        providerCode:
          type: string
          description: >-
            (Optionally populated) if available, this code pairs with the
            companyStatus.description
        isActive:
          type: boolean
          description: >-
            Boolean [true/false] when set to true indicates that the company is
            economically active.
        description:
          type: string
          description: A more in-depth status value, based on local descriptions.
    CreditsafeGlobalDataCurrency:
      description: >-
        The Currency in which the financial value is displayed, as a
        three-character ISO code.
      enum:
        - AFA
        - ALL
        - DZD
        - ADF
        - ADP
        - AOA
        - ARA
        - ARS
        - AMD
        - AWG
        - AUD
        - AZM
        - BSD
        - BHD
        - BDT
        - BBD
        - BYR
        - BZD
        - BMD
        - BTN
        - BOB
        - BAM
        - BWP
        - BRC
        - BRL
        - GBP
        - BND
        - BGN
        - BIF
        - XOF
        - XAF
        - KHR
        - CAD
        - CVE
        - KYD
        - CLP
        - CNY
        - COP
        - KMF
        - CDF
        - CRC
        - HRK
        - CUP
        - CZK
        - DKK
        - DJF
        - DOP
        - NLG
        - EUR
        - ECS
        - EGP
        - SVC
        - EEK
        - ETB
        - FKP
        - FJD
        - FRF
        - GMD
        - GEL
        - GHC
        - GIP
        - XAU
        - GTQ
        - GNF
        - GWP
        - GYD
        - HTG
        - HNL
        - HKD
        - HUF
        - ISK
        - INR
        - IDR
        - IRR
        - IQD
        - ILS
        - JMD
        - JPY
        - JOD
        - KZT
        - KES
        - KRW
        - KWD
        - KGS
        - LAK
        - LVL
        - LBP
        - LSL
        - LRD
        - LYD
        - LTL
        - MOP
        - MKD
        - MGF
        - MWK
        - MYR
        - MVR
        - MTL
        - MRO
        - MUR
        - MXN
        - MDL
        - MNT
        - MAD
        - MZM
        - MMK
        - ANG
        - NAD
        - NPR
        - NZD
        - NIO
        - NGN
        - KPW
        - NOK
        - OMR
        - PKR
        - XPD
        - PAB
        - PGK
        - PYG
        - PEN
        - PHP
        - XPT
        - PLN
        - QAR
        - RON
        - RUB
        - RWF
        - WST
        - STD
        - SAR
        - RSD
        - SCR
        - SLL
        - XAG
        - SGD
        - SKK
        - SIT
        - SBD
        - SOS
        - ZAR
        - LKR
        - SHP
        - SDD
        - SDG
        - SDP
        - SRD
        - SRG
        - SZL
        - SEK
        - CHF
        - SYP
        - TWD
        - TJS
        - TZS
        - THB
        - TOP
        - TTD
        - TND
        - TRY
        - TMM
        - USD
        - UGX
        - UAG
        - UAK
        - AED
        - UYU
        - UZS
        - VUV
        - VEF
        - VND
        - YUN
        - ZMK
        - ZWD
        - AFN
        - ATS
        - AZN
        - BYN
        - BEF
        - BOV
        - GRD
        - FIM
        - DEM
        - GHS
        - IEP
        - ITL
        - LUF
        - PTE
        - ESP
        - XDR
        - TMT
        - UAH
        - ERN
        - MGA
        - MRU
        - MZN
        - SSP
        - STN
        - YER
        - XPF
        - XCD
        - ZMW
        - ZWL
      type: string
    CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal:
      type: object
      properties:
        currency:
          $ref: '#/components/schemas/CreditsafeGlobalDataCurrency'
        value:
          type: number
          format: double
          description: >-
            The maximum amount of share capital the company is authorised by its
            constitutional documents to issue to shareholders.
    CreditsafeGlobalDataReportsCommonRatingValue:
      description: Standardised credit score – will be A, B, C, D or E.
      enum:
        - A
        - B
        - C
        - D
        - E
      type: string
    CreditsafeGlobalDataReportsFinancialValue_1_SystemString:
      type: object
      properties:
        currency:
          $ref: '#/components/schemas/CreditsafeGlobalDataCurrency'
        value:
          type: string
          description: Amount of credit advisable at any one time.
    CreditsafeGlobalDataReportsRangeDescribedValue_1_SystemString:
      type: object
      properties:
        maxValue:
          type: string
          description: The maximum value of the score that is provided for the Country.
        minValue:
          type: string
          description: The minimum value of the score that is provided for the Country.
        value:
          type: string
          description: >-
            Local credit score, as used by the supplier in that particular
            country
    CreditsafeGlobalDataReportsCreditRating:
      type: object
      properties:
        commonValue:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsCommonRatingValue'
        commonDescription:
          type: string
          description: A text description of the common credit score.
        creditLimit:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemString
        providerValue:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsRangeDescribedValue_1_SystemString
        providerDescription:
          type: string
          description: Local credit score description.
        pod:
          type: number
          format: double
          nullable: true
          description: >-
            Probability of Default (POD) is the anticipated likelihood of
            company default within the next 12 months in a percentage format.
        assessment:
          type: string
          description: An additional score assessment commentary.
    CreditsafeGlobalDataReportsLtdCompanySummary:
      type: object
      properties:
        businessName:
          type: string
          description: Registered company name/trading name of the business.
        country:
          $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
        companyNumber:
          type: string
          description: Creditsafe global identifier, called the Safe Number.
        companyRegistrationNumber:
          type: string
          description: Official registration number.
        ggsID:
          type: string
          description: The Connect API ID as used in v1.3 (GGS).
        leiNumber:
          type: string
          description: >-
            Global Legal Entity Identifier (LEI), often used in financial
            transactions identifier of an organisation
        mainActivity:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataCompanyActivityClassification
        companyStatus:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCompanyStatusDescription
        latestTurnoverFigure:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal
        latestShareholdersEquityFigure:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal
        creditRating:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsCreditRating'
    CreditsafeGlobalDataReportsLegalForm:
      type: object
      properties:
        commonCode:
          type: string
          description: >-
            A common global code that aims to categorise legal forms across
            Countries. Currently only available for Non Ltd reports as “Sole
            Trader” or “Other”.
        providerCode:
          type: string
          description: The local provider legal form codes specific to each Country
        description:
          type: string
          description: The legal type of the company e.g. S.A., GmbH, Ltd, N.V. etc.
    CreditsafeGlobalDataAddressData:
      type: object
      properties:
        type:
          type: string
          description: >-
            Address type description. Examples - "Registered Office", "Trading
            Address", "Postal Address", "Service Address" etc.
        simpleValue:
          type: string
          description: >-
            (Optionally populated) Registered address of the company. Whole
            string address if Creditsafe is unable to accurately assign values
            to specific address fields, or when specific local address formats
            need to be observed.
        street:
          type: string
          description: >-
            Street portion of the address line. Can also, optionally contain,
            the house number alongside the street.
        houseNumber:
          type: string
          description: House number portion of the address line.
        additionToAddress:
          type: string
          description: >-
            Additional details for a specified address, such as a PO Box number,
            or a unit number at the specified address location.
        city:
          type: string
          description: City portion of the address line.
        postalCode:
          type: string
          description: Postal code portion of the address line.
        province:
          type: string
          description: Province portion of the address line.
        region:
          type: string
          description: >-
            May contain the geographical region, for example "South-East" or a
            territorial division.
        telephone:
          type: string
          description: Registered telephone number.
        directMarketingOptOut:
          type: boolean
          nullable: true
          description: >-
            Boolean [true/false]. Where set to true, the subject has "opted out"
            via a central register, and they must not be contacted for
            commercial marketing purposes.
        directMarketingOptIn:
          type: boolean
          nullable: true
        country:
          $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
    CreditsafeGlobalDataReportsLtdCompanyBasicInformation:
      type: object
      properties:
        businessName:
          type: string
          nullable: true
          description: The trading name of business, or “-“ if unknown
        registeredCompanyName:
          type: string
          description: >-
            Registered company name, the legal name of the company. For NonLtd
            companies this would include the Owner name (i.e. the legal name),
            or “-“ if unknown.
        companyRegistrationNumber:
          type: string
          description: Official registration number.
        ggsId:
          type: string
          description: The Connect API ID as used in v1.3 (GGS).
        leiNumber:
          type: string
          description: >-
            Global Legal Entity Identifier (LEI), often used in financial
            transactions identifier of an organisation.
        country:
          $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
        vatRegistrationNumber:
          type: string
          description: Local VAT Number.
        vatRegistrationDate:
          description: Registration date of the local VAT number.
          type: string
          format: date-time
          nullable: true
        companyRegistrationDate:
          description: The date the company was registered.
          type: string
          format: date-time
          nullable: true
        operationsStartDate:
          description: The date the company began trading.
          type: string
          format: date-time
          nullable: true
        commercialCourt:
          description: The local commercial court at which the company was registered.
          type: string
        legalForm:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsLegalForm'
        officeType:
          description: Describes the office establishment type
          enum:
            - Registered
            - Trading
            - HeadOffice
            - Branch
            - Subsidiary
            - Franchise
            - Franchisor
            - SingleOffice
        ownershipType:
          description: Whether the company is wholly, part owned etc.
          type: string
        companyStatus:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCompanyStatusDescription
        principalActivity:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataCompanyActivityClassification
        contactAddress:
          $ref: '#/components/schemas/CreditsafeGlobalDataAddressData'
    CreditsafeGlobalDataReportsCompanyActivity:
      type: object
      properties:
        code:
          type: string
          description: Industry code used in that country e.g. SIC / NACE
        description:
          type: string
          description: Description of company’s main activity.
    CreditsafeGlobalDataReportsCompanyActivityList:
      type: object
      properties:
        classification:
          type: string
          description: >-
            The type of activity classification being used in the activities
            array. E.g. SIC07, NACE etc. Where possible includes the
            version/revision date.
        activities:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsCompanyActivity'
    CreditsafeGlobalDataReportsPreviousValue:
      type: object
      properties:
        dateChanged:
          description: Date when this name was officially changed (i.e. end date).
          type: string
          format: date-time
          nullable: true
    CreditsafeGlobalDataReportsPreviousName:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsPreviousValue'
        - type: object
          properties:
            name:
              type: string
              description: Any previous name under which the company was registered.
    CreditsafeGlobalDataReportsPreviousLegalForm:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsPreviousValue'
        - type: object
          properties:
            legalForm:
              $ref: '#/components/schemas/CreditsafeGlobalDataReportsLegalForm'
    CreditsafeGlobalDataReportsLtdCompanyIdentification:
      type: object
      properties:
        basicInformation:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsLtdCompanyBasicInformation
        activityClassifications:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsCompanyActivityList
        previousNames:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsPreviousName'
        previousLegalForms:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsPreviousLegalForm'
    CreditsafeGlobalDataReportsLtdCreditScore:
      type: object
      properties:
        currentCreditRating:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsCreditRating'
        currentContractLimit:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal
        previousCreditRating:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsCreditRating'
        latestRatingChangeDate:
          description: Last date that the credit score changed.
          type: string
          format: date-time
          nullable: true
    CreditsafeGlobalDataAddressDataReport:
      type: object
      properties:
        type:
          type: string
          description: >-
            Address type description. Examples - "Registered Office", "Trading
            Address", "Postal Address", "Service Address" etc.
        simpleValue:
          type: string
          description: >-
            (Optionally populated) Registered address of the company. Whole
            string address if Creditsafe is unable to accurately assign values
            to specific address fields, or when specific local address formats
            need to be observed.
        street:
          type: string
          description: >-
            Street portion of the address line. Can also, optionally contain,
            the house number alongside the street.
        houseNumber:
          type: string
          description: House number portion of the address line.
        additionToAddress:
          type: string
          description: >-
            Additional details for a specified address, such as a PO Box number,
            or a unit number at the specified address location.
        city:
          type: string
          description: City portion of the address line.
        postalCode:
          type: string
          description: Postal code portion of the address line
        province:
          type: string
          description: Province portion of the address line.
        region:
          type: string
          description: >-
            May contain the geographical region, for example "South-East" or a
            territorial division.
        telephone:
          type: string
          description: Telephone number of the main address.
        directMarketingOptOut:
          type: boolean
          nullable: true
          description: >-
            Boolean [true/false]. Where set to true, the subject has "opted out"
            via a central register, and they must not be contacted for
            commercial marketing purposes.
        directMarketingOptIn:
          type: boolean
          nullable: true
        country:
          $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
    CreditsafeGlobalDataReportsLtdContactInformation:
      type: object
      properties:
        mainAddress:
          $ref: '#/components/schemas/CreditsafeGlobalDataAddressDataReport'
        otherAddresses:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataAddressDataReport'
        previousAddresses:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataAddressDataReport'
        emailAddresses:
          type: array
          description: Email address for the company.
          items:
            type: string
        websites:
          type: array
          description: Website address of the company.
          items:
            type: string
    CreditsafeGlobalDataReportsIndicatorIndustryComparison:
      type: object
      properties:
        sectorCode:
          type: string
        sectorAverage:
          type: string
          description: >-
            The average indicator value for the industry sector in which the
            subject company operates.
        sectorCount:
          type: integer
          format: int32
          description: The count of all companies in this industry sector.
          nullable: true
        totalAverage:
          type: string
          description: >-
            The average indicator value for all companies (irrespective of
            industry sector).
        totalCount:
          type: integer
          format: int32
          description: The count of all companies (irrespective of industry sector).
          nullable: true
    CreditsafeGlobalDataReportsIndicators:
      type: array
      description: >-
        Indicators provides additional information when assessing a company's
        performance. This is a premium service, not available for all customers.
      items:
        type: object
        properties:
          type:
            type: string
            description: >-
              A lowercase char(3) code indicating the type of indicator. For
              example - Financial Strength Indicator (“fsi”), Payment Behaviour
              Indicator (“pbi”), Payment Expectation Indicator (“pei”).
            enum:
              - eti
              - pei
              - fsi
              - pbi
          value:
            type: string
            description: The value of the indicator.
            example: X
          changeDate:
            type: string
            format: date-time
            description: The date associated with the current indicator.
          industryComparison:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsIndicatorIndustryComparison
    CreditsafeGlobalDataReportsEntityFullName:
      type: object
      properties:
        id:
          type: string
          description: Unique ID.
        idType:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsIdType'
        name:
          type: string
          description: >-
            Name of the Shareholder, or Company Name if a corporate shareholder
            exists.
        title:
          type: string
          description: Title, if known.
        firstNames:
          type: string
          description: >-
            First name(s) of the shareholder. May optionally include middle
            names, or initials if these cannot be distinguished.
        firstName:
          type: string
          description: >-
            First name of the shareholder. This field should be used if a
            middleName also exists.
        middleName:
          type: string
          description: Middle name of the shareholder.
        surname:
          type: string
          description: Last name of the shareholder.
        address:
          $ref: '#/components/schemas/CreditsafeGlobalDataAddressData'
    CreditsafeGlobalDataReportsEntityType:
      description: >-
        Indicates if the shareholders record relates to a "Person", "Company" or
        "Other".
      enum:
        - Other
        - Person
        - Company
      type: string
    CreditsafeGlobalDataReportsShareClassAdditionalData:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsAdditionalData'
        - type: object
    CreditsafeGlobalDataReportsShareClass:
      type: object
      properties:
        shareType:
          description: (Optionally populated) The share class description.
          type: string
        currency:
          $ref: '#/components/schemas/CreditsafeGlobalDataCurrency'
        valuePerShare:
          type: number
          format: double
          nullable: true
          description: >-
            (Optionally populated) The value per share, also known as the par
            value. Expressed as an integer, or to two decimal places.
        jointlyOwned:
          type: boolean
          nullable: true
          description: >-
            (Optionally populated) Boolean. Set to true where the shares are
            jointly owned.
        numberOfSharesOwned:
          type: integer
          format: int64
          nullable: true
          description: >-
            (Optionally populated) The number of shares owned. If more than one
            share class exists, this is the number per share class.
        valueOfSharesOwned:
          type: number
          format: double
          nullable: true
          description: >-
            (Optionally populated) The total nominal value of Shares owned. If
            more than one share class exists, this is the total nominal value
            per share class.
        additionalData:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsShareClassAdditionalData
    CreditsafeGlobalDataReportsShareHolder:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsEntityFullName'
        - type: object
          properties:
            shareholderType:
              $ref: '#/components/schemas/CreditsafeGlobalDataReportsEntityType'
            shareType:
              type: string
              description: The share class, for example "Ordinary".
            currency:
              $ref: '#/components/schemas/CreditsafeGlobalDataCurrency'
            totalValueOfSharesOwned:
              type: number
              format: double
              nullable: true
              description: >-
                The total nominal value of all shares owned. Expressed as an
                integer, or to two decimal places.
            totalNumberOfSharesOwned:
              type: integer
              format: int64
              nullable: true
              description: The total number of all shares owned.
            percentSharesHeld:
              type: number
              format: double
              nullable: true
              description: >-
                The total percentage of all shares held. Expressed as an
                integer, or to two decimal places.
            startDate:
              type: string
              format: date-time
              nullable: true
              description: Date when the shareholding started.
            endDate:
              type: string
              format: date-time
              nullable: true
              description: >-
                Date when the shareholding ended. Where populated, this
                indicates that the party has ceased to be a shareholder.
            hasNegativeInfo:
              type: boolean
              nullable: true
              description: >-
                Boolean [true/false] when set to true, this indicates that the
                shareholder has negative information such as Protesti, Court
                Judgements etc. linked to their unique shareholders ID.
            shareClasses:
              type: array
              items:
                $ref: '#/components/schemas/CreditsafeGlobalDataReportsShareClass'
    CreditsafeGlobalDataReportsLtdShareCapitalStructure:
      type: object
      properties:
        nominalShareCapital:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal
        issuedShareCapital:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal
        shareCapitalCurrency:
          type: string
          description: >-
            The Currency in which the share values are displayed, as a
            three-character ISO code.
        numberOfSharesIssued:
          type: integer
          format: int64
          nullable: true
          description: The total number of issued shares.
        shareHolders:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsShareHolder'
    CreditsafeGlobalDataReportsGender:
      enum:
        - Unknown
        - Male
        - Female
        - NotApplicable
      type: string
    CreditsafeGlobalDataReportsCorporatePositionAdditionalData:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsAdditionalData'
        - type: object
    CreditsafeGlobalDataReportsCorporatePosition:
      type: object
      properties:
        dateAppointed:
          type: string
          format: date-time
          nullable: true
          description: The date the director was appointed.
        commonCode:
          type: string
          description: >-
            A common global code that aims to categorise director positions
            across Countries – currently no data available.
        providerCode:
          type: string
          description: >-
            The local provider director code (if exists) specific to each
            Country.
        positionName:
          type: string
          description: The director’s role/position in a company.
        authority:
          type: string
          description: >-
            If available, any available details pertaining to the score, power,
            limitations, signing authority or ability to bind the company.
        apptDurationType:
          type: string
          description: >-
            The appointment duration should be used in conjunction with the
            appointment term field.
        additionalData:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCorporatePositionAdditionalData
    CreditsafeGlobalDataReportsDirectorAdditionalData:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsAdditionalData'
        - type: object
    CreditsafeGlobalDataReportsDirector:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsEntityFullName'
        - type: object
          properties:
            gender:
              $ref: '#/components/schemas/CreditsafeGlobalDataReportsGender'
            birthName:
              type: string
              description: The birth name or previous legal name of the officer.
            dateOfBirth:
              type: string
              format: date-time
              nullable: true
              description: The director’s date of birth.
            placeOfBirth:
              type: string
              description: The director’s place or region of birth.
            nationality:
              type: string
              description: The director’s nationality or country of birth.
            countryOfResidence:
              type: string
              description: The country of residence, if known.
            country:
              $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
            directorType:
              $ref: '#/components/schemas/CreditsafeGlobalDataReportsEntityType'
            hasNegativeInfo:
              type: boolean
              nullable: true
              description: >-
                Linked with DE searches, may return with other countries if data
                is available. Boolean [true/false] if the director has negative
                information, such as Protesti, Court Judgements etc linked to
                their unique directors ID. Boolean [true/false] set to true
                where the director is known to be an authorised signatory.
                Further details, if known, may be present in "authority" or
                "additionalData".
            signingAuthority:
              description: >-
                Linked with DE searches, may return with other countries if data
                is available.
              type: boolean
              nullable: true
            positions:
              type: array
              items:
                $ref: >-
                  #/components/schemas/CreditsafeGlobalDataReportsCorporatePosition
            additionalData:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataReportsDirectorAdditionalData
    CreditsafeGlobalDataReportsPreviousDirector:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsDirector'
        - type: object
          properties:
            resignationDate:
              type: string
              format: date-time
              nullable: true
              description: The date the director resigned.
    CreditsafeGlobalDataReportsLtdDirectors:
      type: object
      properties:
        currentDirectors:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsDirector'
        previousDirectors:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsPreviousDirector'
    CreditsafeGlobalDataReportsCorporatePositionResigned:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsCorporatePosition'
        - type: object
          properties:
            resignationDate:
              type: string
              format: date-time
              nullable: true
    CreditsafeGlobalDataReportsDirectorship:
      type: object
      properties:
        id:
          type: string
        title:
          type: string
        initials:
          type: string
        name:
          type: string
        position:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCorporatePositionResigned
        registrationNumber:
          type: string
        companyName:
          type: string
        status:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCompanyStatusDescription
    CreditsafeGlobalDataReportsDirectorships:
      type: object
      properties:
        currentDirectorships:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsDirectorship'
        previousDirectorships:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsDirectorship'
    CreditsafeGlobalDataReportsEntity:
      type: object
      properties:
        name:
          description: Name of bank that the company holds an account with.
          type: string
        address:
          $ref: '#/components/schemas/CreditsafeGlobalDataAddressData'
    CreditsafeGlobalDataReportsBanker:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsEntity'
        - type: object
          properties:
            bankCode:
              type: string
              description: Bank code associated with the bank.
            bic:
              type: string
              description: >-
                Bank Identifier Code (BIC) or SWIFT code, used for international
                transfers.
    CreditsafeGlobalDataReportsAdvisor:
      type: object
      properties:
        auditorName:
          type: string
          description: Full name of the company who is responsible for auditing.
        solicitorName:
          type: string
          description: Name of solicitors.
        accountantName:
          type: string
          description: >-
            Full name of the accountancy firm who responsible for preparing the
            accounts.
    CreditsafeGlobalDataReportsEmployeeInformation:
      type: object
      properties:
        year:
          type: integer
          format: int32
          nullable: true
          description: Year that the figures were reordered.
        numberOfEmployees:
          type: string
          description: Number of staff that the company employ directly.
    CreditsafeGlobalDataReportsLtdOtherInformation:
      type: object
      properties:
        bankers:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsBanker'
        advisors:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsAdvisor'
        employeesInformation:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsEmployeeInformation
    CreditsafeGlobalDataGroupStructureCompanyData:
      type: object
      properties:
        id:
          type: string
          description: Connect Id.
        country:
          $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
        registrationNumber:
          type: string
          description: Official registration number.
        safeNo:
          type: string
          description: Creditsafe global identifier, called the Safe Number.
        idType:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsIdType'
        name:
          type: string
          description: Full company name of Ultimate Holding Company.
        type:
          $ref: '#/components/schemas/CreditsafeGlobalDataCompanyType'
        officeType:
          $ref: '#/components/schemas/CreditsafeGlobalDataOfficeType'
        status:
          $ref: '#/components/schemas/CreditsafeGlobalDataCompanyStatus'
        vatNo:
          description: Local VAT Number.
          oneOf:
            - type: string
              nullable: true
            - type: array
              items:
                type: string
                nullable: true
        additionalInformation:
          $ref: '#/components/schemas/CreditsafeGlobalDataAdditionalInformation'
        address:
          $ref: '#/components/schemas/CreditsafeGlobalDataAddressData'
        activity:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataCompanyActivityClassification
        legalForm:
          type: string
        additionalData:
          $ref: '#/components/schemas/CreditsafeGlobalDataCompanyDataAdditionalData'
    CreditsafeGlobalDataReportsLtdGroupStructure:
      type: object
      properties:
        ultimateParent:
          $ref: '#/components/schemas/CreditsafeGlobalDataGroupStructureCompanyData'
        immediateParent:
          $ref: '#/components/schemas/CreditsafeGlobalDataGroupStructureCompanyData'
        subsidiaryCompanies:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataGroupStructureCompanyData'
        affiliatedCompanies:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataGroupStructureCompanyData'
    CreditsafeGlobalDataReportsCompanyInGroupAdditionalData:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsAdditionalData'
        - type: object
    CreditsafeGlobalDataReportsCompanyInGroup:
      type: object
      properties:
        id:
          type: string
          description: Connect Id.
        country:
          type: string
          description: Country where the company is established.
        safeNumber:
          type: string
          description: Creditsafe global identifier, called the Safe Number.
        idType:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsIdType'
        companyName:
          type: string
          description: Full company name.
        registeredNumber:
          type: string
          description: Official registration number.
        latestAnnualAccounts:
          type: string
          format: date-time
          nullable: true
          description: The last filed financial statements Year End Date of the company.
        level:
          type: integer
          format: int32
          description: The hierarchical level of the company within the group structure.
        percentOfOwnership:
          type: number
          format: double
          nullable: true
          description: The percentage of shares owned.
        status:
          type: string
          description: >-
            High-level status. Values include "Active", "NonActive", "Pending"
            and "Other".
        commonRatingBand:
          type: string
          description: Standardised credit score.
        additionalData:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCompanyInGroupAdditionalData
    CreditsafeGlobalDataReportsLtdFinancialStatement:
      type: object
      properties:
        type:
          type: string
          description: >-
            A code element set as "GlobalFinancialsGGS", which represents that
            the financial statements are in a common/standardised international
            format.
        yearEndDate:
          type: string
          format: date-time
          description: Financial Year End date for the annual accounts.
        numberOfWeeks:
          type: integer
          format: int32
          nullable: true
          description: Number of weeks in the year.
        currency:
          $ref: '#/components/schemas/CreditsafeGlobalDataCurrency'
        consolidatedAccounts:
          type: boolean
          nullable: true
          description: Boolean [true/false]. Are the accounts consolidated?
    CreditsafeGlobalDataReportsProfitAndLossFigures:
      type: object
      properties:
        revenue:
          type: number
          format: double
          nullable: true
          description: >-
            Income earned from normal business activities, including the sale of
            goods and services.
        operatingCosts:
          type: number
          format: double
          nullable: true
          description: Costs incurred in the general running of the business.
        operatingProfit:
          type: number
          format: double
          nullable: true
          description: >-
            The results of the company after deducting Operating Costs from its
            Revenue.
        wagesAndSalaries:
          type: number
          format: double
          nullable: true
          description: >-
            Wages and salaries paid to employees of the company. Where possible
            this excludes Pensions.
        pensionCosts:
          type: number
          format: double
          nullable: true
          description: The cost of pension benefits for employees of the company.
        depreciation:
          type: number
          format: double
          nullable: true
          description: The amount written off Tangible Fixed Assets during the year.
        amortisation:
          type: number
          format: double
          nullable: true
          description: The amount written off Intangible Fixed Assets during the year.
        financialIncome:
          type: number
          format: double
          nullable: true
          description: Interest income earned during the year.
        financialExpenses:
          type: number
          format: double
          nullable: true
          description: Interest expenses incurred during the year.
        extraordinaryIncome:
          type: number
          format: double
          nullable: true
          description: Income arising due to events of a non-recurring nature.
        extraordinaryCosts:
          type: number
          format: double
          nullable: true
          description: Costs incurred due to events of a non-recurring nature.
        profitBeforeTax:
          type: number
          format: double
          nullable: true
          description: The results of the company before deducting any charge for taxation.
        tax:
          type: number
          format: double
          nullable: true
          description: Taxation payable on the profits of the company.
        profitAfterTax:
          type: number
          format: double
          nullable: true
          description: The results of the company after deducting any charge for taxation.
        dividends:
          type: number
          format: double
          nullable: true
          description: The total amount of profits distributed to shareholders.
        minorityInterests:
          type: number
          format: double
          nullable: true
          description: >-
            Profits attributable to shareholders holding a minority interest in
            the company.
        otherAppropriations:
          type: number
          format: double
          nullable: true
          description: >-
            Other miscellaneous items that are deducted / added to affect the
            Retained Profit / Loss of a company.
        retainedProfit:
          type: number
          format: double
          nullable: true
          description: >-
            The results of the company after all income and expenses have been
            credited/debited.
    CreditsafeGlobalDataReportsBalanceSheet:
      type: object
      properties:
        landAndBuildings:
          type: number
          format: double
          nullable: true
          description: Land and buildings owned by the company for long-term use.
        plantAndMachinery:
          type: number
          format: double
          nullable: true
          description: Plant and machinery owned by the company for long-term use.
        otherTangibleAssets:
          type: number
          format: double
          nullable: true
          description: >-
            Tangible fixed assets other than Land & Buildings or Plant &
            Machinery.
        totalTangibleAssets:
          type: number
          format: double
          nullable: true
          description: Physical assets owned by the company for long-term use.
        goodwill:
          type: number
          format: double
          nullable: true
          description: The premium paid or accumulated on the purchase of an asset.
        otherIntangibleAssets:
          type: number
          format: double
          nullable: true
          description: >-
            Intangible fixed assets other than goodwill such as Trademarks,
            Patents, Research & Development, etc.
        totalIntangibleAssets:
          type: number
          format: double
          nullable: true
          description: Assets that have a value but no physical existence.
        investments:
          type: number
          format: double
          nullable: true
          description: Long-term investments including shares and securities.
        loansToGroup:
          type: number
          format: double
          nullable: true
          description: Long-term loans made by the company to related businesses.
        otherLoans:
          type: number
          format: double
          nullable: true
          description: Other long-term loans made by the company.
        miscellaneousFixedAssets:
          type: number
          format: double
          nullable: true
          description: >-
            Long-term assets other than Tangible Assets, Intangible Assets,
            Investments, or Loans.
        totalOtherFixedAssets:
          type: number
          format: double
          nullable: true
          description: >-
            Total long-term assets other than Tangible Assets or Intangible
            Assets.
        totalFixedAssets:
          type: number
          format: double
          nullable: true
          description: The total of Tangible, Intangible, and Other Fixed Assets.
        rawMaterials:
          type: number
          format: double
          nullable: true
          description: Materials held by the company that have not yet been processed.
        workInProgress:
          type: number
          format: double
          nullable: true
          description: >-
            Goods or contracts that are in the process of manufacture or
            completion.
        finishedGoods:
          type: number
          format: double
          nullable: true
          description: Goods held that are ready for sale or use.
        otherInventories:
          type: number
          format: double
          nullable: true
          description: Other amounts classed as Inventory but not included above.
        totalInventories:
          type: number
          format: double
          nullable: true
          description: The total of stocks held by the company and work in progress.
        tradeReceivables:
          type: number
          format: double
          nullable: true
          description: >-
            Amounts due within one year from customers for goods and services
            supplied on credit.
        groupReceivables:
          type: number
          format: double
          nullable: true
          description: Amounts due within one year from related businesses.
        receivablesDueAfter1Year:
          type: number
          format: double
          nullable: true
          description: >-
            Amounts due after one year owing to the company (including trade and
            group receivables due after one year).
        miscellaneousReceivables:
          type: number
          format: double
          nullable: true
          description: >-
            Amounts due within one year owing to the company other than trade
            and group receivables.
        totalReceivables:
          type: number
          format: double
          nullable: true
          description: Total amounts receivable by the company.
        cash:
          type: number
          format: double
          nullable: true
          description: Cash at bank, cash in hand, and cash equivalents.
        otherCurrentAssets:
          type: number
          format: double
          nullable: true
          description: >-
            Any short-term assets that have not already been included as
            Inventory, Receivables, or Cash.
        totalCurrentAssets:
          type: number
          format: double
          nullable: true
          description: >-
            The total of Stocks, Debtors, Cash, and other assets due within one
            year.
        totalAssets:
          type: number
          format: double
          nullable: true
          description: The total of Current and Fixed Assets.
        tradePayables:
          type: number
          format: double
          nullable: true
          description: >-
            Amounts due within one year owing to suppliers for goods and
            services provided on credit.
        bankLiabilities:
          type: number
          format: double
          nullable: true
          description: Amounts due within one year owing to banks for overdrafts and loans.
        otherLoansOrFinance:
          type: number
          format: double
          nullable: true
          description: >-
            Loans or finance due within one year owing to parties other than
            banks or related businesses.
        groupPayables:
          type: number
          format: double
          nullable: true
          description: Amounts due within one year to related businesses.
        miscellaneousLiabilities:
          type: number
          format: double
          nullable: true
          description: Other amounts due within one year owing by the company.
        totalCurrentLiabilities:
          type: number
          format: double
          nullable: true
          description: Total short-term liabilities of the company.
        tradePayablesDueAfter1Year:
          type: number
          format: double
          nullable: true
          description: >-
            Amounts due after one year owing to suppliers for goods and services
            provided on credit.
        bankLiabilitiesDueAfter1Year:
          type: number
          format: double
          nullable: true
          description: Amounts due after one year owing to banks for overdrafts and loans.
        otherLoansOrFinanceDueAfter1Year:
          type: number
          format: double
          nullable: true
          description: >-
            Loans or finance due after one year owing to parties other than
            banks or related businesses.
        groupPayablesDueAfter1Year:
          type: number
          format: double
          nullable: true
          description: Amounts due after one year to related businesses.
        miscellaneousLiabilitiesDueAfter1Year:
          type: number
          format: double
          nullable: true
          description: Other amounts due after one year owing by the company.
        totalLongTermLiabilities:
          type: number
          format: double
          nullable: true
          description: Total long-term liabilities of the company.
        totalLiabilities:
          type: number
          format: double
          nullable: true
          description: >-
            The total of Total Long-term Liabilities and Total Current
            Liabilities.
        calledUpShareCapital:
          type: number
          format: double
          nullable: true
          description: The issued and paid share capital from shareholders.
        sharePremium:
          type: number
          format: double
          nullable: true
          description: >-
            The excess of the amount received on the issue of shares over their
            value.
        revenueReserves:
          type: number
          format: double
          nullable: true
          description: The accumulation of profits/losses from previous trading periods.
        otherReserves:
          type: number
          format: double
          nullable: true
          description: Other capital and reserves that form part of shareholders' equity.
        totalShareholdersEquity:
          type: number
          format: double
          nullable: true
          description: The total capital and reserves of the company.
    CreditsafeGlobalDataReportsOtherFinancials:
      type: object
      properties:
        contingentLiabilities:
          type: string
          description: >-
            Potential liabilities that are not recognised in the balance sheet,
            output as a string. Usually contains integers, but can also be
            output as a string value (such as “YES” or “NO”).
        workingCapital:
          type: number
          format: double
          nullable: true
          description: >-
            Total Current Assets – Receivables Due after 1 year – Total Current
            Liabilities. This measures if the company has sufficient short-term
            assets to cover its current debts.
        netWorth:
          type: number
          format: double
          nullable: true
          description: >-
            Often referred to as the 'book value' of the business this equals
            Total Shareholders’ Equity less Total Intangible Assets
    CreditsafeGlobalDataReportsFinancialRatios:
      type: object
      properties:
        preTaxProfitMargin:
          type: number
          format: double
          nullable: true
          description: >-
            Pre-tax profits / Turnover x 100. This shows the percentage of
            Profit in each pound of sales or the equivalent of retailers
            'mark-up'.
        returnOnCapitalEmployed:
          type: number
          format: double
          nullable: true
          description: >-
            Pre-Tax Profit / Capital Employed x 100. This ratio measures the
            profits a business yields in return for the money (Capital)
            invested.
        returnOnTotalAssetsEmployed:
          type: number
          format: double
          nullable: true
          description: >-
            Pre-Tax Profits / Total Assets x 100. This shows the ‘return’ or
            'profit' on each pound of Assets used as a percentage.
        returnOnNetAssetsEmployed:
          type: number
          format: double
          nullable: true
          description: >-
            Pre-Tax Profits / Net Assets x 100. This shows the ‘return’ in
            percent on the net assets of the company. The higher the percentage
            the more profitable the company.
        salesOrNetWorkingCapital:
          type: number
          format: double
          nullable: true
          description: >-
            Turnover / (Total Current Assets - Receivables Due after 1 year -
            Total Current Liabilities). The higher the ratio the higher the
            volume of Sales made per the companies working capital.
        stockTurnoverRatio:
          type: number
          format: double
          nullable: true
          description: >-
            Stocks / Turnover x 100. This shows the number of times the trading
            stock of a company is ‘turned over’ in a trading period. If the
            ratio is low this indicates that relatively little money is tied up
            in Stocks.
        debtorDays:
          type: number
          format: double
          nullable: true
          description: >-
            Trade Debtors / Turnover x 365 days. This is a calculation that
            predicts the average time taken for the company to collect its
            invoices for goods and services provided to its customers.
        creditorDays:
          type: number
          format: double
          nullable: true
          description: >-
            Trade Creditors / Turnover x 365 days. This is a calculation that
            predicts the average time taken for the company to settle its
            invoices for goods and services provided by its suppliers.
        currentRatio:
          type: number
          format: double
          nullable: true
          description: >-
            Total Current Assets - Receivables Due after 1 year / Total Current
            Liabilities. This is an indication of a company's ability to meet
            short-term debt obligations; the higher the ratio, the more liquid
            the company is.
        liquidityRatioOrAcidTest:
          type: number
          format: double
          nullable: true
          description: >-
            Total Current Assets - Total Inventories - Receivables Due after 1
            year / Total Current Liabilities. This, like the current ratio,
            measures how quickly a company can meet its short-term debts.
            However, this ratio excludes stock, as there is no guarantee the
            value of Stocks can be realised quickly.
        currentDebtRatio:
          type: number
          format: double
          nullable: true
          description: >-
            Total Current Liabilities / Total Shareholders’ Equity. This
            measures the amount of short-term debt in relation to the value of
            shareholders’ funds.
        gearing:
          type: number
          format: double
          nullable: true
          description: >-
            Bank Overdraft & Loans + Total Long-term Liabilities/Total
            Shareholders’ Equity x 100. This is the relationship between the
            size of the company’s debt in proportion to Equity (Shareholders
            Funds).
        equityInPercentage:
          type: number
          format: double
          nullable: true
          description: >-
            Total Shareholders’ Equity / (Total Current Assets + Tangible Fixed
            Assets – Total Intangible Assets) x 100. This ratio shows the worth
            of the company (shareholders’ funds) as a percentage of total
            current and tangible assets.
        totalDebtRatio:
          type: number
          format: double
          nullable: true
          description: >-
            Total Current Liabilities + Total Long-term liabilities / Total
            Shareholders’ Equity x 100. This shows the relative indebtedness of
            a company in relation to the worth of the company.
    CreditsafeGlobalDataReportsGlobalFinancialsGGS:
      allOf:
        - $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsLtdFinancialStatement
        - type: object
          properties:
            profitAndLoss:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataReportsProfitAndLossFigures
            balanceSheet:
              $ref: '#/components/schemas/CreditsafeGlobalDataReportsBalanceSheet'
            otherFinancials:
              $ref: '#/components/schemas/CreditsafeGlobalDataReportsOtherFinancials'
            ratios:
              $ref: '#/components/schemas/CreditsafeGlobalDataReportsFinancialRatios'
    CreditsafeGlobalDataReportsLocalFinancialStatement:
      allOf:
        - $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsLtdFinancialStatement
        - type: object
          properties:
            profitAndLoss:
              type: object
              additionalProperties: true
              description: >-
                Please refer to the relevant country data dictionary for the
                properties expected in this object <a
                href="https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries"
                target="_blank"> HERE </a>
            balanceSheet:
              type: object
              additionalProperties: true
              description: >-
                Please refer to the relevant country data dictionary for the
                properties expected in this object <a
                href="https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries"
                target="_blank"> HERE </a>
            otherFinancials:
              type: object
              additionalProperties: true
              description: >-
                Please refer to the relevant country data dictionary for the
                properties expected in this object <a
                href="https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries"
                target="_blank"> HERE </a>
            ratios:
              type: object
              additionalProperties: true
              description: >-
                Please refer to the relevant country data dictionary for the
                properties expected in this object <a
                href="https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries"
                target="_blank"> HERE </a>
    CreditsafeGlobalDataReportsReportNegativeInformation:
      type: object
      description: >-
        Please refer to the relevant country data dictionary for the properties
        expected in this object <a
        href="https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries"
        target="_blank"> HERE </a>
    CreditsafeGlobalDataReportsReportAdditionalInformation:
      type: object
      description: >-
        Please refer to the relevant country data dictionary for the properties
        expected in this object <a
        href="https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries"
        target="_blank"> HERE </a>
    CreditsafeGlobalDataReportsCompanyReportExtraSection:
      type: object
    CreditsafeGlobalDataReportsLtdDirectorsExtra:
      allOf:
        - $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection
        - type: object
    CreditsafeGlobalDataReportsLtdExtendedGroupStructureExtra:
      allOf:
        - $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection
        - type: object
    CreditsafeGlobalDataReportsReportPaymentData:
      type: object
      description: >-
        Please refer to the relevant country data dictionary for the properties
        expected in this object <a
        href="https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries"
        target="_blank"> HERE </a>
    CreditsafeGlobalDataReportsReportPaymentDataExtra:
      allOf:
        - $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection
        - type: object
    CreditsafeGlobalDataReportsReportAlternateSummary:
      type: object
    CreditsafeGlobalDataReportsReportNegativeInformationExtra:
      allOf:
        - $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection
        - type: object
    CreditsafeGlobalDataReportsExceptions:
      type: object
      properties:
        eventType:
          type: object
          description: Describes the exception alert
          properties:
            code:
              type: string
              description: A code associated with the exception event, for example GA_8
            description:
              type: string
              description: >-
                A description associated with the event, for example "Multiple
                companies has this exact address".
        eventLevel:
          type: object
          description: Level of risk for the exception alert
          properties:
            code:
              type: string
              description: >-
                A numeric code which indicates if the event level is General [0]
                OR "High" [1].
            description:
              type: string
              description: >-
                A text description which indicates if the event level is General
                [0] OR "High" [1].
        eventDate:
          type: string
          description: >-
            The date associated with the exception event - this might be the
            date when the unusual behaviour was detected, not necessarily the
            date of the original event.
          format: date-time
    CreditsafeGlobalDataReportsCompanyReport:
      type: object
      properties:
        companyId:
          type: string
        language:
          $ref: '#/components/schemas/CreditsafeGlobalDataLanguage'
        companySummary:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsLtdCompanySummary'
        companyIdentification:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsLtdCompanyIdentification
        creditScore:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsLtdCreditScore'
        contactInformation:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsLtdContactInformation
        indicators:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsIndicators'
        shareCapitalStructure:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsLtdShareCapitalStructure
        directors:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsLtdDirectors'
        directorships:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsDirectorships'
        otherInformation:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsLtdOtherInformation'
        groupStructure:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsLtdGroupStructure'
        extendedGroupStructure:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsCompanyInGroup'
        financialStatements:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsGlobalFinancialsGGS
        localFinancialStatements:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsLocalFinancialStatement
        negativeInformation:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsReportNegativeInformation
        additionalInformation:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsReportAdditionalInformation
        directorsExtra:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsLtdDirectorsExtra'
        extendedGroupStructureExtra:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsLtdExtendedGroupStructureExtra
        paymentData:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsReportPaymentData'
        paymentDataExtra:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsReportPaymentDataExtra
        alternateSummary:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsReportAlternateSummary
        negativeInformationExtra:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsReportNegativeInformationExtra
        exceptions:
          type: array
          description: >-
            Identifies unusual behaviours, for example multiple changes in
            address in a short period of time. This is a premium service, not
            available for all customers and is only availble for specific report
            templates [gycs, custom, full].
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsExceptions'
    CreditsafeGlobalDataReportsCompanyReportResponse:
      allOf:
        - type: object
          properties:
            correlationId:
              type: string
              description: A unique ID assigned to this request.
            failedSections:
              type: array
              items:
                $ref: '#/components/schemas/CreditsafeGlobalDataReportsReportSection'
            report:
              $ref: '#/components/schemas/CreditsafeGlobalDataReportsCompanyReport'
            companyId:
              type: string
            dateOfOrder:
              type: string
              format: date-time
            language:
              type: string
            userId:
              type: integer
    CreditsafeGlobalDataCoreAttachmentBinaryAttachmentjson:
      type: object
      properties:
        correlationID:
          type: string
          description: A unique ID assigned to this request.
        failedSections:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsReportSection'
        report:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsCompanyReport'
        pdfReportStream:
          type: string
          format: byte
          description: Base64-encoded contents of the PDF.
        companyID:
          type: string
        dateOfOrder:
          type: string
          format: date-time
        language:
          type: string
        userID:
          type: integer
    ConnectConfidenceMatchMatchResults:
      properties:
        totalMatches:
          type: integer
          description: The total number of companies matched in the search results.
        matchedCompanies:
          type: array
          description: A list of companies that matched the search criteria.
          items:
            type: object
            properties:
              matchScoreConfidence:
                type: integer
                description: >-
                  The confidence score for the match, indicating the likelihood
                  of a correct match (higher is better).
              id:
                type: string
                description: The unique identifier for the matched company.
              country:
                type: string
                description: The ISO country code of the matched company.
              regNo:
                type: string
                description: The registration number of the matched company.
              safeNo:
                type: string
                description: The Creditsafe Safe Number for the matched company.
              name:
                type: string
                description: The name of the matched company.
              phoneNo:
                type: string
                description: The main phone number of the matched company.
              address:
                type: object
                description: The address details of the matched company.
                properties:
                  simpleValue:
                    type: string
                    description: A simplified, single-line version of the address.
                  street:
                    type: string
                    description: The street name of the address.
                  city:
                    type: string
                    description: The city of the address.
                  postcode:
                    type: string
                    description: The postal code of the address.
                  country:
                    type: string
                    description: The ISO country code of the address.
                  state:
                    type: string
                    description: The state or region of the address.
              status:
                type: string
                description: >-
                  The current status of the matched company (e.g., Active,
                  Inactive).
              statusDescription:
                type: string
                description: >-
                  Additional description of the company's status (e.g., Non
                  trading).
              type:
                type: string
                description: The type or classification of the matched company (e.g., Ltd).
              activityCode:
                type: string
                description: >-
                  The activity code (industry classification) of the matched
                  company.
              officeType:
                type: string
                description: >-
                  The office type of the company. Only available with US
                  companies.
              dateOfLatestAccounts:
                type: string
                description: >-
                  The date of the latest accounts filed by the company (ISO 8601
                  format).
              dateOfLatestChange:
                type: string
                description: >-
                  The date of the latest change to the company's details (ISO
                  8601 format).
              matchScoreExplainPlan:
                type: object
                description: >
                  Detailed breakdown of the match score calculation for the
                  company.   Each field uses a grading system to indicate the
                  quality of the match: - "A": Exact match - "B": Close match -
                  "C": Partial match - "D": Similar in essence (e.g., ignoring
                  common industry keywords) - "O": No match - "X": Not
                  applicable or not compared
                properties:
                  matchScore:
                    type: integer
                    description: The overall match score for the company.
                  matchScoreAlpha:
                    type: string
                    description: The alphabetical match score component.
                  matchScoreLocal Id:
                    type: string
                    description: The match score component for the local identifier.
                  matchScoreName:
                    type: string
                    description: The match score for the company name.
                  matchScoreHouseNo:
                    type: string
                    description: The match score for the house number.
                  matchScoreStreet:
                    type: string
                    description: The match score for the street.
                  matchScorePoBox:
                    type: string
                    description: The match score for the PO Box.
                  matchScoreCity:
                    type: string
                    description: The match score for the city.
                  matchScoreState:
                    type: string
                    description: The match score for the province or state.
                  matchScorePostCode:
                    type: string
                    description: The match score for the postal code.
                  matchScoreCountry:
                    type: string
                    description: The match score for the country.
                  matchScoreVatNo:
                    type: string
                    description: The match score for the VAT number.
                  matchScoreRegNo:
                    type: string
                    description: The match score for the registration number.
                  matchScorePhoneNo:
                    type: string
                    description: The match score for the phone number.
                  matchScoreSimpleValue:
                    type: string
                    description: The match score for the simple value address.
                  matchScoreNum:
                    type: string
                    description: The match score for the numeric value.
    ConnectConfidenceMatchNoResults:
      properties:
        totalMatches:
          type: integer
        matchedCompanies:
          type: array
          items:
            type: string
    CreditsafeGlobalDataDirectorSearchData:
      type: object
      properties:
        peopleId:
          description: The unique identifier of the person.
          type: string
        firstName:
          description: The first name of the director.
          type: string
        lastName:
          description: The last name of the director.
          type: string
        country:
          description: The country of the director.
          $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
        company:
          type: object
          properties:
            id:
              description: The unique identifier of the company.
              type: string
        companyName:
          description: The name of the company.
          type: string
        companyType:
          $ref: '#/components/schemas/CreditsafeGlobalDataCompanyType'
        companyRegistrationNumber:
          description: The registration number of the company.
          type: string
        status:
          type: string
        address:
          $ref: '#/components/schemas/CreditsafeGlobalDataAddressData'
        dateOfLatestChange:
          description: The date of the latest change to the director information.
          type: string
          format: date-time
          nullable: true
        dateOfBirth:
          description: The date of birth of the director.
          type: string
          format: date-time
        localDirectorNumber:
          description: The local director number of the director.
          type: string
        score:
          type: integer
        taxCode:
          type: string
        searchRanking:
          type: string
    CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataDirectorSearchData:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataServiceResponse'
        - type: object
          properties:
            correlationId:
              type: string
            directors:
              type: array
              items:
                $ref: '#/components/schemas/CreditsafeGlobalDataDirectorSearchData'
            totalSize:
              description: The total number of results.
              type: integer
              format: int32
    CreditsafeGlobalDataReportsDirectorsDirectorSummary:
      type: object
      properties:
        currentAppointments:
          type: integer
          format: int32
        inactiveAppointments:
          type: integer
          format: int32
        previousAppointments:
          type: integer
          format: int32
    CreditsafeGlobalDataReportsDirectorsDirectorshipAdditionalData:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsAdditionalData'
        - type: object
    CreditsafeGlobalDataReportsDirectorsDirectorship:
      type: object
      properties:
        id:
          type: string
        idType:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsIdType'
        companyName:
          type: string
        companyNumber:
          type: string
        companyRegistrationNumber:
          type: string
        address:
          $ref: '#/components/schemas/CreditsafeGlobalDataAddressData'
        status:
          $ref: '#/components/schemas/CreditsafeGlobalDataCompanyStatus'
        activity:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsCompanyActivity'
        position:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCorporatePositionResigned
        signingAuthority:
          type: boolean
          nullable: true
        companyRegistrationDate:
          type: string
          format: date-time
          nullable: true
        legalForm:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsLegalForm'
        state:
          type: string
        yearEndDate:
          type: string
          format: date-time
          nullable: true
        currency:
          $ref: '#/components/schemas/CreditsafeGlobalDataCurrency'
        latestTurnoverFigure:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal
        netWorth:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal
        legalCount:
          type: integer
          format: int32
          nullable: true
        legalAmount:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal
        legalCountInLast12Months:
          type: integer
          format: int32
          nullable: true
        creditScore:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsLtdCreditScore'
        dbt:
          type: number
          format: double
          nullable: true
        additionalData:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorshipAdditionalData
    CreditsafeGlobalDataReportsDirectorsDirectorships:
      type: object
      properties:
        current:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorship
        previous:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorship
        inactive:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorship
    CreditsafeGlobalDataReportsDirectorsDirectorReport:
      type: object
      properties:
        directorId:
          type: string
        directorSummary:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorSummary
        directorDetails:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsDirector'
        otherAddresses:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataAddressData'
        directorships:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorships
    CreditsafeGlobalDataReportsDirectorsDirectorReportResponse:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataServiceResponse'
        - type: object
          properties:
            report:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReport
    ConnectImagesCompanyImages:
      type: object
      properties:
        correlationId:
          type: string
          description: >-
            Unique identifier for tracing this request, enabling tracking and
            debugging.
        totalSize:
          type: integer
          description: Total number of image records available based on the query criteria.
        data:
          type: array
          items:
            type: object
            properties:
              imageId:
                type: string
                description: >-
                  Unique identifier for the image document, allowing direct
                  retrieval and reference.
              company:
                type: object
                description: >
                  Contains information about the company associated with the
                  image. This includes identifiers, 

                  the registered country, legal type, and other basic details
                  specific to the company in question.
                properties:
                  id:
                    type: string
                    description: Unique identifier for the company.
                  localId:
                    type: string
                    description: >-
                      Company identifier specific to the country or
                      jurisdiction.
                  country:
                    type: string
                    description: >-
                      ISO code representing the country where the company is
                      registered.
                  name:
                    type: string
                    description: Official registered name of the company.
                  type:
                    type: string
                    description: >-
                      Legal structure or type of the company, such as "Ltd" for
                      limited companies.
                  additionalInformation:
                    type: object
                    properties:
                      legalGroup:
                        type: string
                        description: >-
                          Classification indicating the company's legal grouping
                          or ownership structure.
                        example: OVR
              document:
                type: object
                description: >
                  Provides details about the specific document or image
                  associated with the company, 

                  such as its type, code, and a description that may include
                  filing information or updates.
                properties:
                  imageType:
                    type: string
                    description: >-
                      Type of document image, e.g., "AnnualReturns" or
                      "ConfirmationStatement."
                  imageTypeCode:
                    type: string
                    description: >-
                      Code associated with the document type for internal or
                      regulatory identification.
                  imageTypeDescription:
                    type: string
                    description: >-
                      Detailed description of the document, often including
                      information about its contents or updates.
              filingDate:
                type: string
                format: date
                description: Date when the document was officially filed or recorded.
              startDate:
                type: string
                format: date
                description: Start date of the time period covered by the document.
              endDate:
                type: string
                format: date
                description: End date of the time period covered by the document.
              language:
                type: string
                description: >-
                  ISO language code representing the document's primary
                  language.
              consolidated:
                type: boolean
                description: >-
                  Indicates if the document contains consolidated information,
                  typically applicable to financial statements.
              publicationDate:
                type: string
                format: date-time
                description: >-
                  Date and time when the document was published or made
                  available.
              status:
                type: string
                description: >-
                  Document or image status, currently only available for
                  Netherlands `NL`.
              availableFormats:
                type: array
                items:
                  type: string
                description: >-
                  List of available formats for the image, currently only
                  available for Denmark `DK`.
              additionalInformation:
                description: >
                  Additional details about the document. Note that properties
                  within `additionalInformation` may vary depending on the
                  country.

                  Not all properties listed below are available for every
                  country, and some properties may not appear at all in certain
                  responses. 

                  Integrations should allow flexibility to handle missing or
                  variable properties.
                type: object
                properties:
                  annotations:
                    type: string
                    description: Annotations related to the image
                  barcode:
                    type: string
                    description: >-
                      Unique barcode for tracking or inventory purposes,
                      associated with the document.
                  category:
                    type: string
                    description: >-
                      Main category of the document, such as
                      "confirmation-statement."
                  descriptionValues:
                    type: object
                    description: Description values (object structure may vary by country)
                  imageStatus:
                    type: string
                    description: >-
                      Current processing status of the image, e.g., "Pending" or
                      "Completed."
                  pages:
                    type: integer
                    description: Number of pages in the document
                  paperFiled:
                    type: boolean
                    description: Indicates if the image was filed on paper
                  resolutions:
                    type: array
                    items:
                      type: string
                    description: List of resolutions related to the image
                  sourceType:
                    type: string
                    description: >-
                      Specific source or origin type for the document, providing
                      additional context (e.g.,
                      "confirmation-statement-with-no-updates").
                  subcategory:
                    type: string
                    description: >-
                      Further classification within the main category; may be
                      blank if not applicable.
                  transactionId:
                    type: string
                    description: Transaction ID related to the image
    ConnectImagesCompanyImageTypes:
      type: array
      description: >-
        List of country-specific configurations, including requirements and
        validations for company ID and image reference fields, as well as
        supported languages and filing types.
      items:
        type: object
        properties:
          country:
            type: string
            description: >-
              ISO code representing the country to which this configuration
              applies.
          companyId:
            type: object
            description: >
              Configuration details for the `companyId` field, specifying
              whether it is required 

              and any validation rules, such as minimum and maximum length and
              allowed patterns.
            properties:
              required:
                type: boolean
                description: Indicates whether a `companyId` is required for this country.
              validationRegExp:
                type: string
                description: >-
                  Regular expression for validating the `companyId` format for
                  this country.
              minLength:
                type: integer
                description: Minimum length for the `companyId`, if applicable.
              maxLength:
                type: integer
                description: Maximum length for the `companyId`, if applicable.
          imageReference:
            type: object
            description: >
              Configuration details for the `imageReference` field, specifying
              its requirement status, 

              validation rules, and length constraints for the country in
              question.
            properties:
              required:
                type: boolean
                description: >-
                  Indicates whether an `imageReference` is required for this
                  country.
              validationRegExp:
                type: string
                description: Regular expression for validating the `imageReference` format.
              minLength:
                type: integer
                description: Minimum length for the `imageReference`, if applicable.
              maxLength:
                type: integer
                description: Maximum length for the `imageReference`, if applicable.
          availableLanguages:
            type: array
            description: >-
              List of languages available for documents in this country, along
              with filing types and formats.
            items:
              type: object
              properties:
                language:
                  type: string
                  description: >-
                    Language code for documents available in this country (e.g.,
                    "EN" for English).
                filingTypes:
                  type: array
                  description: >-
                    List of filing types available in this language, with
                    supported formats.
                  items:
                    type: object
                    properties:
                      type:
                        type: string
                        description: Type of filing, such as "AnnualReport" or "Statement."
                      availableFormats:
                        type: array
                        description: >-
                          List of file formats available for this filing type
                          (e.g., "PDF" or "HTML").
                        items:
                          type: string
                default:
                  type: boolean
                  description: >-
                    Indicates if this language is the default language for
                    documents in this country.
    CreditsafeGlobalDataCoreAttachmentBinaryAttachment:
      type: string
      format: binary
    ConnectFreshInvListInvestigations:
      type: object
      properties:
        totalCount:
          type: integer
        orders:
          type: array
          items:
            type: object
            properties:
              orderID:
                type: integer
                description: Fresh Investigation Unique Identifier
              userID:
                type: string
                description: Fresh Investigation user Identifier
              creationDate:
                type: string
                description: Fresh Investigation Creation Date
              lastStatusChangeDate:
                type: string
                description: Fresh Investigation Last Status Change Date
              transactionID:
                type: integer
                description: Fresh Investigation Internal Identifier
              chargeReference:
                type: string
              contactDetails:
                type: object
                description: >-
                  Contact details of the person who requested the investigation,
                  and where the information will be sent.
                properties:
                  name:
                    type: string
                    description: Contact name of the person who requested the investigation
                  emailAddress:
                    type: string
                    description: The address to which the investigation report will be sent
                  telephoneNumber:
                    type: string
                    description: Your telephone number
              sectionNames:
                type: string
              status:
                type: object
                description: The status of the investigation
                properties:
                  code:
                    type: string
                  description:
                    type: string
              consent:
                type: boolean
                description: >-
                  Whether permission was granted by the requesting company to
                  disclose the identity of the investigating party to the target
                  company.
              searchCriteria:
                type: object
                description: The search criteria used to perform the investigation
                properties:
                  name:
                    type: string
                    description: Target company name
                  vatNo:
                    type: string
                  regNo:
                    type: string
                  additionalInfo:
                    type: string
                  address:
                    $ref: '#/components/schemas/CreditsafeGlobalDataAddressData'
              reportDate:
                type: string
                format: date-time
    ConnectFreshInvCreateInvestigation:
      type: object
      properties:
        consent:
          type: boolean
          description: >-
            Including this allows Creditsafe to disclose your company details to
            the target company in the aim of improving the quality of our
            Investigation Report
        contactInfo:
          description: Your contact information
          type: object
          properties:
            name:
              type: string
              description: Your name
              nullable: false
            emailAddress:
              type: string
              description: The address where Investigation creation confirmations are sent
              nullable: false
            telephoneNumber:
              type: string
              description: Your contact number
              nullable: true
            company:
              type: object
              description: your company information
              properties:
                name:
                  type: string
                  description: Your company name
                  nullable: false
                number:
                  type: string
                  nullable: false
                  description: Your company VAT number/Reg Number/Tax Number
        chargeReference:
          type: string
          description: Free text field to add your own personal reference to the order
        searchCriteria:
          type: object
          description: Details on the company you are investigating - the target company
          properties:
            name:
              type: string
              description: Target company name
              nullable: false
            additionalInfo:
              type: string
              description: >-
                Any further details on your target company that will assist our
                Investigation
              nullable: true
            telephoneNumber:
              type: string
              description: Target company telephone number
              nullable: true
            address:
              type: object
              description: Target company address
              nullable: true
              properties:
                simple:
                  type: string
                postcode:
                  type: string
                city:
                  type: string
            regNo:
              type: string
              description: Target company registration number
              nullable: true
            vatNo:
              type: string
              description: Target company VAT number
              nullable: true
            countryCode:
              type: string
              description: Target company ISO2 country code
              nullable: false
    ConnectFreshInvInvestigationConfirmed:
      type: object
      properties:
        correlationId:
          type: string
          description: A unique ID assigned to this request.
        message:
          type: string
        orderID:
          type: string
          description: Fresh Investigation Unique Identifier
        transactionID:
          type: string
          description: Fresh Investigation Internal Identifier
    ConnectFreshInvCompletedInvestigation:
      type: object
      properties:
        chargeReference:
          type: string
        contactDetails:
          properties:
            emailAddress:
              type: string
            name:
              type: string
            telephoneNumber:
              type: string
          type: object
        creationDate:
          type: string
        lastStatusChangeDate:
          type: string
        orderID:
          type: integer
        reportDate:
          type: string
        searchCriteria:
          properties:
            additionalInfo:
              type: string
            address:
              properties:
                city:
                  type: string
                postcode:
                  type: string
                simple:
                  type: string
              type: object
            countryCode:
              type: string
            name:
              type: string
            regNo:
              type: string
            vatNo:
              type: string
          type: object
        sections:
          items:
            anyOf:
              - properties:
                  content:
                    type: string
                  contentType:
                    type: string
                  creationDate:
                    type: string
                  name:
                    type: string
                type: object
          type: array
        status:
          properties:
            code:
              type: string
            description:
              type: string
          type: object
        transactionID:
          type: integer
    DeleteFreshInvetigationsByOrderId:
      type: object
      properties:
        message:
          type: string
    ConnectFreshInvInvestigationContactInfo:
      description: Your contact information
      type: object
      additionalProperties: false
      properties:
        name:
          type: string
          description: Your name
          nullable: false
        emailAddress:
          type: string
          description: The address where Investigation creation confirmations are sent
          nullable: false
        telephoneNumber:
          type: string
          description: Your contact number
          nullable: true
        company:
          type: object
          additionalProperties: false
          description: your company information
          properties:
            name:
              type: string
              description: Your company name
              nullable: false
            number:
              type: string
              nullable: false
              description: Your company VAT number/Reg Number/Tax Number
    ConnectFreshInvInvestigationCompanyData:
      type: object
      additionalProperties: false
      description: Details on the company.
      properties:
        name:
          type: string
          description: Company name.
        additionalInfo:
          type: string
          description: Further details on the company.
        telephoneNumber:
          type: string
          description: Company telephone number
        address:
          type: object
          additionalProperties: false
          description: Company address
          properties:
            simple:
              type: string
            postcode:
              type: string
            city:
              type: string
        regNo:
          type: string
          description: Company registration number
        vatNo:
          type: string
          description: Company VAT number
        countryCode:
          $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
    ConnectUpdateFreshInvestigation:
      type: object
      additionalProperties: false
      properties:
        consent:
          type: boolean
          description: >-
            Including this allows Creditsafe to disclose your company details to
            the target company in the aim of improving the quality of our
            Investigation Report
        contactInfo:
          $ref: '#/components/schemas/ConnectFreshInvInvestigationContactInfo'
        chargeReference:
          type: string
          description: Free text field to add your own personal reference to the order
        searchCriteria:
          $ref: '#/components/schemas/ConnectFreshInvInvestigationCompanyData'
        pendingInfo:
          type: object
          description: >-
            PendingInfo property contains the information of respective
            sections, that someone has requested respective information to be
            modified.
          properties:
            contactDetails:
              description: Your Contact details of fresh investigation for updating.
              $ref: '#/components/schemas/ConnectFreshInvInvestigationContactInfo'
            searchCriteria:
              description: Search criteria details of the company.
              $ref: '#/components/schemas/ConnectFreshInvInvestigationCompanyData'
    FreshInvestigationGetAttachmentsForOrderResponse:
      description: Attachments for the fresh investigation order
      type: object
      additionalProperties: false
      properties:
        correlationId:
          type: string
          description: A unique ID assigned to this request.
        Attachments:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              fileName:
                type: string
              fileType:
                type: string
              description:
                type: string
    FreshInvestigationAttachmentUploadForOrderRequest:
      type: object
      additionalProperties: false
      properties:
        importFile:
          type: string
          format: binary
          description: The file which we want to attach to the fresh investigation order
        description:
          type: string
          description: >-
            Description of the file which we want to attach to the fresh
            investigation order
    FreshInvestigationAttachmentUploadForOrderResponse:
      description: Attachment upload status for the order
      type: object
      additionalProperties: false
      properties:
        correlationId:
          type: string
          description: A unique ID assigned to this request.
        message:
          type: string
        details:
          type: string
    CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment:
      type: string
      format: binary
    GetFreshInvestigationCommentsByOrderIdResponse:
      type: object
      properties:
        totalCount:
          type: integer
          description: Total number of comments for a FreshInvestigation Report
        comments:
          type: array
          items:
            type: object
            properties:
              userID:
                type: string
                example: CSC_123456
                description: user id
              comment:
                type: string
                example: testing comments
                description: comments about the FreshInvestigation Report
              creationDate:
                type: string
                example: '2023-03-10T05:44:06.000Z'
                description: The time when comment has been posted.
    FreshInvestigationCommentsForOrderRequest:
      type: object
      additionalProperties: false
      properties:
        comments:
          description: comments for fresh investigation orderId
          type: string
    FreshInvestigationCommentsForOrderResponse:
      description: comments for the fresh investigation orderId
      type: object
      additionalProperties: false
      properties:
        correlationId:
          type: string
          description: A unique ID assigned to this request.
        message:
          type: string
  parameters:
    page:
      name: page
      in: query
      description: Starting page number.
      schema:
        type: integer
        default: 1
    pageSize:
      name: pageSize
      in: query
      description: Number of items to return per Page.
      schema:
        type: integer
    sortDir:
      name: sortDir
      in: query
      description: The direction that you wish to sort results by.
      schema:
        type: string
        default: asc
        enum:
          - asc
          - desc
security:
  - bearerToken: []
