API Documentation

Welcome to the Aevum Zenth Unified API. This RESTful interface provides programmatic access to our global enterprise data, financial instruments, operational metrics, and cross-divisional services. The API follows standard HTTP conventions, returns JSON responses, and supports OAuth 2.0 and API Key authentication.

Example Request
curl -X GET https://api.aevumzenth.com/v3/entities \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

Base URL & Environments

EnvironmentBase URLPurpose
Productionhttps://api.aevumzenth.com/v3Live data & transactions
Sandboxhttps://sandbox.api.aevumzenth.com/v3Testing & development
Staginghttps://staging.api.aevumzenth.com/v3Pre-release validation

All endpoints are prefixed with /v3. Versioning follows semantic versioning. Breaking changes will trigger a new major version with a 12-month deprecation notice.

Authentication

Aevum Zenth supports two authentication methods. API Keys are recommended for server-to-server integrations, while OAuth 2.0 is required for user-facing applications accessing scoped data.

API Key

Include your secret key in the X-Aevum-Key header or as a bearer token.

Header Format
Authorization: Bearer az_live_sk_8f7a9b2c4d5e6f0123456789abcdef
X-Aevum-Key: az_live_sk_8f7a9b2c4d5e6f0123456789abcdef

OAuth 2.0

Use the standard authorization code flow. Supported scopes include entities:read, transactions:write, analytics:export.

Entities

Manage subsidiaries, divisions, and operational nodes within the conglomerate structure.

GET /v3/entities

List All Entities

Retrieve a paginated list of all registered entities with filtering by division, status, and region.

ParameterTypeDescription
divisionoptionalstringFilter by division slug (e.g., energy, tech, aerospace)
statusoptionalstringactive, suspended, dormant
limitoptionalintegerResults per page (max 100, default 20)
200 OK
{
  "data": [
    {
      "id": "ent_9x8c7v6b5n4m3",
      "name": "Zenth Digital Systems",
      "division": "technology",
      "status": "active",
      "registered_date": "2021-04-12",
      "headquarters": {
        "city": "Neo Geneva",
        "region": "EMEA",
        "coordinates": { "lat": 46.2044, "lng": 6.1432 }
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 400,
    "has_more": true
  }
}
POST /v3/entities

Create Entity

Register a new subsidiary or operational unit. Requires admin:write permissions.

Request Body
{
  "name": "Aevum Orbital Logistics",
  "division": "logistics",
  "type": "subsidiary",
  "compliance_tier": "tier_1",
  "initial_capital": 15000000,
  "currency": "USD"
}

Error Handling

The API uses conventional HTTP status codes and returns detailed error objects in the response body.

StatusCodeDescription
400invalid_requestMalformed syntax or missing parameters
401unauthorizedMissing or invalid credentials
403forbiddenInsufficient permissions for requested scope
404not_foundResource does not exist
429rate_limitedToo many requests. Check Retry-After header
500internal_errorServer-side failure. Contact support if persistent
Error Response
{
  "error": {
    "code": "rate_limited",
    "message": "Exceeded 100 requests/minute threshold.",
    "retry_after": 42,
    "documentation_url": "https://docs.aevumzenth.com/errors/rate-limited"
  }
}

Rate Limits

Rate limits are applied per API key and OAuth token. Standard tier allows 100 requests/minute, while Enterprise partners receive dedicated throughput with burst capacity.

Response Headers
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 42
X-RateLimit-Reset: 1704067200
Retry-After: 15

SDKs & Libraries

Official client libraries are available for rapid integration. All SDKs are open-source, versioned, and maintained by the Zenth Digital Systems division.

LanguagePackageRepository
Pythonpip install aevum-zenth-pygithub.com/aevum-zenth/sdk-py
Node.jsnpm install @aevum/zenth-sdkgithub.com/aevum-zenth/sdk-js
Gogo get github.com/aevum-zenth/sdk-gogithub.com/aevum-zenth/sdk-go
Rustcargo add aevum-zenthgithub.com/aevum-zenth/sdk-rs