Aevum Zenth Access Documentation

Overview

The Aevum Zenth Developer Portal provides programmatic access to our 400+ subsidiary networks. Our RESTful APIs are designed with strict role-based access control (RBAC), end-to-end encryption, and comprehensive audit trails. All endpoints follow OpenAPI 3.1 specifications and are versioned at the path level.

Base URL

All production requests must target:

https://api.aevumzenth.com/v4/

Response Format

JSON responses follow consistent envelope structure:

{ "status": "success", "data": {}, "meta": {} }

Environment

Sandbox available for testing:

https://sandbox.api.aevumzenth.com/v4/

Access Tiers

Permissions are stratified based on partnership level and compliance clearance. Select the appropriate tier during onboarding to ensure proper API scope provisioning.

Capability	Public	Partner	Internal	Restricted
Read-Only Endpoints	✓	✓	✓	✓
Data Export (CSV/JSON)	✗	✓	✓	✓
Write/POST Operations	✗	✓	✓	✓
Cross-Division Sync	✗	✗	✓	✓
Real-Time Streaming	✗	✗	✗	✓

Authentication

Aevum Zenth supports multiple authentication methods depending on your access tier. API keys are preferred for server-to-server communication, while OAuth 2.0 is required for user-delegated actions.

API Key Authentication

Include your secret key in the Authorization header as a Bearer token. Keys are scoped to specific divisions and environments.

HTTP Header

Authorization: Bearer az_live_9x8c7v6b5n4m3l2k1j0h
X-Zenth-Division: energy-grid
X-Request-ID: req_7a8b9c0d1e2f3g4h5i6j

OAuth 2.0 Flow

For partner applications requiring user context, implement the Authorization Code Flow with PKCE. Redirect URIs must be pre-registered in the Developer Console.

Token Request

POST https://auth.aevumzenth.com/oauth2/token
{
  "grant_type": "authorization_code",
  "code": "auth_3k4j5h6g7f8d9s0a",
  "client_id": "partner_client_xyz",
  "code_verifier": "pkce_challenge_string"
}

Quick Start

Register your organization at console.aevumzenth.com
Select your access tier and complete compliance verification
Generate API keys scoped to your required divisions
Install the official SDK: npm install @aevumzenth/sdk-v4
Initialize with your credentials and test against the sandbox

Node.js Example

import { AevumClient } from '@aevumzenth/sdk-v4';

const client = new AevumClient({
  apiKey: process.env.ZENTH_API_KEY,
  environment: 'sandbox',
  division: 'logistics'
});

const shipment = await client.shipments.create({
  origin: 'SGP_HUB_04',
  destination: 'LON_HUB_12',
  priority: 'express'
});
console.log(shipment.tracking_id);

API Endpoints Overview

Our API is resource-oriented. Major namespaces include /v4/energy, /v4/finance, /v4/healthcare, and /v4/logistics. Each namespace exposes CRUD operations, batch endpoints, and real-time event streams (Restricted tier only).

Resource Discovery

GET /v4/catalog lists all available endpoints and schemas.

View Schema →

Batch Operations

POST /v4/batch allows up to 50 requests per payload.

Batch Guide →

Event Streaming

WS /v4/stream for real-time telemetry and alerts.

WebSocket Docs →

Security & Compliance

All data in transit is encrypted via TLS 1.3. Data at rest uses AES-256-GCM. Audit logs are immutable and retained for 7 years. We maintain SOC 2 Type II, ISO 27001, and HIPAA/GDPR compliance across all divisions.

Rate Limiting: Configurable per tier (100-10,000 req/min)
IP Allowlisting: Enforced for Partner+ tiers
mTLS Support: Available for Restricted tier integrations
Data Residency: Region-scoped endpoints: us-east, eu-west, ap-south