Référence API
Documentation REST API complète pour la plateforme VynCo d'intelligence sur les entreprises suisses
https://api.vynco.ch/v1Authentication
All API requests require a Bearer token in the Authorization header. Two token types are supported:
Generated in the dashboard. Use vc_live_* for production and vc_test_* for sandbox. Validated via Argon2id hash lookup.
Microsoft Entra ID JWT tokens for enterprise SSO integrations. Same Bearer format, resolved to a team context automatically.
Example Request
curl "https://api.vynco.ch/v1/companies?search=Nestl%C3%A9" \ -H "Authorization: Bearer vc_live_abc123..."Response Headers
Every API response includes the following headers for observability, OGD compliance, and credit tracking.
| Header | Description |
|---|---|
X-Request-Id | Unique request identifier for support and tracing |
X-Credits-Used | Credits consumed by this request |
X-Credits-Remaining | Remaining credit balance after this request |
X-Rate-Limit-Limit | Maximum requests per minute for your tier |
X-Data-Source | OGD compliance: source registry ("Zefix" or "LINDAS") |
Companies
Search and retrieve Swiss company data from the Zefix registry. Each lookup or search costs 1 credit; enriched profiles cost 5 credits.
/v1/companiesSearch Swiss companies by name, canton, or legal form
This is a demo playground. No real API calls are made.
Changes
Track registry mutations — address changes, auditor changes, capital increases, board member updates. Each change feed query costs 2 credits.
Persons
Look up individuals and their board memberships across the registry. Person lookups cost 3 credits.
Dossiers
Generate AI-powered company dossiers using an LLM with full access to registry data, change history, and enrichment. Credit cost depends on the dossier level.
Analytics
Run machine-learning analytics on the full Swiss company registry. Clustering costs 15 credits, anomaly detection costs 15 credits, and cohort analysis costs 20 credits. All analytics endpoints require the Professional tier or above.
Relationships
Navigate parent/subsidiary corporate structures. Each relationships or hierarchy query costs 10 credits.
News & Reports
Fetch company news from SIX and public sources (2 credits per company, 1 credit for the global feed) and parsed annual financial reports (5 credits per company).
Comparison
Compare two or more companies side-by-side in a single request. Costs 5 credits per request regardless of the number of companies compared (2–10).
Watches & Notifications
Watch companies to receive notifications when registry changes are detected. Watch management and notification retrieval do not consume credits.
OpenAPI Specification
The full OpenAPI 3.0 specification is available for self-discovery, SDK generation, and integration with tools like Postman, Insomnia, or Swagger UI. No authentication is required to fetch the spec.
OpenAPI endpoint
curl "https://api.vynco.ch/api/v1/openapi.json"Management
Team, API key, and credit management endpoints. These operations do not consume credits.
Teams
API Keys
Credits
Error Reference
All error responses follow the RFC 7807 Problem Details format with consistent structure across all endpoints.
{ "type": "https://api.vynco.ch/errors/insufficient-credits", "title": "Insufficient Credits", "status": 402, "detail": "This request requires 50 credits but only 12 remain.", "instance": "/v1/dossiers", "creditsRequired": 50, "creditsAvailable": 12}HTTP Status Codes
| Status | Title | Description |
|---|---|---|
| 400 | Bad Request | The request body or parameters are invalid |
| 401 | Unauthorized | Missing or invalid API key / JWT token |
| 402 | Insufficient Credits | Credit balance too low for this operation |
| 403 | Forbidden | API key lacks permission for this action |
| 404 | Not Found | The requested resource does not exist |
| 429 | Too Many Requests | Rate limit exceeded — check the Retry-After header |
| 500 | Internal Server Error | An unexpected error occurred on our end |
Rate Limits
API requests are rate-limited per tier. When you exceed your limit, the API returns a 429 Too Many Requests response with a Retry-After header. The current limit is also returned in every response via X-Rate-Limit-Limit.
| Tier | Rate Limit |
|---|---|
| Free | 10/min |
| Starter | 60/min |
| Professional | 300/min |
| Enterprise | 1,000/min |