canonical: https://jentic.com/apis/interzoid.com/interzoid-get-address-match-similarity-key-api # Interzoid Get Address Match Similarity Key API Jentic publishes the only available OpenAPI specification for the Interzoid Get Address Match Similarity Key API, keeping it validated and agent-ready. The single GET endpoint takes a street address and returns an algorithmically generated similarity key, designed so that variant address strings collapse to the same key for fuzzy matching, deduplication, and dataset merging. Authentication is an Interzoid licence key passed as the 'license' query parameter alongside the address to key. ## For AI agents Generate a similarity key for a street address so variant spellings dedupe to the same key for fuzzy matching and merging. ## Scope Does not validate that an address exists, geocode to coordinates, or normalise to a postal standard - use for generating fuzzy-match similarity keys for street-address deduplication and merging only. ## Capabilities - Generate a similarity key for a free-text street address that survives common variations - Drive higher match rates than raw-string comparison when joining or deduplicating address data - Return a result code and remaining-credit count alongside the similarity key - Authenticate with an Interzoid licence key passed as a query parameter ## Use cases ### Customer Database Deduplication Data teams generate the similarity key for each address in a customer table, then group records that share a key into duplicate clusters for review or automatic merge. The similarity key handles common abbreviation, casing, and ordering variations that defeat raw string comparison. Dedupe runs that previously needed manual review of borderline matches become deterministic. Example prompt: For each row in a 100,000-record customer table, call /getaddressmatch and emit the returned SimKey alongside the original address ### Cross-System Dataset Merge When merging customer or location data from two systems, generating the similarity key on both sides aligns rows that refer to the same physical address despite different data-entry conventions. The match key is stable across systems because it is computed by the same algorithm. End-to-end this turns a soft-match heuristic problem into a hash join. Example prompt: Compute the similarity key for addresses in System A and System B and join records where the keys match exactly ### Marketing Suppression List Matching Marketing teams suppress addresses on opt-out or do-not-contact lists by matching incoming campaign records against the suppression set on similarity key. Variant spellings of the same street address still suppress correctly because both sides resolve to the same key. Compliance posture improves without an expensive matching engine. Example prompt: Generate similarity keys for the latest campaign addresses and reject any that match a key on the suppression list ### Agent-Driven Record Linkage An AI agent consolidating customer records calls the Interzoid endpoint to compute a similarity key for each candidate match's address, then merges records when keys agree. Jentic stores the licence key in your Jentic One instance and injects it as the 'license' query parameter, so the agent never sees the raw key. Record linkage that needed a custom service becomes a Jentic operation call. Example prompt: Given two candidate customer records, call /getaddressmatch for each address and merge the records when the SimKey values match ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/getaddressmatch` | Return the similarity key for a given street address | ## Key resources - **Address Match Similarity Key** — Single GET endpoint that returns a fuzzy-match-friendly similarity key for a street address ## Why Jentic - **Setup:** Wiring the Interzoid Get Address Match Similarity Key API by hand means passing your licence key as a query parameter on every call and remembering the single /getaddressmatch endpoint. Through Jentic you install once, import the Interzoid Get Address Match Similarity Key API from the API Directory, store the licence key once, and your agent calls it. - **Permission scoping:** This API exposes one read-only operation, GET /getaddressmatch, with the address string in the query, so limit the agent to that operation. It performs no writes or deletes, so there is nothing destructive to add. - **Credential handling:** Your Interzoid licence key is stored once, encrypted, by your own Jentic One instance and injected as the license query parameter at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'address similarity key for dedupe', and Jentic returns the GET /getaddressmatch operation with its address query parameter so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Interzoid City Data Standardization API** — Standardises the city component of an address that pairs with the address similarity key - **Interzoid Zip Code Detailed Info API** — Enriches addresses with detailed ZIP code information complementing the match key - **Abstract API** — Multi-purpose data API including address validation versus Interzoid's similarity-key focus ## FAQ ### Why is there no official OpenAPI spec for the Interzoid Get Address Match Similarity Key API? Interzoid does not publish OpenAPI specifications for its endpoints. Jentic generates and maintains this spec so that AI agents and developers can call the Interzoid Get Address Match Similarity Key API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the Interzoid Get Address Match Similarity Key API use? Authentication is a licence key passed as the 'license' query parameter on GET /getaddressmatch. Register at www.interzoid.com/register to obtain a key. Through Jentic, the key is stored in your Jentic One instance and injected at execution time so it never enters the agent's prompt. ### How does the similarity key actually help with matching? The endpoint returns an algorithmically derived key that collapses common variations - abbreviations, casing differences, punctuation, and minor reordering - into a stable identifier. Two addresses that look different but refer to the same place produce the same key, so a hash-style join finds the match where raw-string comparison fails. ### What are the rate limits for the Interzoid Get Address Match Similarity Key API? Interzoid runs on a credit-per-call model rather than a hard rate limit. Each successful response includes a 'Credits' field, and HTTP 402 is returned when credits are exhausted. The licence tier purchased determines the credit pool. ### How do I generate a similarity key through Jentic? Search Jentic for 'address similarity key'. The SDK returns the GET /getaddressmatch operation with the address query parameter. Run pip install jentic, await client.search('address similarity key'), then await client.execute(...) with the address string. ### Does this API validate or geocode the address? No. The endpoint does not validate that the address exists, normalise it to a postal standard, or return coordinates - it produces a similarity key for matching only. For validation or geocoding, pair it with a postal-validation or geocoding service. ### Can I limit what my agent is allowed to do with the Interzoid Get Address Match Similarity Key API? Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use, and this API exposes just one read-only operation, GET /getaddressmatch, which returns a similarity key for a street address. You can allow the agent that single operation and nothing else, and since the endpoint performs no writes or deletes there is no destructive action to expose. Your Interzoid licence key stays in your own Jentic One instance and is injected as the license query parameter at execution time, so the agent never handles the raw key.