openapi: 3.0.3
info:
  title: Rankiteo API
  description: The Rankiteo API
  termsOfService: https://policies.gitbook.com
  contact:
    name: API Support
    url: https://gitbook.com/support
    email: support@rankiteo.com
  version: 0.0.1-beta
servers:
  - url: https://api.rankiteo.com
    description: production
components:
  securitySchemes:
    KeyAuth:
      type: apiKey
      name: apikey
      in: header
security:
  - KeyAuth: []
paths:
  /general-getdomain-by-linkedinid:
    get:
      summary: Get specific domain by linkedin id
      tags:
        - General
      description: Domain by linkedin id
      parameters:
        - name: linkedin_id
          in: query
          required: true
          description: LinkedIn identifier for the target company
          schema:
            type: string
            example: google
      responses:
        '200':
          description: Successful response containing domain information
          content:
            application/json:
              schema:
                type: object
                properties:
                  linkedin_id:
                    type: string
                    example: google
                  company_name:
                    type: string
                    example: Google
                  website:
                    type: string
                    example: https://goo.gle/3DLEokh
                  domain:
                    type: string
                    example: goo.gle
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                invalid_linkedin_id:
                  summary: Invalid Linkedin Id
                  value:
                    error: >-
                      LinkedIn ID not valid. Please check and provide a valid
                      LinkedIn ID
                linkedin_id_not_found:
                  summary: Linkedin Id not found
                  value:
                    error: >-
                      This linkedin id has not been processed yet by our system,
                      but the scan will start soon
                required_params:
                  summary: Linkedin Id is a required parameter
                  value:
                    error: Linkedin Id is a required parameter
                invalid_request:
                  summary: Invalid request
                  value:
                    error: Invalid request
        '401':
          description: API key related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /general-getlinkedinid-by-companyname:
    get:
      summary: Get linkedin id based on company name
      tags:
        - General
      description: Linkedin Id by company name
      parameters:
        - name: company_name
          in: query
          required: true
          description: Company name identifier for the target company
          schema:
            type: string
            example: Google
        - name: page
          in: query
          required: false
          schema:
            type: integer
            description: Page number
            example: 1
      responses:
        '200':
          description: Successful response containing LinkedIn ID and company name
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        company_name:
                          type: string
                          example: >-
                            ICEI - Istituto Cooperazione Economica
                            Internazionale
                        linkedin_id:
                          type: string
                          example: icei
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      page_size:
                        type: integer
                        example: 10
                      total_pages:
                        type: integer
                        example: 2112
                      total_items:
                        type: integer
                        example: 21116
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                required_params:
                  summary: Required parameter
                  value:
                    error: company_name is a required parameter
                not_found:
                  summary: Company not found
                  value:
                    error: Company not found
                invalid_page:
                  summary: Invalid Page
                  value:
                    error: Page value should be greater than 0
                invalid_request:
                  summary: Invalid request
                  value:
                    error: Invalid request
        '401':
          description: API key related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /general-getlinkedinid-by-domain:
    get:
      summary: Get specific linkedin id by domain
      tags:
        - General
      description: Linkedin Id by domain
      parameters:
        - name: domain
          in: query
          required: true
          description: Domain name
          schema:
            type: string
            example: rankiteo.com
      responses:
        '200':
          description: Successful response containing LinkedIn ID
          content:
            application/json:
              schema:
                type: object
                properties:
                  linkedin_id:
                    type: string
                    example: rankiteo
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                domain_not_found:
                  summary: Domain not found
                  value:
                    error: Domain not found
                required_params:
                  summary: Domain is a required parameter
                  value:
                    error: domain is a required parameter
                invalid_domain:
                  summary: Invalid domain
                  value:
                    error: >-
                      Invalid domain. Please check and provide a valid LinkedIn
                      ID
                invalid_request:
                  summary: Invalid request
                  value:
                    error: Invalid request
                not_found:
                  summary: Linkedin id not found
                  value:
                    error: Linkedin id not found
        '401':
          description: API key related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /monitor-getcompanyapplicationsassets:
    get:
      summary: Get company applications assets
      tags:
        - Monitor
      description: Company asset informations
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            description: Page number
            example: 1
      responses:
        '200':
          description: >-
            Successful response containing company information, applications,
            and pagination data
          content:
            application/json:
              schema:
                type: object
                properties:
                  linkedin_id:
                    type: string
                    description: Unique identifier for the company on LinkedIn
                    example: google
                  company_name:
                    type: string
                    description: The official name of the company
                    example: Google
                  website:
                    type: string
                    description: Official website URL of the company
                    example: https://goo.gle/3DLEokh
                  industry:
                    type: string
                    description: Industry category of the company
                    example: Software Development
                  description:
                    type: string
                    description: A brief description of the company and its mission
                    example: >-
                      A problem isn't truly solved until it's solved for all.
                      Googlers build products that help create opportunities for
                      everyone
                  number_of_applications:
                    type: integer
                    description: >-
                      Total number of applications or technologies identified as
                      being used by the company
                    example: 2241
                  applications:
                    type: array
                    description: >-
                      List of applications and technologies associated with the
                      company
                    items:
                      type: object
                      properties:
                        subdomain:
                          type: string
                          description: Subdomain of the application or technology
                          example: hivemint.xyz
                        domain:
                          type: string
                          description: >-
                            Main domain associated with the application or
                            technology
                          example: withgoogle.com
                        technology_name:
                          type: string
                          description: Name of the technology or application used
                          example: Node.js
                        technology_cpe:
                          type: string
                          description: >-
                            Common Platform Enumeration (CPE) identifier for the
                            technology
                          example: cpe:/a:nodejs:node.js
                        confidence:
                          type: integer
                          description: >-
                            Confidence level of the identification accuracy,
                            represented as a percentage
                          example: 100
                        category_id:
                          type: array
                          description: >-
                            List of IDs representing the category of the
                            technology
                          items:
                            type: integer
                          example:
                            - 27
                        category_name:
                          type: array
                          description: >-
                            List of category names corresponding to each
                            category ID
                          items:
                            type: string
                          example:
                            - Programming languages
                        version:
                          type: string
                          description: Version of the technology or application
                          example: Python
                        website:
                          type: string
                          description: Official website of the technology or application
                          example: http://nodejs.org
                  pagination:
                    type: object
                    description: Information about the pagination of results
                    properties:
                      current_page:
                        type: integer
                        description: The current page of the result set
                        example: 1
                      page_size:
                        type: integer
                        description: Number of items per page
                        example: 2
                      total_pages:
                        type: integer
                        description: Total number of pages available
                        example: 1
                      total_items:
                        type: integer
                        description: Total number of items in the result set
                        example: 2
                  message:
                    type: string
                    example: No data available
              examples:
                with_data:
                  summary: Response with data
                  value:
                    linkedin_id: google
                    company_name: Google
                    website: https://goo.gle/3DLEokh
                    industry: Software Development
                    description: A problem isn't truly solved until it's solved for all
                    number_of_applications: 2241
                    applications:
                      - subdomain: hivemint.xyz
                        domain: withgoogle.com
                        technology_name: Node.js
                        confidence: 100
                        category_id:
                          - 27
                        category_name:
                          - Programming languages
                        version: '-'
                        website: http://nodejs.org
                    pagination:
                      current_page: 1
                      page_size: 10
                      total_pages: 10
                      total_items: 100
                no_data:
                  summary: Response with message only
                  value:
                    message: No data available
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                company_not_found:
                  summary: Company not found
                  value:
                    error: Not able to find any company associated with your account
                invalid_page:
                  summary: Invalid Page
                  value:
                    error: Page value should be greater than 0
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the monitoring plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /monitor-getcompanyinfo:
    get:
      summary: Get company details
      tags:
        - Monitor
      description: Company information
      responses:
        '200':
          description: Company information response
          content:
            application/json:
              schema:
                type: object
                properties:
                  linkedin_id:
                    type: string
                    description: LinkedIn identifier for the company
                    example: google
                  company_name:
                    type: string
                    description: Name of the company
                    example: Google
                  website:
                    type: string
                    format: uri
                    description: Website URL of the company
                    example: https://goo.gle/3DLEokh
                  industry:
                    type: string
                    description: Industry the company operates in
                    example: Software Development
                  description:
                    type: string
                    description: Company description
                    example: >-
                      A problem isn't truly solved until it's solved for all.
                      Googlers build products that help create opportunities for
                      everyone, whether down the street or across the globe
                  company_id:
                    type: string
                    description: Unique company identifier
                    example: GOO_2660260
                  crunchbase_id:
                    type: string
                    format: uri
                    description: URL to Crunchbase profile for the company
                    example: >-
                      https://www.crunchbase.com/organization/google/funding_rounds/funding_rounds_list
                  employees_number:
                    type: string
                    description: Total number of employees in the company
                    example: 300967 employees
                  followers_number:
                    type: integer
                    description: Total number of LinkedIn followers
                    example: 34225598
                  score:
                    type: number
                    format: float
                    description: Company score based on internal criteria
                    example: 410.42
                  naics_code:
                    type: string
                    description: NAICS code associated with the company's industry
                    example: 511
                  searched_by:
                    type: integer
                    description: Number of searches or views related to this company
                    example: 8
                  subsidiaries_list:
                    type: array
                    items:
                      type: string
                    description: >-
                      List of subsidiaries or associated entities under the
                      company
                    example:
                      - Adometry (acquired by Google)
                      - Android
                      - Google Cloud
                      - YouTube
                  ip_addresses:
                    type: integer
                    description: Number of IP addresses associated with the company
                    example: 1600
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                company_not_found:
                  summary: Company Not Found
                  value:
                    error: Not able to find any company associated with your account
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the monitoring plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /monitor-getcompanyinfrastructureassets:
    get:
      summary: Get company infrastructure assets
      tags:
        - Monitor
      description: Company infrastructure assets
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            description: Page number
            example: 1
      responses:
        '200':
          description: >-
            Successful response containing company information, network
            endpoints, and pagination data
          content:
            application/json:
              schema:
                type: object
                properties:
                  linkedin_id:
                    type: string
                    description: Unique identifier for the company on LinkedIn
                    example: google
                  company_name:
                    type: string
                    description: The official name of the company
                    example: Google
                  website:
                    type: string
                    description: Official website URL of the company
                    example: https://goo.gle/3DLEokh
                  industry:
                    type: string
                    description: Industry category of the company
                    example: Software Development
                  description:
                    type: string
                    description: A brief description of the company and its mission
                    example: >-
                      A problem isn't truly solved until it's solved for all.
                      Googlers build products that help create opportunities for
                      everyone
                  number_of_infrastructure_endpoint:
                    type: integer
                    description: >-
                      Total number of network endpoints associated with the
                      company's infrastructure
                    example: 1600
                  network_endpoints:
                    type: array
                    description: List of network endpoints used by the company
                    items:
                      type: object
                      properties:
                        ip:
                          type: string
                          description: IP address of the network endpoint
                          example: 76.76.21.21
                        identified_product:
                          type: string
                          description: >-
                            Product or service identified to be hosted at this
                            endpoint
                          example: AMAZON-02
                        subdomain:
                          type: string
                          description: Subdomain of the network endpoint
                          example: fransandi.com
                        domain:
                          type: string
                          description: Main domain of the network endpoint
                          example: flutter.dev
                        isp:
                          type: string
                          description: >-
                            Internet Service Provider associated with the
                            endpoint
                          example: Amazon.com, Inc
                        services:
                          type: array
                          description: List of services hosted at this endpoint
                          items:
                            type: string
                          example:
                            - Hosting
                        orgination:
                          type: string
                          description: Organization managing or operating the endpoint
                          example: Vercel, Inc
                        region_name:
                          type: string
                          description: Name of the region where the endpoint is located
                          example: California
                        country:
                          type: string
                          description: Country where the endpoint is located
                          example: United States
                        continent:
                          type: string
                          description: Continent where the endpoint is located
                          example: North America
                        country_code:
                          type: string
                          description: >-
                            ISO code of the country where the endpoint is
                            located
                          example: US
                        zip:
                          type: string
                          description: Zip code of the endpoint’s location
                          example: 91789
                  pagination:
                    type: object
                    description: Information about the pagination of results
                    properties:
                      current_page:
                        type: integer
                        description: The current page of the result set
                        example: 1
                      page_size:
                        type: integer
                        description: Number of items per page
                        example: 2
                      total_pages:
                        type: integer
                        description: Total number of pages available
                        example: 1
                      total_items:
                        type: integer
                        description: Total number of items in the result set
                        example: 2
                  message:
                    type: string
                    example: No data available
              examples:
                with_data:
                  summary: Response with data
                  value:
                    linkedin_id: google
                    company_name: Google
                    website: https://goo.gle/3DLEokh
                    industry: Software Development
                    description: A problem isn't truly solved until it's solved for all
                    number_of_infrastructure_endpoint: 2241
                    network_endpoints:
                      - ip: 76.76.21.21
                        identified_product: AMAZON-02
                        subdomain: fransandi.com
                        domain: flutter.dev
                        isp: Amazon.com, Inc.
                        services:
                          - Hosting
                        orgination: Vercel, Inc
                        region_name: California
                        country: United States
                        continent: North America
                        country_code: US
                        zip: '91789'
                    pagination:
                      current_page: 1
                      page_size: 10
                      total_pages: 10
                      total_items: 100
                no_data:
                  summary: Response with message only
                  value:
                    message: No data available
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                company_not_found:
                  summary: Company not found
                  value:
                    error: Not able to find any company associated with your account
                invalid_page:
                  summary: Invalid Page
                  value:
                    error: Page value should be greater than 0
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the monitoring plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /monitor-getcompanysbom:
    get:
      summary: Get company SBOM data
      tags:
        - Monitor
      description: Company SBOM data includes technology information
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            description: Page number
            example: 1
      responses:
        '200':
          description: >-
            Successful response containing subdomains and technology information
            or a message
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        domain_name:
                          type: string
                          example: x.company
                        subdomain:
                          type: array
                          items:
                            type: object
                            properties:
                              subdomain_name:
                                type: string
                                example: conscrypt.org
                              data:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    technology_name:
                                      type: string
                                      example: Bootstrap
                                    technology_version:
                                      type: string
                                      example: 3.3.7
                                    cve_number:
                                      type: array
                                      items:
                                        type: string
                                        example: CVE-2023-5317
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      page_size:
                        type: integer
                        example: 10
                      total_pages:
                        type: integer
                        example: 10
                      total_items:
                        type: integer
                        example: 100
                  message:
                    type: string
                    example: No SBOM vulnerability found
              examples:
                with_data:
                  summary: Response with data
                  value:
                    data:
                      - domain_name: x.company
                        subdomain:
                          - subdomain_name: conscrypt.org
                            data:
                              - technology_name: Bootstrap
                                technology_version: 3.3.7
                                cve_number:
                                  - CVE-2023-5317
                    pagination:
                      current_page: 1
                      page_size: 10
                      total_pages: 10
                      total_items: 100
                    message: Data fetched successfully
                no_data:
                  summary: Response with message only
                  value:
                    message: No SBOM vulnerability found
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                company_not_found:
                  summary: Company not found
                  value:
                    error: Not able to find any company associated with your account
                invalid_page:
                  summary: Invalid Page
                  value:
                    error: Page value should be greater than 0
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the monitoring plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /monitor-getcompanysbomcve:
    get:
      summary: Get company SBOM data with CVE
      tags:
        - Monitor
      description: Company SBOM data includes technology information with cve
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            description: Page number
            example: 1
      responses:
        '200':
          description: >-
            Successful response containing subdomains and technology information
            or a message
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        domain_name:
                          type: string
                          example: x.company
                        subdomain:
                          type: array
                          items:
                            type: object
                            properties:
                              subdomain_name:
                                type: string
                                example: conscrypt.org
                              data:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    technology_name:
                                      type: string
                                      example: Bootstrap
                                    technology_version:
                                      type: string
                                      example: 3.3.7
                                    cve_number:
                                      type: array
                                      items:
                                        type: string
                                        example: CVE-2023-5317
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      page_size:
                        type: integer
                        example: 10
                      total_pages:
                        type: integer
                        example: 10
                      total_items:
                        type: integer
                        example: 100
                  message:
                    type: string
                    example: No SBOM vulnerability found
              examples:
                with_data:
                  summary: Response with data
                  value:
                    data:
                      - domain_name: x.company
                        subdomain:
                          - subdomain_name: conscrypt.org
                            data:
                              - technology_name: Bootstrap
                                technology_version: 3.3.7
                                cve_number:
                                  - CVE-2023-5317
                    pagination:
                      current_page: 1
                      page_size: 10
                      total_pages: 10
                      total_items: 100
                    message: Data fetched successfully
                no_data:
                  summary: Response with message only
                  value:
                    message: No SBOM vulnerability found
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                company_not_found:
                  summary: Company not found
                  value:
                    error: Not able to find any company associated with your account
                invalid_page:
                  summary: Invalid Page
                  value:
                    error: Page value should be greater than 0
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the monitoring plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /monitor-getcompanysbomdomain:
    get:
      summary: Get company SBOM data by domain
      tags:
        - Monitor
      description: Company SBOM data includes technology information
      parameters:
        - name: domain
          in: query
          required: true
          description: domain of company
          schema:
            type: string
            example: google.com
        - name: page
          in: query
          required: false
          schema:
            type: integer
            description: Page number
            example: 1
      responses:
        '200':
          description: >-
            Successful response containing subdomains and technology information
            or a message
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      domain_name:
                        type: string
                        example: google.com
                      subdomain:
                        type: array
                        items:
                          type: object
                          properties:
                            subdomain_name:
                              type: string
                              example: googleplus.com
                            data:
                              type: array
                              items:
                                type: object
                                properties:
                                  technology_name:
                                    type: string
                                    example: jQuery
                                  technology_version:
                                    type: string
                                    example: 1.11.3
                                  cve_number:
                                    type: array
                                    items:
                                      type: string
                                      example: CVE-2022-1537
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      page_size:
                        type: integer
                        example: 10
                      total_pages:
                        type: integer
                        example: 3
                      total_items:
                        type: integer
                        example: 23
                  message:
                    type: string
                    example: No SBOM vulnerability found
              examples:
                with_data:
                  summary: Response with detailed data
                  value:
                    data:
                      domain_name: google.com
                      subdomain:
                        - subdomain_name: googleplus.com
                          data:
                            - technology_name: jQuery
                              technology_version: 1.11.3
                              cve_number:
                                - CVE-2022-1537
                    pagination:
                      current_page: 1
                      page_size: 10
                      total_pages: 3
                      total_items: 23
                no_vulnerability:
                  summary: No vulnerability
                  value:
                    data:
                      domain_name: google.com
                      message: No SBOM vulnerability found
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                invalid_domain:
                  summary: Invalid domain
                  value:
                    error: Invalid domain. Please check and provide a valid domain
                domain_associate_issue:
                  summary: Domain association
                  value:
                    error: Required domain does not belong to linkedin id
                required_param_domain:
                  summary: domain is a required parameter
                  value:
                    error: domain is a required parameter
                company_not_found:
                  summary: Company not found
                  value:
                    error: >-
                      Not able to find any company and its domain associated
                      with your account
                invalid_page:
                  summary: Invalid Page
                  value:
                    error: Page value should be greater than 0
                invalid_request:
                  summary: Invalid request
                  value:
                    error: Invalid request
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the monitoring plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /monitor-getcompanyscores:
    get:
      summary: Get company global scoring
      tags:
        - Monitor
      description: Company scoring without subsidiaries
      responses:
        '200':
          description: Successful response with LinkedIn company profile information
          content:
            application/json:
              schema:
                type: object
                properties:
                  linkedin_id:
                    type: string
                    example: google
                    description: LinkedIn ID of the company
                  company_name:
                    type: string
                    example: Google
                    description: Name of the company
                  website:
                    type: string
                    format: uri
                    example: https://goo.gle/3DLEokh
                    description: Company's website URL
                  industry:
                    type: string
                    example: Software Development
                    description: Industry type
                  description:
                    type: string
                    example: A problem isn't truly solved until it's solved for all
                    description: Company description
                  subsidiaries_number:
                    type: integer
                    example: 46
                    description: Number of subsidiaries
                  score:
                    type: object
                    properties:
                      spf:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: C
                          number:
                            type: number
                            format: float
                            example: 71.39
                      dkim:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: C
                          number:
                            type: number
                            format: float
                            example: 85.74
                      certificate_conf:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: E
                          number:
                            type: number
                            format: float
                            example: 48.62
                      certificate_info:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: E
                          number:
                            type: number
                            format: float
                            example: 11.09
                      open_ports:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: C
                          number:
                            type: number
                            format: float
                            example: 39.07
                      web_headers:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: E
                          number:
                            type: number
                            format: float
                            example: 18.22
                      dmarc:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: D
                          number:
                            type: number
                            format: float
                            example: 68.39
                      it_standardization:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: E
                          number:
                            type: number
                            format: float
                            example: 3.81
                      digitalization:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: E
                          number:
                            type: number
                            format: float
                            example: 3.81
                      certificate_cve:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: E
                          number:
                            type: number
                            format: float
                            example: 9.14
                      vulnerabilities:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: D
                          number:
                            type: number
                            format: float
                            example: 47.15
                      sbom:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: F
                          number:
                            type: number
                            format: float
                            example: 1.4
                  message:
                    type: string
                    example: No data available
              examples:
                with_data:
                  summary: Response with data
                  value:
                    linkedin_id: google
                    company_name: Google
                    website: https://goo.gle/3DLEokh
                    industry: Software Development
                    description: A problem isn't truly solved until it's solved for all
                    subsidiaries_number: 0
                    score:
                      spf:
                        letter: C
                        number: 71.39
                      dkim:
                        letter: C
                        number: 85.74
                      certificate_conf:
                        letter: E
                        number: 48.62
                      certificate_info:
                        letter: E
                        number: 11.52
                      open_ports:
                        letter: C
                        number: 39.07
                      web_headers:
                        letter: E
                        number: 19.79
                      dmarc:
                        letter: D
                        number: 68.39
                      it_standardization:
                        letter: F
                        number: 2.87
                      digitalization:
                        letter: F
                        number: 2.87
                      certificate_cve:
                        letter: E
                        number: 9.14
                      vulnerabilities:
                        letter: D
                        number: 48.35
                      sbom:
                        letter: F
                        number: 1.4
                no_data:
                  summary: Response with message only
                  value:
                    message: No data available
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                company_not_found:
                  summary: Company Not Found
                  value:
                    error: Not able to find any company associated with your account
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the monitoring plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /monitor-getcompanystats:
    get:
      summary: Get company statistics data
      tags:
        - Monitor
      description: Company stats with all subsidiaries
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            description: Page number
            example: 1
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  parent_linkedin_id:
                    type: string
                    example: google
                  subsidiaries_stats:
                    type: array
                    items:
                      type: object
                      properties:
                        linkedin_id:
                          type: string
                          example: adometry
                        company_name:
                          type: string
                          example: Adometry (acquired by Google)
                        company_domain:
                          type: string
                          example: google.com
                        finding_stats:
                          type: object
                          properties:
                            nb_good:
                              type: integer
                              example: 54902
                            nb_warning:
                              type: integer
                              example: 2174
                            nb_bad:
                              type: integer
                              example: 9182
                            nb_neutral:
                              type: integer
                              example: 1808
                        peer_stats:
                          type: object
                          properties:
                            inside_top25_percentile:
                              type: string
                              example: 'yes'
                            inside_between_top25_and_top50_percentile:
                              type: string
                              example: 'no'
                            inside_between_low25_and_low50_percentile:
                              type: string
                              example: 'no'
                            inside_low25_percentile:
                              type: string
                              example: 'no'
                        last_6_month:
                          type: object
                          additionalProperties:
                            type: object
                            properties:
                              month_year:
                                type: string
                                example: Nov 2024
                              value:
                                type: integer
                                example: 128
                              difference:
                                type: string
                                example: '128'
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 2
                      page_size:
                        type: integer
                        example: 1
                      total_pages:
                        type: integer
                        example: 46
                      total_items:
                        type: integer
                        example: 46
                  message:
                    type: string
                    example: No data available
              examples:
                with_data:
                  summary: Response with data
                  value:
                    parent_linkedin_id: apple
                    subsidiaries_stats:
                      - linkedin_id: apple
                        company_name: Apple
                        company_domain: apple.com
                        finding_stats:
                          nb_good: 180022
                          nb_warning: 7912
                          nb_bad: 15581
                          nb_neutral: 4525
                        peer_stats:
                          inside_top25_percentile: 'yes'
                          inside_between_top25_and_top50_percentile: 'no'
                          inside_between_low25_and_low50_percentile: 'no'
                          inside_low25_percentile: 'no'
                        last_6_month:
                          '1':
                            month_year: Nov 2024
                            value: 556
                            difference: '0'
                          '2':
                            month_year: Oct 2024
                            value: 556
                            difference: '0'
                          '3':
                            month_year: Sep 2024
                            value: 556
                            difference: '22'
                          '4':
                            month_year: Aug 2024
                            value: 534
                            difference: '-8'
                          '5':
                            month_year: Jul 2024
                            value: 542
                            difference: '-51'
                          '6':
                            month_year: Jun 2024
                            value: 593
                            difference: '14'
                    pagination:
                      current_page: 1
                      page_size: 1
                      total_pages: 1
                      total_items: 1
                no_data:
                  summary: Response with message only
                  value:
                    message: No data available
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                company_not_found:
                  summary: Company not found
                  value:
                    error: Not able to find any company associated with your account
                invalid_page:
                  summary: Invalid Page
                  value:
                    error: Page value should be greater than 0
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the monitoring plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /monitor-getcompanysubscores:
    get:
      summary: Get company scoring including subsidiaries
      tags:
        - Monitor
      description: Company scoring with all subsidiaries
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            description: Page number
            example: 1
      responses:
        '200':
          description: Successful response containing LinkedIn ID and subsidiaries' scores
          content:
            application/json:
              schema:
                type: object
                properties:
                  linkedin_id:
                    type: string
                    example: google
                  subsidiaries_scores:
                    type: array
                    items:
                      type: object
                      properties:
                        linkedin_id:
                          type: string
                          example: google
                        company_name:
                          type: string
                          example: Google
                        website:
                          type: string
                          example: https://goo.gle/3DLEokh
                        industry:
                          type: string
                          example: Software Development
                        description:
                          type: string
                          example: >-
                            A problem isn't truly solved until it's solved for
                            all
                        score:
                          type: object
                          properties:
                            spf:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: C
                                number:
                                  type: number
                                  format: float
                                  example: 71.39
                            dkim:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: C
                                number:
                                  type: number
                                  format: float
                                  example: 85.74
                            certificate_conf:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: E
                                number:
                                  type: number
                                  format: float
                                  example: 48.62
                            certificate_info:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: E
                                number:
                                  type: number
                                  format: float
                                  example: 11.09
                            open_ports:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: C
                                number:
                                  type: number
                                  format: float
                                  example: 39.07
                            web_headers:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: E
                                number:
                                  type: number
                                  format: float
                                  example: 18.22
                            dmarc:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: D
                                number:
                                  type: number
                                  format: float
                                  example: 68.39
                            it_standardization:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: E
                                number:
                                  type: number
                                  format: float
                                  example: 3.81
                            digitalization:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: E
                                number:
                                  type: number
                                  format: float
                                  example: 3.81
                            certificate_cve:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: E
                                number:
                                  type: number
                                  format: float
                                  example: 9.14
                            vulnerabilities:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: D
                                number:
                                  type: number
                                  format: float
                                  example: 47.15
                            sbom:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: F
                                number:
                                  type: number
                                  format: float
                                  example: 1.4
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      page_size:
                        type: integer
                        example: 1
                      total_pages:
                        type: integer
                        example: 1
                      total_items:
                        type: integer
                        example: 1
                  message:
                    type: string
                    example: No data available
              examples:
                with_data:
                  summary: Response with data
                  value:
                    linkedin_id: apple
                    subsidiaries_scores:
                      - linkedin_id: apple
                        company_name: Apple
                        website: http://www.apple.com/careers
                        industry: Computers and Electronics Manufacturing
                        description: >-
                          We’re a diverse collective of thinkers and doers,
                          continually reimagining what’s possible to help us all
                          do what we love in new ways
                        score:
                          spf:
                            letter: A
                            number: 120.69
                          dkim:
                            letter: E
                            number: 72.65
                          certificate_conf:
                            letter: F
                            number: 12.6
                          certificate_info:
                            letter: F
                            number: 2.8
                          open_ports:
                            letter: F
                            number: 21.28
                          web_headers:
                            letter: F
                            number: 7
                          dmarc:
                            letter: A
                            number: 172.41
                          it_standardization:
                            letter: B
                            number: 14.37
                          digitalization:
                            letter: A
                            number: 17.24
                          certificate_cve:
                            letter: F
                            number: 4.2
                          vulnerabilities:
                            letter: A
                            number: 103.45
                          sbom:
                            letter: F
                            number: 5.04
                    pagination:
                      current_page: 1
                      page_size: 1
                      total_pages: 1
                      total_items: 1
                no_data:
                  summary: Response with message only
                  value:
                    message: No data available
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                company_not_found:
                  summary: Company not found
                  value:
                    error: Not able to find any company associated with your account
                invalid_page:
                  summary: Invalid Page
                  value:
                    error: Page value should be greater than 0
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the monitoring plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /monitor-getcompanysubsidiaries:
    get:
      summary: Get company subsidiaries
      tags:
        - Monitor
      description: Company subsidiaries information
      responses:
        '200':
          description: Successful response with company profile information
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    linkedin_id:
                      type: string
                      example: google
                      description: LinkedIn ID of the company
                    company_name:
                      type: string
                      example: Google
                      description: Name of the company
                    website:
                      type: string
                      format: uri
                      example: https://goo.gle/3DLEokh
                      description: Company's website URL
                    industry:
                      type: string
                      example: Software Development
                      description: Industry type of the company
                    description:
                      type: string
                      example: A problem isn't truly solved until it's solved for all
                      description: Company description
                    connpany_id:
                      type: string
                      example: GOO_2660260
                      description: Unique company identifier
                    crunchbase_id:
                      type: string
                      format: uri
                      example: >-
                        https://www.crunchbase.com/organization/google/funding_rounds/funding_rounds_list
                      description: URL to the company's Crunchbase profile
                    employees_number:
                      type: string
                      example: 300967 employees
                      description: Approximate number of employees
                    followers_number:
                      type: integer
                      example: 34225598
                      description: Number of LinkedIn followers
                    score:
                      type: number
                      format: float
                      example: 410.42
                      description: Overall company score
                    naics_code:
                      type: string
                      example: 511
                      description: NAICS code for the company's industry
                    serched_by:
                      type: integer
                      example: 8
                      description: Number of times the company was searched
                    ip_addresses:
                      type: integer
                      example: 1600
                      description: Approximate number of associated IP addresses
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                company_not_found:
                  summary: Company Not Found
                  value:
                    error: Not able to find any company associated with your account
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the monitoring plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /underwriter-getcompaniesfromportfolio:
    get:
      summary: Get all companies inside portfolio
      tags:
        - Underwriter
      description: Portfolio companies list
      responses:
        '200':
          description: Successful response with security scores for multiple companies
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    linkedin_id:
                      type: string
                      example: meta
                      description: LinkedIn ID of the company
                    company_name:
                      type: string
                      example: Meta
                      description: Name of the company
                    security_score:
                      type: number
                      format: float
                      example: 727.4
                      description: Security score of the company
                    last_updated_score_date:
                      type: string
                      format: date-time
                      example: '2024-10-21T08:06:07'
                      description: Timestamp of the last update for the security score
        '400':
          description: API Issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: API issue, please reach out to support@rankiteo.com
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the underwriter plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /underwriter-getcompanyapplicationsassets:
    get:
      summary: Get specific company applications assets
      tags:
        - Underwriter
      parameters:
        - name: linkedin_id
          in: query
          required: true
          description: LinkedIn identifier for the target company
          schema:
            type: string
            example: google
        - name: page
          in: query
          required: false
          schema:
            type: integer
            description: Page number
            example: 1
      description: Company information
      responses:
        '200':
          description: >-
            Successful response containing company information, applications,
            and pagination data
          content:
            application/json:
              schema:
                type: object
                properties:
                  linkedin_id:
                    type: string
                    description: Unique identifier for the company on LinkedIn
                    example: google
                  company_name:
                    type: string
                    description: The official name of the company
                    example: Google
                  website:
                    type: string
                    description: Official website URL of the company
                    example: https://goo.gle/3DLEokh
                  industry:
                    type: string
                    description: Industry category of the company
                    example: Software Development
                  description:
                    type: string
                    description: A brief description of the company and its mission
                    example: >-
                      A problem isn't truly solved until it's solved for all.
                      Googlers build products that help create opportunities for
                      everyone
                  number_of_applications:
                    type: integer
                    description: >-
                      Total number of applications or technologies identified as
                      being used by the company
                    example: 2241
                  applications:
                    type: array
                    description: >-
                      List of applications and technologies associated with the
                      company
                    items:
                      type: object
                      properties:
                        subdomain:
                          type: string
                          description: Subdomain of the application or technology
                          example: hivemint.xyz
                        domain:
                          type: string
                          description: >-
                            Main domain associated with the application or
                            technology
                          example: withgoogle.com
                        technology_name:
                          type: string
                          description: Name of the technology or application used
                          example: Node.js
                        technology_cpe:
                          type: string
                          description: >-
                            Common Platform Enumeration (CPE) identifier for the
                            technology
                          example: cpe:/a:nodejs:node.js
                        confidence:
                          type: integer
                          description: >-
                            Confidence level of the identification accuracy,
                            represented as a percentage
                          example: 100
                        category_id:
                          type: array
                          description: >-
                            List of IDs representing the category of the
                            technology
                          items:
                            type: integer
                          example:
                            - 27
                        category_name:
                          type: array
                          description: >-
                            List of category names corresponding to each
                            category ID
                          items:
                            type: string
                          example:
                            - Programming languages
                        version:
                          type: string
                          description: Version of the technology or application
                          example: Python
                        website:
                          type: string
                          description: Official website of the technology or application
                          example: http://nodejs.org
                  pagination:
                    type: object
                    description: Information about the pagination of results
                    properties:
                      current_page:
                        type: integer
                        description: The current page of the result set
                        example: 1
                      page_size:
                        type: integer
                        description: Number of items per page
                        example: 2
                      total_pages:
                        type: integer
                        description: Total number of pages available
                        example: 1
                      total_items:
                        type: integer
                        description: Total number of items in the result set
                        example: 2
                  message:
                    type: string
                    example: No data available
              examples:
                with_data:
                  summary: Response with data
                  value:
                    linkedin_id: google
                    company_name: Google
                    website: https://goo.gle/3DLEokh
                    industry: Software Development
                    description: A problem isn't truly solved until it's solved for all
                    number_of_applications: 2241
                    applications:
                      - subdomain: hivemint.xyz
                        domain: withgoogle.com
                        technology_name: Node.js
                        confidence: 100
                        category_id:
                          - 27
                        category_name:
                          - Programming languages
                        version: '-'
                        website: http://nodejs.org
                    pagination:
                      current_page: 1
                      page_size: 10
                      total_pages: 10
                      total_items: 100
                no_data:
                  summary: Response with message only
                  value:
                    message: No data available
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                invalid_linkedin_id:
                  summary: Invalid Linkedin Id
                  value:
                    error: >-
                      LinkedIn ID not valid. Please check and provide a valid
                      LinkedIn ID
                linkedin_id_not_found:
                  summary: Linkedin Id not found
                  value:
                    error: >-
                      This linkedin id has not been processed yet by our system,
                      but the scan will start soon
                required_params:
                  summary: Linkedin Id is a required parameter
                  value:
                    error: Linkedin Id is a required parameter
                invalid_page:
                  summary: Invalid Page
                  value:
                    error: Page value should be greater than 0
                invalid_request:
                  summary: Invalid request
                  value:
                    error: Invalid request
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the underwriter plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /underwriter-getcompanyinfo:
    get:
      summary: Get specific company details
      tags:
        - Underwriter
      description: Company information
      parameters:
        - name: linkedin_id
          in: query
          required: true
          description: LinkedIn identifier for the target company
          schema:
            type: string
            example: google
      responses:
        '200':
          description: Company information response
          content:
            application/json:
              schema:
                type: object
                properties:
                  linkedin_id:
                    type: string
                    description: LinkedIn identifier for the company
                    example: google
                  company_name:
                    type: string
                    description: Name of the company
                    example: Google
                  website:
                    type: string
                    format: uri
                    description: Website URL of the company
                    example: https://goo.gle/3DLEokh
                  industry:
                    type: string
                    description: Industry the company operates in
                    example: Software Development
                  description:
                    type: string
                    description: Company description
                    example: >-
                      A problem isn't truly solved until it's solved for all.
                      Googlers build products that help create opportunities for
                      everyone, whether down the street or across the globe
                  company_id:
                    type: string
                    description: Unique company identifier
                    example: GOO_2660260
                  crunchbase_id:
                    type: string
                    format: uri
                    description: URL to Crunchbase profile for the company
                    example: >-
                      https://www.crunchbase.com/organization/google/funding_rounds/funding_rounds_list
                  employees_number:
                    type: string
                    description: Total number of employees in the company
                    example: 300967 employees
                  followers_number:
                    type: integer
                    description: Total number of LinkedIn followers
                    example: 34225598
                  score:
                    type: number
                    format: float
                    description: Company score based on internal criteria
                    example: 410.42
                  naics_code:
                    type: string
                    description: NAICS code associated with the company's industry
                    example: 511
                  searched_by:
                    type: integer
                    description: Number of searches or views related to this company
                    example: 8
                  subsidiaries_list:
                    type: array
                    items:
                      type: string
                    description: >-
                      List of subsidiaries or associated entities under the
                      company
                    example:
                      - Adometry (acquired by Google)
                      - Android
                      - Google Cloud
                      - YouTube
                  ip_addresses:
                    type: integer
                    description: Number of IP addresses associated with the company
                    example: 1600
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                invalid_linkedin_id:
                  summary: Invalid Linkedin Id
                  value:
                    error: >-
                      LinkedIn ID not valid. Please check and provide a valid
                      LinkedIn ID
                linkedin_id_not_found:
                  summary: Linkedin Id not found
                  value:
                    error: >-
                      This linkedin id has not been processed yet by our system,
                      but the scan will start soon
                required_params:
                  summary: Linkedin Id is a required parameter
                  value:
                    error: Linkedin Id is a required parameter
                invalid_request:
                  summary: Invalid request
                  value:
                    error: Invalid request
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the underwriter plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /underwriter-getcompanyinfrastructureassets:
    get:
      summary: Get specific company infrastructure assets
      tags:
        - Underwriter
      description: Company information
      parameters:
        - name: linkedin_id
          in: query
          required: true
          description: LinkedIn identifier for the target company
          schema:
            type: string
            example: google
        - name: page
          in: query
          required: false
          schema:
            type: integer
            description: Page number
            example: 1
      responses:
        '200':
          description: >-
            Successful response containing company information, network
            endpoints, and pagination data
          content:
            application/json:
              schema:
                type: object
                properties:
                  linkedin_id:
                    type: string
                    description: Unique identifier for the company on LinkedIn
                    example: google
                  company_name:
                    type: string
                    description: The official name of the company
                    example: Google
                  website:
                    type: string
                    description: Official website URL of the company
                    example: https://goo.gle/3DLEokh
                  industry:
                    type: string
                    description: Industry category of the company
                    example: Software Development
                  description:
                    type: string
                    description: A brief description of the company and its mission
                    example: >-
                      A problem isn't truly solved until it's solved for all.
                      Googlers build products that help create opportunities for
                      everyone
                  number_of_infrastructure_endpoint:
                    type: integer
                    description: >-
                      Total number of network endpoints associated with the
                      company's infrastructure
                    example: 1600
                  network_endpoints:
                    type: array
                    description: List of network endpoints used by the company
                    items:
                      type: object
                      properties:
                        ip:
                          type: string
                          description: IP address of the network endpoint
                          example: 76.76.21.21
                        identified_product:
                          type: string
                          description: >-
                            Product or service identified to be hosted at this
                            endpoint
                          example: AMAZON-02
                        subdomain:
                          type: string
                          description: Subdomain of the network endpoint
                          example: fransandi.com
                        domain:
                          type: string
                          description: Main domain of the network endpoint
                          example: flutter.dev
                        isp:
                          type: string
                          description: >-
                            Internet Service Provider associated with the
                            endpoint
                          example: Amazon.com, Inc
                        services:
                          type: array
                          description: List of services hosted at this endpoint
                          items:
                            type: string
                          example:
                            - Hosting
                        orgination:
                          type: string
                          description: Organization managing or operating the endpoint
                          example: Vercel, Inc
                        region_name:
                          type: string
                          description: Name of the region where the endpoint is located
                          example: California
                        country:
                          type: string
                          description: Country where the endpoint is located
                          example: United States
                        continent:
                          type: string
                          description: Continent where the endpoint is located
                          example: North America
                        country_code:
                          type: string
                          description: >-
                            ISO code of the country where the endpoint is
                            located
                          example: US
                        zip:
                          type: string
                          description: Zip code of the endpoint’s location
                          example: 91789
                  pagination:
                    type: object
                    description: Information about the pagination of results
                    properties:
                      current_page:
                        type: integer
                        description: The current page of the result set
                        example: 1
                      page_size:
                        type: integer
                        description: Number of items per page
                        example: 2
                      total_pages:
                        type: integer
                        description: Total number of pages available
                        example: 1
                      total_items:
                        type: integer
                        description: Total number of items in the result set
                        example: 2
                  message:
                    type: string
                    example: No data available
              examples:
                with_data:
                  summary: Response with data
                  value:
                    linkedin_id: google
                    company_name: Google
                    website: https://goo.gle/3DLEokh
                    industry: Software Development
                    description: A problem isn't truly solved until it's solved for all
                    number_of_infrastructure_endpoint: 2241
                    network_endpoints:
                      - ip: 76.76.21.21
                        identified_product: AMAZON-02
                        subdomain: fransandi.com
                        domain: flutter.dev
                        isp: Amazon.com, Inc.
                        services:
                          - Hosting
                        orgination: Vercel, Inc
                        region_name: California
                        country: United States
                        continent: North America
                        country_code: US
                        zip: '91789'
                    pagination:
                      current_page: 1
                      page_size: 10
                      total_pages: 10
                      total_items: 100
                no_data:
                  summary: Response with message only
                  value:
                    message: No data available
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                invalid_linkedin_id:
                  summary: Invalid Linkedin Id
                  value:
                    error: >-
                      LinkedIn ID not valid. Please check and provide a valid
                      LinkedIn ID
                linkedin_id_not_found:
                  summary: Linkedin Id not found
                  value:
                    error: >-
                      This linkedin id has not been processed yet by our system,
                      but the scan will start soon
                required_params:
                  summary: Linkedin Id is a required parameter
                  value:
                    error: Linkedin Id is a required parameter
                invalid_page:
                  summary: Invalid Page
                  value:
                    error: Page value should be greater than 0
                invalid_request:
                  summary: Invalid request
                  value:
                    error: Invalid request
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the underwriter plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /underwriter-getcompanysbom:
    get:
      summary: Get company SBOM data by linkedin id
      tags:
        - Underwriter
      description: Company SBOM data includes technology information
      parameters:
        - name: linkedin_id
          in: query
          required: true
          description: LinkedIn identifier for the target company
          schema:
            type: string
            example: google
        - name: page
          in: query
          required: false
          schema:
            type: integer
            description: Page number
            example: 1
      responses:
        '200':
          description: >-
            Successful response containing subdomains and technology information
            or a message
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        domain_name:
                          type: string
                          example: x.company
                        subdomain:
                          type: array
                          items:
                            type: object
                            properties:
                              subdomain_name:
                                type: string
                                example: conscrypt.org
                              data:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    technology_name:
                                      type: string
                                      example: Bootstrap
                                    technology_version:
                                      type: string
                                      example: 3.3.7
                                    cve_number:
                                      type: array
                                      items:
                                        type: string
                                        example: CVE-2023-5317
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      page_size:
                        type: integer
                        example: 10
                      total_pages:
                        type: integer
                        example: 10
                      total_items:
                        type: integer
                        example: 100
                  message:
                    type: string
                    example: No SBOM vulnerability found
              examples:
                with_data:
                  summary: Response with data
                  value:
                    data:
                      - domain_name: x.company
                        subdomain:
                          - subdomain_name: conscrypt.org
                            data:
                              - technology_name: Bootstrap
                                technology_version: 3.3.7
                                cve_number:
                                  - CVE-2023-5317
                    pagination:
                      current_page: 1
                      page_size: 10
                      total_pages: 10
                      total_items: 100
                no_data:
                  summary: Response with message only
                  value:
                    message: No SBOM vulnerability found
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                invalid_linkedin_id:
                  summary: Invalid Linkedin Id
                  value:
                    error: >-
                      LinkedIn ID not valid. Please check and provide a valid
                      LinkedIn ID
                linkedin_id_not_found:
                  summary: Linkedin Id not found
                  value:
                    error: >-
                      This linkedin id has not been processed yet by our system,
                      but the scan will start soon
                required_params:
                  summary: Linkedin Id is a required parameter
                  value:
                    error: Linkedin Id is a required parameter
                invalid_page:
                  summary: Invalid Page
                  value:
                    error: Page value should be greater than 0
                invalid_request:
                  summary: Invalid request
                  value:
                    error: Invalid request
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the underwriter plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /underwriter-getcompanysbomcve:
    get:
      summary: Get company SBOM data with CVE by linkedin id
      tags:
        - Underwriter
      description: Company SBOM data includes technology information with cve
      parameters:
        - name: linkedin_id
          in: query
          required: true
          description: LinkedIn identifier for the target company
          schema:
            type: string
            example: google
        - name: page
          in: query
          required: false
          schema:
            type: integer
            description: Page number
            example: 1
      responses:
        '200':
          description: >-
            Successful response containing subdomains and technology information
            or a message
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        domain_name:
                          type: string
                          example: x.company
                        subdomain:
                          type: array
                          items:
                            type: object
                            properties:
                              subdomain_name:
                                type: string
                                example: conscrypt.org
                              data:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    technology_name:
                                      type: string
                                      example: Bootstrap
                                    technology_version:
                                      type: string
                                      example: 3.3.7
                                    cve_number:
                                      type: array
                                      items:
                                        type: string
                                        example: CVE-2023-5317
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      page_size:
                        type: integer
                        example: 10
                      total_pages:
                        type: integer
                        example: 10
                      total_items:
                        type: integer
                        example: 100
                  message:
                    type: string
                    example: No SBOM vulnerability found
              examples:
                with_data:
                  summary: Response with data
                  value:
                    data:
                      - domain_name: x.company
                        subdomain:
                          - subdomain_name: conscrypt.org
                            data:
                              - technology_name: Bootstrap
                                technology_version: 3.3.7
                                cve_number:
                                  - CVE-2023-5317
                    pagination:
                      current_page: 1
                      page_size: 10
                      total_pages: 10
                      total_items: 100
                no_data:
                  summary: Response with message only
                  value:
                    message: No SBOM vulnerability found
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                invalid_linkedin_id:
                  summary: Invalid Linkedin Id
                  value:
                    error: >-
                      LinkedIn ID not valid. Please check and provide a valid
                      LinkedIn ID
                linkedin_id_not_found:
                  summary: Linkedin Id not found
                  value:
                    error: This linkedin id has not been processed yet by our system
                required_params:
                  summary: Linkedin Id is a required parameter
                  value:
                    error: Linkedin Id is a required parameter
                invalid_page:
                  summary: Invalid Page
                  value:
                    error: Page value should be greater than 0
                invalid_request:
                  summary: Invalid request
                  value:
                    error: Invalid request
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the underwriter plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /underwriter-getcompanysbomdomain:
    get:
      summary: Get company SBOM data by domain and linkedin id
      tags:
        - Underwriter
      description: Company SBOM data includes technology information
      parameters:
        - name: linkedin_id
          in: query
          required: true
          description: LinkedIn identifier for the target company
          schema:
            type: string
            example: google
        - name: domain
          in: query
          required: true
          description: domain of company
          schema:
            type: string
            example: google.com
        - name: page
          in: query
          required: false
          schema:
            type: integer
            description: Page number
            example: 1
      responses:
        '200':
          description: >-
            Successful response containing subdomains and technology information
            or a message
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      domain_name:
                        type: string
                        example: google.com
                      subdomain:
                        type: array
                        items:
                          type: object
                          properties:
                            subdomain_name:
                              type: string
                              example: googleplus.com
                            data:
                              type: array
                              items:
                                type: object
                                properties:
                                  technology_name:
                                    type: string
                                    example: jQuery
                                  technology_version:
                                    type: string
                                    example: 1.11.3
                                  cve_number:
                                    type: array
                                    items:
                                      type: string
                                      example: CVE-2022-1537
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      page_size:
                        type: integer
                        example: 10
                      total_pages:
                        type: integer
                        example: 3
                      total_items:
                        type: integer
                        example: 23
                  message:
                    type: string
                    example: No SBOM vulnerability found
              examples:
                with_data:
                  summary: Response with detailed data
                  value:
                    data:
                      domain_name: google.com
                      subdomain:
                        - subdomain_name: googleplus.com
                          data:
                            - technology_name: jQuery
                              technology_version: 1.11.3
                              cve_number:
                                - CVE-2022-1537
                    pagination:
                      current_page: 1
                      page_size: 10
                      total_pages: 3
                      total_items: 23
                no_vulnerability:
                  summary: No vulnerability
                  value:
                    data:
                      domain_name: google.com
                      message: No SBOM vulnerability found
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                invalid_domain:
                  summary: Invalid domain
                  value:
                    error: Invalid domain. Please check and provide a valid domain
                domain_associate_issue:
                  summary: Domain association
                  value:
                    error: Required domain does not belong to linkedin id
                invalid_linkedin_id_or_domain:
                  summary: Invalid Linkedin Id or Domain
                  value:
                    error: >-
                      Invalid linkedin id or domain. Please check and provide a
                      valid linkedin id or domain
                linkedin_id_not_found:
                  summary: Linkedin Id not found
                  value:
                    error: >-
                      This linkedin id has not been processed yet by our system,
                      but the scan will start soon
                required_param_linkedin_id:
                  summary: Linkedin Id is a required parameter
                  value:
                    error: Linkedin Id is a required parameter
                required_param_domain:
                  summary: domain is a required parameter
                  value:
                    error: domain is a required parameter
                invalid_page:
                  summary: Invalid Page
                  value:
                    error: Page value should be greater than 0
                invalid_request:
                  summary: Invalid request
                  value:
                    error: Invalid request
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the underwriter plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /underwriter-getcompanyscores:
    get:
      summary: Get specific company global scoring
      tags:
        - Underwriter
      description: Company scoring without subsidiaries
      parameters:
        - name: linkedin_id
          in: query
          required: true
          description: LinkedIn identifier belonging to the target company
          schema:
            type: string
            example: google
      responses:
        '200':
          description: Successful response with LinkedIn company profile information
          content:
            application/json:
              schema:
                type: object
                properties:
                  linkedin_id:
                    type: string
                    example: google
                    description: LinkedIn ID of the company
                  company_name:
                    type: string
                    example: Google
                    description: Name of the company
                  website:
                    type: string
                    format: uri
                    example: https://goo.gle/3DLEokh
                    description: Company's website URL
                  industry:
                    type: string
                    example: Software Development
                    description: Industry type
                  description:
                    type: string
                    example: A problem isn't truly solved until it's solved for all
                    description: Company description
                  subsidiaries_number:
                    type: integer
                    example: 46
                    description: Number of subsidiaries
                  score:
                    type: object
                    properties:
                      spf:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: C
                          number:
                            type: number
                            format: float
                            example: 71.39
                      dkim:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: C
                          number:
                            type: number
                            format: float
                            example: 85.74
                      certificate_conf:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: E
                          number:
                            type: number
                            format: float
                            example: 48.62
                      certificate_info:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: E
                          number:
                            type: number
                            format: float
                            example: 11.09
                      open_ports:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: C
                          number:
                            type: number
                            format: float
                            example: 39.07
                      web_headers:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: E
                          number:
                            type: number
                            format: float
                            example: 18.22
                      dmarc:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: D
                          number:
                            type: number
                            format: float
                            example: 68.39
                      it_standardization:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: E
                          number:
                            type: number
                            format: float
                            example: 3.81
                      digitalization:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: E
                          number:
                            type: number
                            format: float
                            example: 3.81
                      certificate_cve:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: E
                          number:
                            type: number
                            format: float
                            example: 9.14
                      vulnerabilities:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: D
                          number:
                            type: number
                            format: float
                            example: 47.15
                      sbom:
                        type: object
                        properties:
                          letter:
                            type: string
                            example: F
                          number:
                            type: number
                            format: float
                            example: 1.4
                  message:
                    type: string
                    example: No data available
              examples:
                with_data:
                  summary: Response with data
                  value:
                    linkedin_id: google
                    company_name: Google
                    website: https://goo.gle/3DLEokh
                    industry: Software Development
                    description: A problem isn't truly solved until it's solved for all
                    subsidiaries_number: 0
                    score:
                      spf:
                        letter: C
                        number: 71.39
                      dkim:
                        letter: C
                        number: 85.74
                      certificate_conf:
                        letter: E
                        number: 48.62
                      certificate_info:
                        letter: E
                        number: 11.52
                      open_ports:
                        letter: C
                        number: 39.07
                      web_headers:
                        letter: E
                        number: 19.79
                      dmarc:
                        letter: D
                        number: 68.39
                      it_standardization:
                        letter: F
                        number: 2.87
                      digitalization:
                        letter: F
                        number: 2.87
                      certificate_cve:
                        letter: E
                        number: 9.14
                      vulnerabilities:
                        letter: D
                        number: 48.35
                      sbom:
                        letter: F
                        number: 1.4
                no_data:
                  summary: Response with message only
                  value:
                    message: No data available
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                invalid_linkedin_id:
                  summary: Invalid Linkedin Id
                  value:
                    error: >-
                      LinkedIn ID not valid. Please check and provide a valid
                      LinkedIn ID
                linkedin_id_not_found:
                  summary: Linkedin Id not found
                  value:
                    error: >-
                      This linkedin id has not been processed yet by our system,
                      but the scan will start soon
                required_params:
                  summary: Linkedin Id is a required parameter
                  value:
                    error: Linkedin Id is a required parameter
                invalid_request:
                  summary: Invalid request
                  value:
                    error: Invalid request
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the underwriter plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /underwriter-getcompanystats:
    get:
      summary: Get company statistics data for specific company
      tags:
        - Underwriter
      description: Company stats with all subsidiaries
      parameters:
        - name: linkedin_id
          in: query
          required: true
          description: LinkedIn identifier for the target company
          schema:
            type: string
            example: google
        - name: page
          in: query
          required: false
          schema:
            type: integer
            description: Page number
            example: 1
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  parent_linkedin_id:
                    type: string
                    example: google
                  subsidiaries_stats:
                    type: array
                    items:
                      type: object
                      properties:
                        linkedin_id:
                          type: string
                          example: adometry
                        company_name:
                          type: string
                          example: Adometry (acquired by Google)
                        company_domain:
                          type: string
                          example: google.com
                        finding_stats:
                          type: object
                          properties:
                            nb_good:
                              type: integer
                              example: 54902
                            nb_warning:
                              type: integer
                              example: 2174
                            nb_bad:
                              type: integer
                              example: 9182
                            nb_neutral:
                              type: integer
                              example: 1808
                        peer_stats:
                          type: object
                          properties:
                            inside_top25_percentile:
                              type: string
                              example: 'yes'
                            inside_between_top25_and_top50_percentile:
                              type: string
                              example: 'no'
                            inside_between_low25_and_low50_percentile:
                              type: string
                              example: 'no'
                            inside_low25_percentile:
                              type: string
                              example: 'no'
                        last_6_month:
                          type: object
                          additionalProperties:
                            type: object
                            properties:
                              month_year:
                                type: string
                                example: Nov 2024
                              value:
                                type: integer
                                example: 128
                              difference:
                                type: string
                                example: '128'
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 2
                      page_size:
                        type: integer
                        example: 1
                      total_pages:
                        type: integer
                        example: 46
                      total_items:
                        type: integer
                        example: 46
                  message:
                    type: string
                    example: No data available
              examples:
                with_data:
                  summary: Response with data
                  value:
                    parent_linkedin_id: apple
                    subsidiaries_stats:
                      - linkedin_id: apple
                        company_name: Apple
                        company_domain: apple.com
                        finding_stats:
                          nb_good: 180022
                          nb_warning: 7912
                          nb_bad: 15581
                          nb_neutral: 4525
                        peer_stats:
                          inside_top25_percentile: 'yes'
                          inside_between_top25_and_top50_percentile: 'no'
                          inside_between_low25_and_low50_percentile: 'no'
                          inside_low25_percentile: 'no'
                        last_6_month:
                          '1':
                            month_year: Nov 2024
                            value: 556
                            difference: '0'
                          '2':
                            month_year: Oct 2024
                            value: 556
                            difference: '0'
                          '3':
                            month_year: Sep 2024
                            value: 556
                            difference: '22'
                          '4':
                            month_year: Aug 2024
                            value: 534
                            difference: '-8'
                          '5':
                            month_year: Jul 2024
                            value: 542
                            difference: '-51'
                          '6':
                            month_year: Jun 2024
                            value: 593
                            difference: '14'
                    pagination:
                      current_page: 1
                      page_size: 1
                      total_pages: 1
                      total_items: 1
                no_data:
                  summary: Response with message only
                  value:
                    message: No data available
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                invalid_linkedin_id:
                  summary: Invalid Linkedin Id
                  value:
                    error: >-
                      LinkedIn ID not valid. Please check and provide a valid
                      LinkedIn ID
                linkedin_id_not_found:
                  summary: Linkedin Id not found
                  value:
                    error: >-
                      This linkedin id has not been processed yet by our system,
                      but the scan will start soon
                required_params:
                  summary: Linkedin Id is a required parameter
                  value:
                    error: Linkedin Id is a required parameter
                invalid_page:
                  summary: Invalid Page
                  value:
                    error: Page value should be greater than 0
                invalid_request:
                  summary: Invalid request
                  value:
                    error: Invalid request
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the underwriter plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /underwriter-getcompanysubscores:
    get:
      summary: Get specific company scoring including subsidiaries
      tags:
        - Underwriter
      description: Company scoring with all subsidiaries
      parameters:
        - name: linkedin_id
          in: query
          required: true
          description: LinkedIn identifier for the target company
          schema:
            type: string
            example: google
        - name: page
          in: query
          required: false
          schema:
            type: integer
            description: Page number
            example: 1
      responses:
        '200':
          description: Successful response containing LinkedIn ID and subsidiaries' scores
          content:
            application/json:
              schema:
                type: object
                properties:
                  linkedin_id:
                    type: string
                    example: google
                  subsidiaries_scores:
                    type: array
                    items:
                      type: object
                      properties:
                        linkedin_id:
                          type: string
                          example: google
                        company_name:
                          type: string
                          example: Google
                        website:
                          type: string
                          example: https://goo.gle/3DLEokh
                        industry:
                          type: string
                          example: Software Development
                        description:
                          type: string
                          example: >-
                            A problem isn't truly solved until it's solved for
                            all
                        score:
                          type: object
                          properties:
                            spf:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: C
                                number:
                                  type: number
                                  format: float
                                  example: 71.39
                            dkim:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: C
                                number:
                                  type: number
                                  format: float
                                  example: 85.74
                            certificate_conf:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: E
                                number:
                                  type: number
                                  format: float
                                  example: 48.62
                            certificate_info:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: E
                                number:
                                  type: number
                                  format: float
                                  example: 11.09
                            open_ports:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: C
                                number:
                                  type: number
                                  format: float
                                  example: 39.07
                            web_headers:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: E
                                number:
                                  type: number
                                  format: float
                                  example: 18.22
                            dmarc:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: D
                                number:
                                  type: number
                                  format: float
                                  example: 68.39
                            it_standardization:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: E
                                number:
                                  type: number
                                  format: float
                                  example: 3.81
                            digitalization:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: E
                                number:
                                  type: number
                                  format: float
                                  example: 3.81
                            certificate_cve:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: E
                                number:
                                  type: number
                                  format: float
                                  example: 9.14
                            vulnerabilities:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: D
                                number:
                                  type: number
                                  format: float
                                  example: 47.15
                            sbom:
                              type: object
                              properties:
                                letter:
                                  type: string
                                  example: F
                                number:
                                  type: number
                                  format: float
                                  example: 1.4
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      page_size:
                        type: integer
                        example: 1
                      total_pages:
                        type: integer
                        example: 1
                      total_items:
                        type: integer
                        example: 1
                  message:
                    type: string
                    example: No data available
              examples:
                with_data:
                  summary: Response with data
                  value:
                    linkedin_id: apple
                    subsidiaries_scores:
                      - linkedin_id: apple
                        company_name: Apple
                        website: http://www.apple.com/careers
                        industry: Computers and Electronics Manufacturing
                        description: >-
                          We’re a diverse collective of thinkers and doers,
                          continually reimagining what’s possible to help us all
                          do what we love in new ways
                        score:
                          spf:
                            letter: A
                            number: 120.69
                          dkim:
                            letter: E
                            number: 72.65
                          certificate_conf:
                            letter: F
                            number: 12.6
                          certificate_info:
                            letter: F
                            number: 2.8
                          open_ports:
                            letter: F
                            number: 21.28
                          web_headers:
                            letter: F
                            number: 7
                          dmarc:
                            letter: A
                            number: 172.41
                          it_standardization:
                            letter: B
                            number: 14.37
                          digitalization:
                            letter: A
                            number: 17.24
                          certificate_cve:
                            letter: F
                            number: 4.2
                          vulnerabilities:
                            letter: A
                            number: 103.45
                          sbom:
                            letter: F
                            number: 5.04
                    pagination:
                      current_page: 1
                      page_size: 1
                      total_pages: 1
                      total_items: 1
                no_data:
                  summary: Response with message only
                  value:
                    message: No data available
        '400':
          description: Generic Issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_issue:
                  summary: API Issue
                  value:
                    error: API issue, please reach out to support@rankiteo.com
                invalid_linkedin_id:
                  summary: Invalid Linkedin Id
                  value:
                    error: >-
                      LinkedIn ID not valid. Please check and provide a valid
                      LinkedIn ID
                linkedin_id_not_found:
                  summary: Linkedin Id not found
                  value:
                    error: >-
                      This linkedin id has not been processed yet by our system,
                      but the scan will start soon
                required_params:
                  summary: Linkedin Id is a required parameter
                  value:
                    error: Linkedin Id is a required parameter
                invalid_page:
                  summary: Invalid Page
                  value:
                    error: Page value should be greater than 0
                invalid_request:
                  summary: Invalid request
                  value:
                    error: Invalid request
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the underwriter plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
  /underwriter-getlastcompaniesscanned:
    get:
      summary: Get companies scoring data recently scanned
      tags:
        - Underwriter
      description: Last scanned companies
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            description: Page number
            example: 1
      responses:
        '200':
          description: Companies information response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: List of companies
                    items:
                      type: object
                      properties:
                        company_name:
                          type: string
                          description: Company name
                          example: Emergency Medical Services Authority (EMSA)
                        linkedin_id:
                          type: string
                          description: LinkedIn ID
                          example: emergency-medical-services-authority-emsa-
                        score:
                          type: integer
                          description: Company score
                          example: 954
                        last_date_updated:
                          type: string
                          format: date-time
                          description: Last update timestamp
                          example: '2024-10-28 08:06:53'
                  pagination:
                    type: object
                    description: Pagination details
                    properties:
                      current_page:
                        type: integer
                        description: Current page number
                        example: 1
                      page_size:
                        type: integer
                        description: Items per page
                        example: 2
                      total_pages:
                        type: integer
                        description: Total pages
                        example: 1
                      total_items:
                        type: integer
                        description: Total items
                        example: 2
        '400':
          description: API Issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: API issue, please reach out to support@rankiteo.com
        '401':
          description: API key or membership related issue
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                api_key_issue:
                  summary: API key issue
                  value:
                    error: Invalid API key
                deactivated_api_key:
                  summary: Deactivated API key
                  value:
                    error: API key is deactivated
                api_key_missing:
                  summary: API key missing
                  value:
                    error: API Key is required
                package_issue:
                  summary: Package issue
                  value:
                    error: >-
                      You do not have access to the requested API. Please
                      upgrade to the underwriter plan
        '404':
          description: Route Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    example: 404 Route Not Found
