Optimus Integration API
Use the Optimus Integration API when your application can send JSON requests directly over HTTPS.
The API validates VAT IDs, compares company master data, returns corrected values when available, and can create PDF report metadata for validation runs.
Base URLs
| Environment | Base URL |
|---|---|
| Production | https://app.optimussoftware.de |
| Test | https://dev.app.optimussoftware.de |
Authentication
Create a Personal Access Token in the Optimus web app under Settings > API Interface > API Tokens.
Authenticate every request by sending the token in the Authorization header with the Bearer scheme:
Authorization: Bearer <token>
The token secret is shown only once when it is created. Do not store real tok_optimus_ values in source code, logs, issue trackers, screenshots, or documentation examples.
Which Endpoint Should I Use?
| Goal | Endpoint |
|---|---|
| Resolve one VAT ID quickly | GET /api/v1/integration/vat/resolve |
| Find VAT IDs from company data | POST /api/v1/integration/vat/lookup |
| Validate one or more records and wait for the result | POST /api/v1/integration/vat/validations |
| Start a longer validation run and poll until it completes | POST /api/v1/integration/vat/validations/async |
| Retrieve a validation run later | GET /api/v1/integration/vat/validations/{operationId} |
Use asynchronous validation for automated imports, larger batches, retry-safe integrations, and PDF-producing workflows.
Authentication
- HTTP: Bearer Auth
Paste your Personal Access Token. Requests will be sent with Authorization: Bearer <token>.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | PAT |