Skip to main content
PUT
Upsert

Overview

The upsert endpoint intelligently creates a new entity or updates an existing one based on configurable duplicate detection strategies. It automatically handles conflicts and prevents duplicate records using exact matching, fuzzy matching, or AI-powered similarity detection.

Endpoint

Authentication

Requires a valid API key in the Authorization header:

Request Body

object
required
The entity data (same structure as Create Entity), including optional root fields such as email, phone, and nationality (ISO 3166-1 alpha-2 or mappable label).
The JSON schema may allow the same keys as create (e.g. monitoring, autoExecuteIntegrations). Upsert does not run creation-time auto-enrichments or apply monitoring. Use POST /entities or POST /entities/automatic for watchlist / Regtia op 1 behavior during enrichment.
object
Configuration options for upsert behavior
enum
How to handle conflicts when an existing entity is found:
  • source_wins - New data overwrites existing data
  • target_wins - Keep existing data, ignore new data
  • manual_review - Flag for manual review without updating
  • smart_merge (default) - Intelligently merge both datasets
enum
Strategy for detecting duplicate entities:
  • exact_match - Match by externalId and taxId (case-insensitive)
  • fuzzy_match - Similarity matching on name and taxId (80% threshold)
  • ai_similarity - AI-powered semantic similarity detection
  • hybrid (recommended) - Exact match with fuzzy fallback
boolean
default:"true"
Whether to automatically create relationships between entities

Response

boolean
Indicates if the operation succeeded
string
The action performed: created or updated
object
The final entity state after upsert
object
The entity state before update (null if newly created)
number
Confidence score (0-1) for the duplicate detection match
string
Explanation of why the entity was created/updated
array
Array of field-level conflicts detected during merge (if any)

Deduplication Strategies

Exact Match

Matches entities based on exact field comparison (case-insensitive):
  • Fields: externalId, taxId
  • Use case: When you have reliable unique identifiers
  • Speed: Fastest
  • Accuracy: 100% for identical values

Fuzzy Match

Uses Levenshtein distance for similarity matching:
  • Fields: name, taxId
  • Threshold: 80% similarity
  • Use case: When dealing with typos or variations
  • Speed: Moderate
  • Accuracy: High for similar strings

AI Similarity

AI-powered semantic similarity detection:
  • Method: Vector embeddings and cosine similarity
  • Use case: Complex multi-field matching
  • Speed: Slower
  • Accuracy: Highest for semantically similar entities
Combines exact and fuzzy matching:
  • Primary: Exact match on identifiers
  • Fallback: Fuzzy match on names
  • Confidence threshold: 80%
  • Use case: Best balance of speed and accuracy

Conflict Resolution Strategies

smart_merge (Default)

Intelligently merges data from both sources:
  • Priority: Newer data for simple fields
  • Arrays: Merges and deduplicates
  • Objects: Deep merge with conflict detection
  • Empty values: Preserves non-empty existing values

source_wins

New data completely replaces existing:
  • Use case: When incoming data is authoritative
  • Behavior: All fields from source
  • Risk: May lose valuable existing data

target_wins

Keeps existing data, ignores incoming:
  • Use case: When existing data is authoritative
  • Behavior: No updates performed
  • Risk: May miss important updates

manual_review

Flags conflicts without auto-resolution:
  • Use case: High-stakes data requiring human review
  • Behavior: Creates review task
  • Result: Entity marked for manual resolution

Examples

Simple Upsert (Default Behavior)

Upsert with Exact Match Strategy

Upsert with Fuzzy Matching

Response Examples

Created New Entity

Updated Existing Entity

Use Cases

Data Import from External System

Progressive Data Enrichment

Best Practices

  1. Choose the Right Strategy:
    • exact_match for clean, structured data with reliable IDs
    • fuzzy_match for user-entered data with potential typos
    • hybrid for most production scenarios
  2. Handle Conflicts Gracefully:
    • Use smart_merge for automatic resolution
    • Use manual_review for critical financial data
    • Check conflicts array in response for important changes
  3. Monitor Confidence Scores:
    • Scores below 0.7 may indicate weak matches
    • Log low-confidence updates for review
    • Consider manual review threshold
  4. Relationship Management:
    • Set createRelationships: true to auto-link related entities
    • Useful for transaction-customer, company-person relationships

Error Responses

400 Bad Request

400 Missing Required Fields

500 Internal Server Error

Next Steps