Score person duplicate candidates (GET)

GET

https://api.aventure.vc/v1/people/duplicate-check/candidates

GET

/v1/people/duplicate-check/candidates

$ curl -G https://api.aventure.vc/v1/people/duplicate-check/candidates \
>      -H "X-Client-Secret: <apiKey>" \
>      -d excludeId=01993139-fc36-7c18-bbe3-7375efd62f00 \
>      -d includePrivate=false \
>      --data-urlencode "location=San Francisco" \
>      -d nameAny=Kan \
>      --data-urlencode "nameFull=Kan Cao" \
>      -d page=0 \
>      -d size=10 \
>      -d slug=kan-cao \
>      --data-urlencode url=https://linkedin.com/in/kancao \
>      -d urlDomain=linkedin.com \
>      -d urlMatchMode=hostPath \
>      -d urlStrictness=strict \
>      -d urlType=linkedin

1 {
2   "content": [
3     {
4       "id": "string",
5       "reason": [
6         "string"
7       ],
8       "score": 1,
9       "externalId": "string",
10       "name": "string",
11       "operatingStatus": "string",
12       "publicPath": "string",
13       "slug": "aventure-vc",
14       "typeRecord": "Company"
15     }
16   ],
17   "empty": true,
18   "first": true,
19   "last": true,
20   "number": 1,
21   "numberOfElements": 1,
22   "pageable": {
23     "offset": 1,
24     "pageNumber": 1,
25     "pageSize": 1,
26     "paged": true,
27     "sort": {
28       "empty": true,
29       "sorted": true,
30       "unsorted": true
31     },
32     "unpaged": true
33   },
34   "size": 1,
35   "sort": {
36     "empty": true,
37     "sorted": true,
38     "unsorted": true
39   },
40   "totalElements": 1,
41   "totalPages": 1
42 }

Return scored duplicate candidates for people queries. Results are ordered by match score; custom sorting is not supported. Exact same-name results after excludeId review are human identity review signals, not automatic merge proof.

Authentication

X-Client-Secretstring

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

Query parameters

excludeIdstringOptionalformat: "uuid"

Current person id to omit from post-bootstrap duplicate audits while same-name candidates are reviewed.

slugstringOptional

URL-safe identifier

nameFullstringOptional

Full name

nameAnystringOptional

Loose name match

locationstringOptional

Location

urlstringOptional

Profile 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

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