Platform›Webhook API
Platform · Webhook API

gRPC / REST
Webhook API.

Secure, high-throughput gRPC and REST API layer connecting institutional broker backends, Vneed marketplace, VneedPay settlement, and the Ndeipi Enterprise Server ingestion engine.

Request API Credentials
Authentication
POST /api/v1/auth/token
Content-Type: application/json

{
  "broker_id": "brk_990142_x",
  "signature": "ED25519_SIGNED_NONCE",
  "timestamp": 1747612800
}

// Response
{
  "access_token": "eyJhbGciOiJFZERTQSJ...",
  "expires_in": 3600,
  "tier": 1
}
Webhook Event Structure
{
  "event": "STATE_CHANGE",
  "deal_id": "batch_au_014",
  "from_state": "VERIFYING",
  "to_state": "APPROVED",
  "timestamp": 1747612934,
  "digital_twin_id": "DT-AU-014-0x4a29",
  "signature": "ED25519_HMAC_VERIFY"
}
REST Endpoints
POST/api/v1/deals/ingest

Submit new asset payload to the Ndeipi Enterprise Server ingestion engine. Validates schema, fires KYC/AML checks, creates Digital Twin record. Returns deal_id and initial state.

GET/api/v1/deals/{deal_id}

Retrieve current state and full metadata for a specific deal. Returns state, timestamps for each state transition, verification check results, and Digital Twin token ID on completion.

GET/api/v1/deals?status=verifying

List all broker deals filtered by state. Supports status, asset_class, date_from, date_to query parameters. Paginated — max 100 per request.

POST/api/v1/webhooks/register

Register an external endpoint URL to receive webhook notifications on state transitions. Supports event filtering (STATE_CHANGE, PAYOUT_TRIGGERED, KYC_VERIFIED). ED25519 signature verification on delivery.

GET/api/v1/ledger/summary

Retrieve broker ledger summary: total volume, pending payouts, commission earned YTD, and settlement rail status. Real-time data from Ndeipi ES.

POST/api/v1/assets/bulk-upload

Bulk ingest multiple asset payloads in a single JSON array or CSV file upload. Validated in parallel — individual failures do not block the batch. Returns per-payload status report.

gRPC + REST
Protocol Support
Dual transport layer
ED25519
Signature Algorithm
Hardware key required
<50ms
Webhook Delivery
P95 latency target
HTTPS/TLS
Transport Security
TLS 1.3 enforced
Request API Credentials