{
  "openapi": "3.1.0",
  "info": {
    "title": "Interzoid Get Full Name Match Similarity Key API",
    "description": "This API provides a similarity key used to match with other similar full 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 similarity key rather than the data itself. This API is for full name data where first and last name are in the same field. Use the Full Name Parsed Similarity Key API for first and last name data that are in separate fields.",
    "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": {
    "/getfullnamematch": {
      "get": {
        "tags": [
          "Full Name Match Similarity Key"
        ],
        "summary": "getfullnamematch",
        "description": "Gets a similarity key for matching purposes for full name data, where first and last name are part of the same field.",
        "operationId": "getfullnamematch",
        "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": "fullname",
            "in": "query",
            "description": "Full name from which to generate similarity key",
            "required": true,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Generated similarity key for full name data",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetfullnamematchResponse"
                }
              }
            }
          },
          "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": {
      "GetfullnamematchResponse": {
        "title": "GetfullnamematchResponse",
        "type": "object",
        "properties": {
          "Simkey": {
            "type": "string"
          },
          "Code": {
            "type": "string"
          },
          "Credits": {
            "type": "string"
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "Full Name Match Similarity Key",
      "description": ""
    }
  ],
  "externalDocs": {
    "description": "API home page and documentation",
    "url": "https://www.interzoid.com/apis/individual-name-matching"
  }
}