openapi: 3.1.0
info:
  title: Interzoid Individual Name Matching API
  description: >
    This API uses specialized algorithms, AI models, and extensive knowledge bases to generate a similarity key for an individual name that can be used to compare and match inconsistent individual 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 Individual Name Matching API Documentation](https://www.interzoid.com/apis/individual-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/individual-name-matching
servers:
  - url: https://api.interzoid.com
    description: Production server
tags:
  - name: Individual Name Similarity Key
    description: Helps to identify inconsistent and redundant individual names within or across datasets.
paths:
  /getfullnamematch:
    get:
      tags:
        - Individual Name Similarity Key
      summary: Generate Similarity Key for Individual Name
      description: >
        This method uses specialized algorithms, AI models, and extensive knowledge bases to generates a similarity key for a given individual name. The similarity key is used to identify similar yet inconsistent individual names.

        **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: fullname
          in: query
          required: true
          description: The individual name for which the similarity key is generated.
          schema:
            type: string
          examples:
            FullName:
                summary: Individual Name Example
                value: "Tom Johnson"
      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 individual 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: "d6ycm241zd"
                      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 name parameter 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: []