Registry
Overview
Company registry lookups against configured upstream registries: search/get companies, documents, files, metadata kinds, and upstream health probes.
API
{pe} = /projects/{projectId}/environments/{environmentId}.
| Method | Path | Notes |
|---|---|---|
| GET | /registry/health | Health |
| GET | /registry{pe}/companies | RequireAuthorization — search |
| GET | /registry{pe}/companies/{registryId} | RequireAuthorization |
| GET | /registry{pe}/companies/{registryId}/documents | RequireAuthorization |
| GET | /registry{pe}/files | RequireAuthorization |
| GET | /registry{pe}/metadata/{kind} | RequireAuthorization |
| GET | /registry{pe}/upstream-health | RequireAuthorization — upstream probe |
Clients
| Package | Runtime |
|---|---|
@vijihub/registry | server |
VijiHub.Registry | .NET |
Implementation
- Enable Registry and configure upstream provider credentials.
- Call search and document APIs from a trusted backend with Bearer auth.
- Use
upstream-healthto verify connectivity before user-facing flows. - Cache responses where upstream rate limits are strict.
Constraints
- All data APIs require authorization — not browser-scoped ingest.
- Upstream availability and legal use of registry data are outside VijiHub’s control; check provider terms.
- Treat returned company documents as sensitive.