Introdução à Referência da API
A DVS API é uma API JSON sobre HTTPS seguindo convenções REST. Todo endpoint requer autenticação e fica sob o path versionado /v1/.
Ambientes
O DVS expõe dois ambientes independentes. Todos os exemplos nesta documentação apontam por padrão para sandbox — migre para produção apenas quando a integração estiver validada.
| Ambiente | DVS API Base URL | OAuth Token URL |
|---|---|---|
| Sandbox | https://dvs-ingestion-api.sandbox.osigu.com | https://sandbox.osigu.com/v1/oauth/token |
| Produção | https://dvs-ingestion-api.osigu.com | https://api.osigu.com/v1/oauth/token |
Use sandbox enquanto constrói e valida a integração — mesmo contrato de API que produção, mas os dados são não tarifáveis e isolados. Migre para produção somente após os testes em sandbox passarem.
As credenciais são escopadas por ambiente: o client_id / client_secret que a OSIGU emitiu para sandbox não funcionará em produção, e vice-versa. Cada ambiente tem seu próprio endpoint de OAuth token.
Autenticação
Todos os endpoints requerem Authorization: Bearer <token>. Veja Obtendo Tokens.
Convenções
Content type
Todos os bodies são application/json UTF-8.
Identificadores
Todos os IDs de recurso são UUIDs (minúsculos, com hífens).
Timestamps
ISO 8601 UTC (2026-06-03T17:42:18.224Z).
Idempotency
Endpoints de mutação aceitam Idempotency-Key (UUID) com janela de deduplicação de 24h. Veja Idempotency.
Paginação
Endpoints de listagem suportam os query params page (base 1) e limit (padrão 50, máximo 200).
Erros
Envelope padrão: { error_code, message, additional_information }. Veja Erros.
Grupos de endpoints
Classifique documentos por tipo. Sync ou async com auto-validate opcional.
Execute extração + validation contra rule sets. Sempre async.
Descubra o que o tenant está autorizado a validar.
Teste agora
Toda página de endpoint tem um painel interativo "Try it". Cole o access token no campo Authorization e execute requests ao vivo contra a API.