Review entity duplicate gates (GET)

GET

https://api.aventure.vc/v1/entities/duplicate-check

GET

/v1/entities/duplicate-check

$ curl -G https://api.aventure.vc/v1/entities/duplicate-check \
>      -H "X-Client-Secret: <apiKey>" \
>      -d excludeId=04e2bf9c-a100-72ad-83ff-ba69c647b30b \
>      -d includePrivate=false \
>      -d location=Portland \
>      -d nameAny=Omorpho \
>      -d nameBrand=Omorpho \
>      --data-urlencode "nameLegal=Omorpho, Inc." \
>      -d page=0 \
>      -d productServiceProviderId=04e2bf9c-a100-72ad-83ff-ba69c647b30b \
>      -d size=10 \
>      -d slug=omorpho-portland-or-us \
>      -d typeRecord=Company \
>      --data-urlencode url=https://omorpho.com \
>      -d urlDomain=omorpho.com \
>      -d urlMatchMode=hostPath \
>      -d urlStrictness=strict \
>      -d urlType=website

1 {
2   "content": [
3     {
4       "id": "string",
5       "image": {
6         "isMonogram": true,
7         "logo": "string",
8         "logoSquare": "string"
9       },
10       "nameAlias": [
11         {
12           "name": "Bun",
13           "displayable": true,
14           "type": "alternativeDba"
15         }
16       ],
17       "nameBrand": "string",
18       "slug": "aventure-vc",
19       "createdAt": "2024-01-15T09:30:00Z",
20       "defaultCurrency": "string",
21       "foundedYear": 1,
22       "lastModifiedAt": "2024-01-15T09:30:00Z",
23       "nameLegal": "string",
24       "operatingStatus": "string",
25       "publicId": "eV1StGXR8Z5a",
26       "publicUrl": "string",
27       "sitemap": {
28         "hasAnalysis": true,
29         "hasEmployees": true,
30         "hasFundraising": true,
31         "hasNews": true,
32         "productServiceSlug": [
33           "string"
34         ],
35         "hasAcquisitions": false
36       },
37       "typeRecord": "Company",
38       "updatedAt": "2024-01-15T09:30:00Z"
39     }
40   ],
41   "empty": true,
42   "first": true,
43   "last": true,
44   "number": 1,
45   "numberOfElements": 1,
46   "pageable": {
47     "offset": 1,
48     "pageNumber": 1,
49     "pageSize": 1,
50     "paged": true,
51     "sort": {
52       "empty": true,
53       "sorted": true,
54       "unsorted": true
55     },
56     "unpaged": true
57   },
58   "size": 1,
59   "sort": {
60     "empty": true,
61     "sorted": true,
62     "unsorted": true
63   },
64   "totalElements": 1,
65   "totalPages": 1
66 }

Review duplicate candidates before entity create or update using slug, names, URLs, or domains. Empty results are not proof no entity exists; 409 create responses remain authoritative. Use entity detail for exact lookups and entity list for browsing.

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

contentlist of objectsOptional

emptybooleanOptional

firstbooleanOptional

lastbooleanOptional

numberintegerOptional

numberOfElementsintegerOptional

pageableobjectOptional

sizeintegerOptional

sortobjectOptional

totalElementslongOptional

totalPagesintegerOptional

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