Interzoid Data Matching API

openapi: 3.2.0
info:
  contact:
    email: support@interzoid.com
    name: Interzoid Support
    url: https://www.interzoid.com
  description: AI-powered data quality, data matching, data standardization, and data enrichment APIs. Pay per call with USDC via the x402 protocol, or use an Interzoid API key.
  termsOfService: https://www.interzoid.com/api-terms-use
  title: Interzoid Data Quality and Enrichment Data Matching API
  version: 2.0.0
  x-guidance: 'All endpoints are HTTP GET with query string parameters and return JSON. Two ways to call: (1) include an Interzoid API key in the x-api-key header, or (2) send no key to receive an HTTP 402 x402 payment challenge, pay the quoted amount in USDC on Base (eip155:8453), and retry with the Payment-Signature header. Prices are per call and listed in each operation''s x-payment-info. Matching endpoints return a SimKey similarity key: two inputs that produce the same SimKey refer to the same real-world entity, so generate keys for your records and group on them to find matches and duplicates. Score endpoints return a 0-100 match confidence for a pair of inputs. Standardization endpoints return canonical forms, and enrichment endpoints return structured data about the input entity. Premium enrichment endpoints take an optional language parameter (a code or name such as de or German) and return their result values in that language at the same price; it is listed in each operation''s parameters. A successful response includes Code: Success.'
