Skip to content

Omnizon Public REST API (v1.0.0)

This is the Omnizon Platform Public REST API specification. For access and API Keys please contact your Omnizon Platform representative.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://omnizon-public-api.redocly.app/_mock/openapi
U-DEV testing environment
https://{tenant}.u-dev.omnizon.network/api

Organizations

Company registration and management operations

Operations

Documents

Invoice/document processing and status management

Operations

Users

User account management operations

Operations

Billing

Usage metrics and billing information

Operations

ApiKeys

API key generation and management

Operations

Generate API key for organization

Request

Generate a new API key for the specified organization based on VAT number

Security
PublicApiKey
Bodyapplication/jsonrequired
vatNumberstring[ 8 .. 15 ] charactersrequired

VAT number of organization for which to generate API key

Example: "12345678901"
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/apikeys/generate \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "vatNumber": "12345678901"
  }'

Responses

API key generated successfully

Bodyapplication/json
apiKeystring

Generated API key value (encrypted)

Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
Response
application/json
{
  "apiKey": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Generate extended API key for organization

Request

Generate a new extended API key (with embedded URL) for the specified organization based on VAT number

Security
PublicApiKey
Bodyapplication/jsonrequired
vatNumberstring[ 8 .. 15 ] charactersrequired

VAT number of organization for which to generate API key

Example: "12345678901"
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/apikeys/generateExtended \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "vatNumber": "12345678901"
  }'

Responses

Extended API key generated successfully

Bodyapplication/json
apiKeystring

Generated API key value (encrypted)

Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
Response
application/json
{
  "apiKey": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Schemas

Schemas