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