aVenture APIEntities V1

Score entity duplicate candidates (GET)

View as Markdown

Return scored duplicate candidates for entity identity signals. Results are ordered by score; custom sorting is not supported.

Authentication

X-Client-Secretstring

Client secret for read-only service-to-service access (no writes)

Query parameters

excludeIdstringOptionalformat: "uuid"

Entity id to exclude from duplicate candidates; not a lookup id

slugstringOptional

URL-safe identifier

typeRecordenumOptional
Entity type
nameAnystringOptional
Loose name match
nameBrandstringOptional
Brand name
nameLegalstringOptional
Legal name
locationstringOptional
Location
urlstringOptional
Joined entity URL
urlDomainstringOptional
URL domain match
urlTypeenumOptional
URL type
urlMatchModeenumOptional
URL match mode
Allowed values:
urlStrictnessenumOptional
Optional URL match strictness. Omit for strict matching. Send loose or any only when the caller intentionally widens URL matching.
Allowed values:
urlCandidatelist of objectsOptional
Additional URL candidates to match
productServiceProviderIdstringOptionalformat: "uuid"

Provider entity UUID that scopes Product/Service duplicate candidates to that provider’s current productService catalog, including hidden rows. Product and Service slugs are provider-pair scoped, so cross-provider name reuse is not a duplicate; supply this id to review the one catalog that can collide.

pageintegerOptional

Zero-based page index (0..N)

sizeintegerOptional

The size of the page to be returned; duplicate-check default 10, maximum 100.

sortlist of stringsOptional
Sorting is not supported
includePrivatebooleanOptional

Privileged read scope for admin callers. Bypasses the public visibility filter so hidden, unverified, and not-yet-published records are returned instead of being silently dropped. Defaults to private for admin API key or ROLE_ADMIN callers; client-secret/client-read callers stay public.

Response

OK

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error