openapi: 3.1.0
info:
  title: Interzoid Get Company Name Match Similarity Key Advanced API
  description: This API provides a similarity key used to match with other similar company name data, including for purposes of deduplication, fuzzy matching, or merging of datasets. A much higher match rate will be achieved by matching on the algorithmically generated similarity key rather than the data itself. You can choose from multiple matching algorithms, 'wide', 'medium', and 'narrow'. 'Wide' will find a greater number of matches, but may also find similarly-spelled false positives. 'Narrow' will result in tighter matching requirements, but then may miss a few matches. Your business case will dictate which algorithm is ideal.
  contact:
    name: API Support
    url: https://www.interzoid.com
    email: support@interzoid.com
  version: '1.0.0'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
servers:
- url: https://api.interzoid.com
  variables: {}
paths:
  /getcompanymatchadvanced:
    get:
      tags:
      - Company Name Similarity Key
      summary: getcompanymatchadvanced
      description: Gets a similarity key for matching purposes for company name data
      operationId: getcompanymatchadvanced
      parameters:
      - name: license
        in: query
        description: Your Interzoid license API key. Register at www.interzoid.com/register-api-account
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: company
        in: query
        description: Company name from which to generate similarity key
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: algorithm
        in: query
        description: Algorithm used to generate similarity key - wide, medium, or narrow
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Generated similarity key for company name data
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetcompanymatchadvancedResponse'
        '400':
          description: bad request - insufficient parameters
          headers: {}
          content: {}
        '402':
          description: credits exhausted
          headers: {}
          content: {}
        '403':
          description: invalid license API key
          headers: {}
          content: {}
        '405':
          description: method not allowed
          headers: {}
          content: {}
        '500':
          description: internal server error
          headers: {}
          content: {}
      deprecated: false
    parameters: []
components:
  schemas:
    GetcompanymatchadvancedResponse:
      title: GetcompanymatchadvancedResponse
      type: object
      properties:
        Simkey:
          type: string
        Code:
          type: string
        Credits:
          type: string
tags:
- name: Company Name Similarity Key
  description: Helps to identify inconsistent and redundant organization names within or across datasets.
externalDocs:
  description: API home page and documentation
  url: https://www.interzoid.com/apis/company-name-matching