---
title: "Enhance"
method: GET
path: "/kg/v3/enhance"
tags: ["Enhance"]
---

# Enhance

`GET /kg/v3/enhance`

Enrich a person or organization record with partial data input

## Query parameters

- `type` 'Person' | 'Organization', enum
- `id` string
- `name` string[]
- `url` string[]
- `phone` string
- `email` string[]
- `employer` string
- `title` string
- `school` string
- `location` string
- `description` string
- `ip` string
- `customId` string
- `size` integer
- `threshold` number, double
- `refresh` boolean
- `search` boolean
- `nonCanonicalFacts` boolean
- `jsonmode` ' ' | 'extended'
- `filter` string
- `filterExclude` string

## Response `200`

Enhanced entity

- EnhanceResponse
  - `version` integer — Response version
  - `hits` integer — Number of matches returned
  - `kgversion` string — Version of KG that was queried
  - `request_ctx` RequestContext — Request context
    - `query` union — Submitted query
      - object
        - `type` string — Diffbot entity type
        - `location` string — Location of the entity to enhance. Parameter can be used with types `Person` and `Organization`
        - `ip` string — IP address of the entity to enhance. Parameter can be used with types `Person` and `Organization`
        - `phone` string — Phone of the entity to enhance. Parameter can be used with types `Person` and `Organization`
        - `description` string — Description of the entity to enhance. Parameter can be used with types `Person` and `Organization`
      - object
        - `type` string — Diffbot entity type
        - `location` string — Location of the entity to enhance. Parameter can be used with types `Person` and `Organization`
        - `ip` string — IP address of the entity to enhance. Parameter can be used with types `Person` and `Organization`
        - `phone` string — Phone of the entity to enhance. Parameter can be used with types `Person` and `Organization`
        - `description` string — Description of the entity to enhance. Parameter can be used with types `Person` and `Organization`
        - `email` FieldWrapper — Email of the entity to enhance. Parameter can be used only with type `Person`
          - `empty` boolean
        - `employer` string — Employer of the entity to enhance. Parameter can be used only with type `Person`
        - `title` string — Title of the entity to enhance. Parameter can be used only with type `Person`
        - `school` string — School of the entity to enhance. Parameter can be used only with type `Person`
    - `query_ctx` object — Query context. Example: submitted query parameters etc.
    - `threshold` RequestContext — recursive
    - `customId` RequestContext — recursive
  - `data` Data[]
    - `score` number, double — Enhance score
    - `entity` ObjectNode — Enhanced entity. Can be null if no entity was found.
    - `errors` string[]
    - `refreshInfo` object — Refresh info for debug
    - `refreshDelta` Delta
    - `entity_ctx` object — Entity-level context
  - `errors` string[]
  - `searchInfo` object — Search info for debug

## Other responses

- `400` — Error parsing request
- `401` — Token not specified or other client errors
- `429` — Insufficient credits
- `500` — Internal Server Error

---

[API](https://skmtc.dev/diffbot/apis/web-search.md) · [All operations](https://skmtc.dev/diffbot/apis/web-search/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/diffbot/web-search/revisions/8b88d7dabe63/schema)
