API Reference Introduction
The DVS API is a JSON over HTTPS API following REST conventions. Every endpoint requires authentication and lives under the /v1/ versioned path.
Environments
DVS exposes two independent environments. All examples in this documentation default to sandbox — switch to production only when your integration is validated.
| Environment | DVS API Base URL | OAuth Token URL |
|---|---|---|
| Sandbox | https://dvs-ingestion-api.sandbox.osigu.com | https://sandbox.osigu.com/v1/oauth/token |
| Production | https://dvs-ingestion-api.osigu.com | https://api.osigu.com/v1/oauth/token |
Use sandbox while building and validating your integration — same API contract as production, but data is non-billable and isolated. Switch to production only after sandbox testing passes.
Credentials are environment-scoped: the client_id / client_secret OSIGU issued you for sandbox will not work in production, and vice versa. Each environment has its own OAuth token endpoint.
Authentication
All endpoints require Authorization: Bearer <token>. See Obtaining Tokens.
Conventions
Content type
All bodies are application/json UTF-8.
Identifiers
All resource IDs are UUIDs (lowercase, hyphenated).
Timestamps
ISO 8601 UTC (2026-06-03T17:42:18.224Z).
Idempotency
Mutating endpoints accept Idempotency-Key (UUID) with a 24h dedup window. See Idempotency.
Pagination
List endpoints support page (1-based) and limit (default 50, max 200) query params.
Errors
Standard envelope: { error_code, message, additional_information }. See Errors.
Endpoint groups
Classify documents by type. Sync or async with optional auto-validate.
Run extraction + validation against rule sets. Always async.
Discover what your tenant is authorized to validate.
Try it out
Every endpoint page has an interactive "Try it" panel. Paste your access token in the Authorization field and execute live requests against the API.