Audit standardized entity classifications

POST

https://api.aventure.vc/v1/entities/classifications/audit

POST

/v1/entities/classifications/audit

$ curl -X POST https://api.aventure.vc/v1/entities/classifications/audit \
>      -H "X-Client-Secret: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "row": [
3     {
4       "ancestorChainCategory": [
5         "string"
6       ],
7       "entityId": "string",
8       "expectedHash": "string",
9       "join": [
10         {
11           "creatable": true,
12           "name": "string",
13           "writable": true,
14           "category": "string",
15           "id": 1,
16           "isCurrent": true,
17           "isPrimary": true,
18           "code": 1,
19           "createdAt": "2024-01-15T09:30:00Z",
20           "entityClassificationId": 1,
21           "level": 1,
22           "updatedAt": "2024-01-15T09:30:00Z"
23         }
24       ],
25       "joinCount": 1,
26       "multiplePrimaryCategory": [
27         "string"
28       ],
29       "publicVisible": true,
30       "name": "string",
31       "publicRoute": "string",
32       "slug": "string",
33       "type": "Company"
34     }
35   ],
36   "total": 1,
37   "nextCursor": "string"
38 }

Read-only audit of standardized classification joins. Supply entityId as a query parameter for one entity. During cursor migration, existing fleet clients may continue from raw UUID cursors; new fleet audits use the fleet endpoint.

Authentication

X-Client-Secretstring

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

Query parameters

entityIdstringOptionalformat: "uuid"

Entity UUID to audit.

cursorstringOptional

Raw UUID continuation returned by this keyset endpoint.

sizeintegerOptional

The size of the page to be returned; default 25, maximum 200.

includePrivatebooleanOptional

Include hidden and not-yet-published entities when authorized.

Request

This endpoint expects an object.

ancestorChainbooleanOptional

Only entities holding both an ancestor and its descendant code inside one hierarchical standardized category (ISIC, NAICS, SIC); descendant means the ancestor code digits are a strict prefix of the descendant code digits.

categorystring or nullOptional

Restrict to entities holding at least one join in this standardized category; matched rows still report the entity’s full standardized join set.

includePrivateboolean or nullOptional

Privileged read scope for admin callers. Includes hidden and not-yet-published entities. Defaults to private visibility for admin API key or ROLE_ADMIN callers; client-secret callers stay public.

minCountinteger or nullOptional>=1

Only entities with at least this many standardized joins; when omitted, entities with zero joins remain in the fleet audit.

multiplePrimarybooleanOptional

Only entities holding more than one primary join inside a single standardized category.

typeenum or nullOptional

Restrict to entities with this typeRecord, e.g. Company.

Response

rowlist of objects

Audited entities in entityId order.

totalinteger

Frozen snapshot total for fleet audits; keyset pages report page size.

nextCursorstring or nullOptional

Opaque continuation cursor; null on the last page.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

406

Not Acceptable Error

409

Conflict Error

415

Unsupported Media Type Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error