Check for duplicate customers

POST /api/v1/customers/check-duplicates

Check if a customer already exists using name, email, tax ID similarity.

Operation ID: check_duplicates_api_v1_customers_check_duplicates_post · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

name string required: Customer name to check
email string: Email to check
tax_id string: Tax ID to check
exclude_id string: Customer ID to exclude (for updates)

Responses

201 Successful Response

Schema: DuplicateCheckResponse

has_duplicates boolean required

Whether duplicates were found.

duplicates array · DuplicateCandidateResponse DuplicateCandidateResponse

List of potential duplicates.

5 fields

id string required: Customer UUID.
name string required: Customer name.
email string: Customer email.
similarity_score number required: Similarity score (0.0-1.0).
match_type string required: Type of match (name, email, tax_id, phone).

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

POST /api/v1/customers/check-duplicates

bash

curl -X POST 'https://api.ondayzero.com/api/v1/customers/check-duplicates' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/customers/check-duplicates', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.post("https://api.ondayzero.com/api/v1/customers/check-duplicates", headers=headers)
data = response.json()