{
  "openapi": "3.1.0",
  "info": {
    "title": "Get Full Name Match Similarity Key API",
    "description": "This API uses specialized algorithms, AI models, and extensive knowledge bases to generate a similarity key for an individual full name that can be used to compare and match names effectively.\nTo use this API, you need an API key. Register for an API key at [Interzoid Registration](https://www.interzoid.com/register-api-account).\nFor more information about this API, visit the [Interzoid Individual Name Matching API Documentation](https://www.interzoid.com/apis/individual-name-matching).\nYou can also try this API [interactively](https://try.interzoid.com) or in high-speed [batch mode](https://batch.interzoid.com).\n",
    "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": "Full Name Similarity Key",
      "description": "Helps to identify inconsistent and redundant individual names within or across datasets."
    }
  ],
  "paths": {
    "/getfullnamematch": {
      "get": {
        "operationId": "getFullNameMatch",
        "tags": [
          "Full Name Similarity Key"
        ],
        "summary": "Generate Similarity Key for Full Name",
        "description": "Generates a similarity key for a given individual full name using advanced algorithms and AI. Include your API key (license) in the request. Register for an API key at https://www.interzoid.com/register-api-account.\n",
        "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).\n",
            "schema": {
              "type": "string"
            },
            "examples": {
              "license": {
                "summary": "API Key Example",
                "value": "fh5hs7*****"
              }
            }
          },
          {
            "name": "fullname",
            "in": "query",
            "required": true,
            "description": "The individual full name for which the similarity key is generated.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "fullName": {
                "summary": "Full Name Example",
                "value": "James Johnston"
              }
            }
          }
        ],
        "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 full name."
                    },
                    "Credits": {
                      "type": "integer",
                      "description": "Remaining credits for your API license."
                    },
                    "Code": {
                      "type": "string",
                      "description": "Response code, \"Success\" if the call is successful."
                    }
                  }
                },
                "examples": {
                  "success": {
                    "value": {
                      "SimKey": "N1Ai4RfV0SRJf2dN1Ai4QTVofRgF2dSVzcA4",
                      "Credits": 5828243,
                      "Code": "Success"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request (e.g., missing or invalid parameters).",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "error": {
                    "value": "Invalid license key or full name missing."
                  }
                }
              }
            }
          },
          "402": {
            "description": "API key not found.",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "error": {
                    "value": "API key not found."
                  }
                }
              }
            }
          },
          "403": {
            "description": "Insufficient API credits remaining.",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "error": {
                    "value": "Insufficient API credits remaining."
                  }
                }
              }
            }
          },
          "405": {
            "description": "Method not allowed.",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "error": {
                    "value": "Method not allowed."
                  }
                }
              }
            }
          },
          "429": {
            "description": "Rate limits reached.",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "error": {
                    "value": "Rate limits reached."
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error.",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "error": {
                    "value": "Internal server error."
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKeyAuth": {
        "type": "apiKey",
        "name": "license",
        "in": "query"
      }
    },
    "schemas": {}
  },
  "security": [
    {
      "apiKeyAuth": []
    }
  ]
}