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

Create a new user

Request

Accepts a JSON payload to register a new user with required and optional user data.

Security
PublicApiKey
Bodyapplication/jsonrequired
usernamestringrequired
lastNamestring
firstNamestring
passwordstringrequired
emailstring(email)required
organizationIdstring
vatNumberstring
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/users/new \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "string",
    "lastName": "string",
    "firstName": "string",
    "password": "string",
    "email": "user@example.com",
    "organizationId": "string",
    "vatNumber": "string"
  }'

Responses

User created successfully.

Bodyapplication/json
userIdstringrequired

Unique identifier for the user account.

Example: "6787a98e15306d37eed688a8"
Response
application/json
{
  "userId": "6787a98e15306d37eed688a8"
}

Deactivate a user account

Request

Accepts a JSON payload to deactivate a user account with required and optional user data.

Security
PublicApiKey
Bodyapplication/jsonrequired
userIdstringrequired
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/users/deactivate \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "string"
  }'

Responses

User deactivate successfully.

Bodyapplication/json
userIdstringrequired
statusstringrequired
Response
application/json
{
  "userId": "string",
  "status": "string"
}

Reactivate a user account

Request

Accepts a JSON payload to reactivate a user account with required and optional user data.

Security
PublicApiKey
Bodyapplication/jsonrequired
userIdstringrequired
curl -i -X POST \
  https://omnizon-public-api.redocly.app/_mock/openapi/rest/v1/users/reactivate \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "string"
  }'

Responses

User reactivate successfully.

Bodyapplication/json
userIdstringrequired
statusstringrequired
Response
application/json
{
  "userId": "string",
  "status": "string"
}

Billing

Usage metrics and billing information

Operations

ApiKeys

API key generation and management

Operations

Schemas

Schemas