---
title: "Duplicate Suggestions"
method: POST
path: "/api/v1/organizations/{org_id}/duplicate-suggestions"
tags: ["include_in_client_gen"]
---

# Duplicate Suggestions

`POST /api/v1/organizations/{org_id}/duplicate-suggestions`

## Request

- Base URL: `https://app.sagecare.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://app.sagecare.ai/api/v1/organizations/{org_id}/duplicate-suggestions`
- Auth: API key in header `X-Session-Token`

Return possible duplicate records for a new entity.

## Path parameters

- `org_id` integer, required

## Request body

- DuplicateSuggestionsRequest
  - `subject` DuplicateSuggestionSubject, required
    - `kind` 'client' | 'contact' | 'referrer' | 'institution', required
    - `first_name` string
    - `last_name` string
    - `name` string
    - `emails` Email[]
      - `email_type` union
        - 'personal' | 'work' | 'other'
        - string
      - `email` string, email, required
    - `phone_numbers` PhoneNumber[]
      - `phone_type` union, required
        - 'home' | 'mobile' | 'work' | 'fax' | 'other': Phone number type choices
        - string
      - `number` string, required: US phone number
    - `addresses` Address[]
      - `address_type` union, required
        - 'home' | 'work' | 'mailing' | 'other': Address type choices
        - string
      - `address_line1` string
      - `address_line2` string
      - `city` string
      - `state` union
        - 'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'DC' | 'PR' | 'VI' | 'GU' | 'AS' | 'MP': US State abbreviations
        - string
      - `zip_code` union
        - string: US Postal Service ZIP code (5 digit format or ZIP+4 format)
        - string
    - `birth_date` string, date, nullable
  - `limit` integer

## Response `200`

OK

- DuplicateSuggestionsResponse
  - `subject` DuplicateSuggestionSubject, required
    - `kind` 'client' | 'contact' | 'referrer' | 'institution', required
    - `first_name` string
    - `last_name` string
    - `name` string
    - `emails` Email[]
      - `email_type` union
        - 'personal' | 'work' | 'other'
        - string
      - `email` string, email, required
    - `phone_numbers` PhoneNumber[]
      - `phone_type` union, required
        - 'home' | 'mobile' | 'work' | 'fax' | 'other': Phone number type choices
        - string
      - `number` string, required: US phone number
    - `addresses` Address[]
      - `address_type` union, required
        - 'home' | 'work' | 'mailing' | 'other': Address type choices
        - string
      - `address_line1` string
      - `address_line2` string
      - `city` string
      - `state` union
        - 'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'DC' | 'PR' | 'VI' | 'GU' | 'AS' | 'MP': US State abbreviations
        - string
      - `zip_code` union
        - string: US Postal Service ZIP code (5 digit format or ZIP+4 format)
        - string
    - `birth_date` string, date, nullable
  - `generated_by` 'rules' | 'ai', required
  - `suggestions` DuplicateSuggestion[], required
    - `record` DuplicateSuggestionRecord, required
      - `kind` 'client' | 'contact' | 'referrer' | 'institution', required
      - `id` integer, required
      - `display_name` string, required
      - `url` string, required
      - `subtitle` string
    - `strength` 'exact' | 'strong' | 'possible', required
    - `reasons` DuplicateSuggestionReason[], required
      - `label` string, required
      - `input_value` string
      - `matched_value` string
    - `explanation` string
  - `total` integer, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Content

---

[API](https://skmtc.dev/sagecare/apis/sage-api-v1.md) - [All operations](https://skmtc.dev/sagecare/apis/sage-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/sagecare/apis/sage-api-v1/revisions/36b26ceace69?raw)