servers:
- url: https://api.interzoid.com
tags:
- name: data-matching
paths:
  /getaddressandfullnamematch:
    get:
      operationId: getaddressandfullnamematch
      parameters:
      - description: Full street address (US or international)
        example: 100 Main Street
        in: query
        name: address
        required: true
        schema:
          type: string
      - description: Full individual name
        example: James Johnston
        in: query
        name: fullname
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                Code: Success
                Credits: '0'
                SimKey: Xk7pR9vLmQ2wYdN1Ai4RfV0SRJf2dJwDO0C
          description: Successful response
        '400':
          description: Missing or invalid parameters
        '402':
          description: Payment Required. Returns an x402 challenge with payment requirements in the Payment-Required header and JSON body.
      security:
      - ApiKeyAuth: []
      - {}
      summary: 'Household and contact deduplication: generates one combined AI-powered…'
      tags:
      - data-matching
      x-payment-info:
        price:
          amount: '0.01'
          currency: USD
          mode: fixed
        protocols:
        - x402
      x-search-tags:
      - household matching
      - contact deduplication
      - name and address matching
      - entity resolution
      - customer data cleansing
  /getaddressmatchadvanced:
    get:
      operationId: getaddressmatchadvanced
      parameters:
      - description: Street address for advanced matching
        example: 201 Spear St Ste 1100
        in: query
        name: address
        required: true
        schema:
          type: string
      - description: Zip code (optional but recommended for precision)
        in: query
        name: zip
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                Code: Success
                Credits: '0'
                SimKey: cD6eF8gHi0jKl2mN
          description: Successful response
        '400':
          description: Missing or invalid parameters
        '402':
          description: Payment Required. Returns an x402 challenge with payment requirements in the Payment-Required header and JSON body.
      security:
      - ApiKeyAuth: []
      - {}
      summary: 'US street address matching and deduplication: generates an AI-powered…'
      tags:
      - data-matching
      x-payment-info:
        price:
          amount: '0.01'
          currency: USD
          mode: fixed
        protocols:
        - x402
      x-search-tags:
      - address matching
      - address deduplication
      - household matching
      - fuzzy matching
      - location data cleansing
  /getcompanyandaddressmatch:
    get:
      operationId: getcompanyandaddressmatch
      parameters:
      - description: Full street address (US or international)
        example: 1 New Orchard Road
        in: query
        name: address
        required: true
        schema:
          type: string
      - description: Company or organization name
        example: IBM
        in: query
        name: company
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                Code: Success
                Credits: '0'
                SimKey: Xk7pR9vLmQ2wYdN1Ai4RfV0SRJf2dJwDO0C
          description: Successful response
        '400':
          description: Missing or invalid parameters
        '402':
          description: Payment Required. Returns an x402 challenge with payment requirements in the Payment-Required header and JSON body.
      security:
      - ApiKeyAuth: []
      - {}
      summary: 'Business location deduplication: generates one combined AI-powered similarity…'
      tags:
      - data-matching
      x-payment-info:
        price:
          amount: '0.01'
          currency: USD
          mode: fixed
        protocols:
        - x402
      x-search-tags:
      - business location matching
      - vendor deduplication
      - company name matching
      - entity resolution
      - master data management
  /getcompanyandfullnamematch:
    get:
      operationId: getcompanyandfullnamematch
      parameters:
      - description: Company or organization name
        example: IBM
        in: query
        name: company
        required: true
        schema:
          type: string
      - description: Full individual name
        example: James Johnston
        in: query
        name: fullname
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                Code: Success
                Credits: '0'
                SimKey: Xk7pR9vLmQ2wYdN1Ai4RfV0SRJf2dJwDO0C
          description: Successful response
        '400':
          description: Missing or invalid parameters
        '402':
          description: Payment Required. Returns an x402 challenge with payment requirements in the Payment-Required header and JSON body.
      security:
      - ApiKeyAuth: []
      - {}
      summary: 'Business contact deduplication: generates one combined AI-powered similarity…'
      tags:
      - data-matching
      x-payment-info:
        price:
          amount: '0.01'
          currency: USD
          mode: fixed
        protocols:
        - x402
      x-search-tags:
      - B2B contact matching
      - contact deduplication
      - CRM data cleansing
      - entity resolution
      - fuzzy matching
  /getcompanymatchadvanced:
    get:
      operationId: getcompanymatchadvanced
      parameters:
      - description: Company or organization name for advanced similarity key generation
        example: Gen Electric Corp
        in: query
        name: company
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                Code: Success
                Credits: '0'
                SimKey: eF5gHi8jKl2mNo4p
          description: Successful response
        '400':
          description: Missing or invalid parameters
        '402':
          description: Payment Required. Returns an x402 challenge with payment requirements in the Payment-Required header and JSON body.
      security:
      - ApiKeyAuth: []
      - {}
      summary: 'Company name matching and deduplication: generates an AI-powered similarity key…'
      tags:
      - data-matching
      x-payment-info:
        price:
          amount: '0.01'
          currency: USD
          mode: fixed
        protocols:
        - x402
      x-search-tags:
      - company name matching
      - deduplication
      - entity resolution
      - fuzzy matching
      - CRM data cleansing
  /getfullnamematch:
    get:
      operationId: getfullnamematch
      parameters:
      - description: Full individual name to generate a similarity key for
        example: Robert J. Smith
        in: query
        name: fullname
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                Code: Success
                Credits: '0'
                SimKey: xY2zAb4cDe8fGh1i
          description: Successful response
        '400':
          description: Missing or invalid parameters
        '402':
          description: Payment Required. Returns an x402 challenge with payment requirements in the Payment-Required header and JSON body.
      security:
      - ApiKeyAuth: []
      - {}
      summary: 'Person name matching and deduplication: generates an AI-powered similarity key…'
      tags:
      - data-matching
      x-payment-info:
        price:
          amount: '0.01'
          currency: USD
          mode: fixed
        protocols:
        - x402
      x-search-tags:
      - person name matching
      - contact deduplication
      - entity resolution
      - fuzzy matching
      - customer data cleansing
  /getfullnamematchscore:
    get:
      operationId: getfullnamematchscore
      parameters:
      - description: First full name
        example: Robert Smith
        in: query
        name: fullname1
        required: true
        schema:
          type: string
      - description: Second full name to compare
        example: Bob Smith Jr.
        in: query
        name: fullname2
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                Code: Success
                Credits: '0'
                Score: '88'
          description: Successful response
        '400':
          description: Missing or invalid parameters
        '402':
          description: Payment Required. Returns an x402 challenge with payment requirements in the Payment-Required header and JSON body.
      security:
      - ApiKeyAuth: []
      - {}
      summary: 'Person name match score: compares two individual names and returns a 0-100…'
      tags:
      - data-matching
      x-payment-info:
        price:
          amount: '0.01'
          currency: USD
          mode: fixed
        protocols:
        - x402
      x-search-tags:
      - person name matching
      - match score
      - identity resolution
      - fuzzy matching
      - record linkage
  /getglobaladdressmatch:
    get:
      operationId: getglobaladdressmatch
      parameters:
      - description: Full international address string
        example: 10 Downing Street, London, UK
        in: query
        name: address
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                Code: Success
                Credits: '0'
                SimKey: gH5iJk7lMn2oPq4r
          description: Successful response
        '400':
          description: Missing or invalid parameters
        '402':
          description: Payment Required. Returns an x402 challenge with payment requirements in the Payment-Required header and JSON body.
      security:
      - ApiKeyAuth: []
      - {}
      summary: 'International address matching: generates an AI-powered similarity key for a…'
      tags:
      - data-matching
      x-payment-info:
        price:
          amount: '0.01'
          currency: USD
          mode: fixed
        protocols:
        - x402
      x-search-tags:
      - international address matching
      - global address
      - address deduplication
      - fuzzy matching
      - location data cleansing
  /getorgmatchscore:
    get:
      operationId: getorgmatchscore
      parameters:
      - description: First organization name
        example: General Electric
        in: query
        name: org1
        required: true
        schema:
          type: string
      - description: Second organization name to compare
        example: GE Corp
        in: query
        name: org2
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                Code: Success
                Credits: '0'
                Score: '92'
          description: Successful response
        '400':
          description: Missing or invalid parameters
        '402':
          description: Payment Required. Returns an x402 challenge with payment requirements in the Payment-Required header and JSON body.
      security:
      - ApiKeyAuth: []
      - {}
      summary: 'Company name match score: compares two organization or company names and…'
      tags:
      - data-matching
      x-payment-info:
        price:
          amount: '0.01'
          currency: USD
          mode: fixed
        protocols:
        - x402
      x-search-tags:
      - company name matching
      - match score
      - entity resolution
      - fuzzy matching
      - record linkage
  /getproductmatch:
    get:
      operationId: getproductmatch
      parameters:
      - description: Product name, description, or model to generate a similarity key for
        example: Apple MacBook Pro 16 inch
        in: query
        name: product
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                Code: Success
                Credits: '0'
                SimKey: sT6uVw8xYz1aB3cD
          description: Successful response
        '400':
          description: Missing or invalid parameters
        '402':
          description: Payment Required. Returns an x402 challenge with payment requirements in the Payment-Required header and JSON body.
      security:
      - ApiKeyAuth: []
      - {}
      summary: 'Product name matching: generates an AI-powered similarity key for a product…'
      tags:
      - data-matching
      x-payment-info:
        price:
          amount: '0.01'
          currency: USD
          mode: fixed
        protocols:
        - x402
      x-search-tags:
      - product matching
      - SKU deduplication
      - catalog matching
      - price comparison
      - product data cleansing
components:
  securitySchemes:
    ApiKeyAuth:
      description: Interzoid API key. Omit to receive an x402 payment challenge instead.
      in: header
      name: x-api-key
      type: apiKey