openapi: 3.1.0
info:
  title: Interzoid Company Name Matching API
  description: >
    This API uses specialized algorithms, AI models, and extensive knowledge bases to generate a similarity key for a company name that can be used to compare and match company names effectively.

    To use this API, you need an API key. Register for an API key at [Interzoid Registration](https://www.interzoid.com/register-api-account).

    For more information about this API, visit the [Interzoid Company Name Matching API Documentation](https://www.interzoid.com/apis/company-name-matching).
  version: 1.0.0
  contact:
    name: Interzoid Support
    url: https://www.interzoid.com
    email: support@interzoid.com
externalDocs:
  description: API home page and documentation
  url: https://www.interzoid.com/apis/company-name-matching
servers:
  - url: https://api.interzoid.com
    description: Production server
tags:
  - name: Company Name Similarity Key
    description: Helps to identify inconsistent and redundant organization names within or across datasets.
paths:
  /getcompanymatchadvanced:
    get:
      tags:
        - Company Name Similarity Key
      summary: Generate Similarity Key for Company Name
      description: >
        This method uses specialized algorithms, AI models, and extensive knowledge bases to generate a similarity key for a given company name. The similarity key is used to identify similar company names that share the same similarity key.

        **Note**: You must include your API key as the `license` parameter in the request. If you do not have an API key, you can register for one at [Interzoid Registration](https://www.interzoid.com/register-api-account).
      parameters:
        - name: license
          in: query
          required: true
          description: >
            Your API license key. Register for an API key at
            [Interzoid Registration](https://www.interzoid.com/register-api-account).
          schema:
            type: string
          examples:
            license:
                summary: API Key Example
                value: "r2d7df664a7c4ef6h8k"
        - name: company
          in: query
          required: true
          description: The company name for which the similarity key is generated.
          schema:
            type: string
          examples:
            companyName:
                summary: Company Name Example
                value: "Amazon Inc."
        - name: algorithm
          in: query
          required: true
          description: The matching algorithm and AI model used to generate the similarity key.
          schema:
            type: string
          examples:
            algorithm:
                summary: Algorithm Example
                value: "ai-medium-wide"
      responses:
        '200':
          description: Successful response containing the similarity key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  SimKey:
                    type: string
                    description: The generated similarity key for the company name.
                  Credits:
                    type: integer
                    description: Remaining credits for your API license.
                  Message:
                    type: string
                    description: Status message.
                  Code:
                    type: integer
                    description: Response code.
                examples:
                  - summary: Successful response example
                    value:
                      SimKey: "C1P4NYNM"
                      Credits: 4999
                      Message: "Success"
                      Code: 200
        '400':
          description: Bad request (e.g., missing or invalid parameters).
          content:
            application/json:
              schema:
                type: object
                properties:
                  Code:
                    type: integer
                    description: Response code.
                  Message:
                    type: string
                    description: Error message.
                examples:
                  - summary: Missing or invalid parameters
                    value:
                      Code: 400
                      Message: "Invalid license key or company name missing."
        '402':
          description: API key not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Code:
                    type: integer
                    description: Response code.
                  Message:
                    type: string
                    description: Error message.
                examples:
                  - summary: API key not found
                    value:
                      Code: 402
                      Message: "API key not found."
        '403':
          description: Insufficient API credits remaining.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Code:
                    type: integer
                    description: Response code.
                  Message:
                    type: string
                    description: Error message.
                examples:
                  - summary: Insufficient credits
                    value:
                      Code: 403
                      Message: "Insufficient API credits remaining."
        '405':
          description: Method not allowed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Code:
                    type: integer
                    description: Response code.
                  Message:
                    type: string
                    description: Error message.
                examples:
                  - summary: Wrong HTTP method
                    value:
                      Code: 405
                      Message: "Method not allowed."
        '429':
          description: Rate limits reached.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Code:
                    type: integer
                    description: Response code.
                  Message:
                    type: string
                    description: Error message.
                examples:
                  - summary: Rate limit reached
                    value:
                      Code: 429
                      Message: "Rate limits reached."
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Code:
                    type: integer
                    description: Response code.
                  Message:
                    type: string
                    description: Error message.
                examples:
                  - summary: Server error
                    value:
                      Code: 500
                      Message: "Internal server error."
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: license
      in: query
  schemas:
    ResponseError:
      type: object
      properties:
        Code:
          type: integer
          description: Response code.
        Message:
          type: string
          description: Error message.
security:
  - apiKeyAuth: []