Interzoid Data Enhancement 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 Enhancement 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-enhancement
paths:
  /addressparse:
    get:
      operationId: addressparse
      parameters:
      - description: Full address string to parse into components
        example: 201 Spear Street Suite 1100 San Francisco CA 94105
        in: query
        name: address
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                AdditionalInformation: ''
                BuildingName: ''
                City: San Francisco
                Code: Success
                Country: ''
                Credits: '0'
                Organization: ''
                PostDirection: ''
                PostalCode: '94105'
                PreDirection: ''
                Special: ''
                StateProvince: CA
                StreetName: Spear
                StreetNumber: '201'
                StreetSuffix: St
                UnitNumber: '1100'
                UnitType: Ste
          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: 'Address parsing: splits a full address string into its components: street…'
      tags:
      - data-enhancement
      x-payment-info:
        price:
          amount: '0.01'
          currency: USD
          mode: fixed
        protocols:
        - x402
      x-search-tags:
      - address parsing
      - address parser
      - address standardization
      - address cleansing
      - data quality
  /getentitytype:
    get:
      operationId: getentitytype
      parameters:
      - description: Data value to determine entity type for
        example: IBM Corporation
        in: query
        name: text
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                Code: Success
                Credits: '0'
                Result: Organization
          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: 'Entity type classification: determines whether a data value is a person…'
      tags:
      - data-enhancement
      x-payment-info:
        price:
          amount: '0.01'
          currency: USD
          mode: fixed
        protocols:
        - x402
      x-search-tags:
      - entity classification
      - data profiling
      - person or company
      - named entity recognition
      - data quality
  /getgender:
    get:
      operationId: getgender
      parameters:
      - description: Individual name to determine gender for
        example: Maria
        in: query
        name: name
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                Code: Success
                Credits: '0'
                Gender: Female
          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: 'Gender from a name: determines the likely gender for a first or full name…'
      tags:
      - data-enhancement
      x-payment-info:
        price:
          amount: '0.01'
          currency: USD
          mode: fixed
        protocols:
        - x402
      x-search-tags:
      - gender detection
      - name analysis
      - demographics
      - marketing personalization
      - first name lookup
  /getnameorigin:
    get:
      operationId: getnameorigin
      parameters:
      - description: Individual name to determine origin for
        example: Yuki Tanaka
        in: query
        name: name
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                Code: Success
                Credits: '0'
                Origin: Japanese
          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: 'Name origin: identifies the likely country or cultural origin of a person''s…'
      tags:
      - data-enhancement
      x-payment-info:
        price:
          amount: '0.01'
          currency: USD
          mode: fixed
        protocols:
        - x402
      x-search-tags:
      - name origin
      - name analysis
      - demographics
      - localization
      - cultural origin
  /getzipcodeinfo:
    get:
      operationId: getzipcodeinfo
      parameters:
      - description: US ZIP code (5-digit)
        example: '94105'
        in: query
        name: zip
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                City: San Francisco
                Code: Success
                County: San Francisco
                Credits: '0'
                Latitude: '37.7891'
                Longitude: '-122.3952'
                State: CA
          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 ZIP code lookup: returns the city, state, county, time zone, area codes, and…'
      tags:
      - data-enhancement
      x-payment-info:
        price:
          amount: '0.01'
          currency: USD
          mode: fixed
        protocols:
        - x402
      x-search-tags:
      - ZIP code lookup
      - geocoding
      - address validation
      - US postal codes
      - location data
  /identifylanguage:
    get:
      operationId: identifylanguage
      parameters:
      - description: Text to identify the language of
        example: Bonjour comment allez-vous
        in: query
        name: text
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                Code: Success
                Credits: '0'
                Language: French
          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: 'Language detection: identifies the language of a text string across many world…'
      tags:
      - data-enhancement
      x-payment-info:
        price:
          amount: '0.01'
          currency: USD
          mode: fixed
        protocols:
        - x402
      x-search-tags:
      - language detection
      - language identification
      - text analysis
      - NLP
      - translation pipeline
  /translatetoany:
    get:
      operationId: translatetoany
      parameters:
      - description: Text to translate
        example: hello world
        in: query
        name: text
        required: true
        schema:
          type: string
      - description: Target language name (e.g. "Japanese", "French", "Spanish")
        example: Japanese
        in: query
        name: to
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                Code: Success
                Credits: '0'
                Result: こんにちは世界
          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: 'Translate text to any language: detects the source language and translates into…'
      tags:
      - data-enhancement
      x-payment-info:
        price:
          amount: '0.01'
          currency: USD
          mode: fixed
        protocols:
        - x402
      x-search-tags:
      - translation
      - machine translation
      - localization
      - multilingual
      - language translation
  /translatetoenglish:
    get:
      operationId: translatetoenglish
      parameters:
      - description: Text in any language to translate to English
        example: hola mundo
        in: query
        name: text
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                Code: Success
                Credits: '0'
                Translation: Hello World
          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: 'Translate any language to English: detects the source language and returns an…'
      tags:
      - data-enhancement
      x-payment-info:
        price:
          amount: '0.01'
          currency: USD
          mode: fixed
        protocols:
        - x402
      x-search-tags:
      - translation
      - translate to English
      - language detection
      - multilingual
      - machine translation
components:
  securitySchemes:
    ApiKeyAuth:
      description: Interzoid API key. Omit to receive an x402 payment challenge instead.
      in: header
      name: x-api-key
      type: apiKey