{
  "openapi": "3.1.0",
  "info": {
    "title": "Interzoid Get Address Match Advanced Similarity Key API",
    "description": "This API provides a similarity key used to match with other similar street address 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.",
    "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": {
    "/getaddressmatchadvanced": {
      "get": {
        "tags": [
          "Street Address Similarity Key"
        ],
        "summary": "getaddressmatch",
        "description": "Gets a similarity key for matching purposes for street address data\n",
        "operationId": "getaddressmatch",
        "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": "address",
            "in": "query",
            "description": "Address 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 or narrow",
            "required": true,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Generated similarity key for address data",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetaddressmatchadvancedResponse"
                }
              }
            }
          },
          "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": {
      "GetaddressmatchadvancedResponse": {
        "title": "GetaddressmatchadvancedResponse",
        "type": "object",
        "properties": {
          "Simkey": {
            "type": "string"
          },
          "Code": {
            "type": "string"
          },
          "Credits": {
            "type": "string"
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "Street Address Similarity Key",
      "description": ""
    }
  ],
  "externalDocs": {
    "description": "API home page and documentation",
    "url": "https://www.interzoid.com/apis/street-address-matching"
  }
}