Developer documentation

Build against RegNovaIQ with deterministic contracts and runtime-ready guides.

This landing-page portal mirrors the live API documentation surfaces and keeps clients on canonical links only.

Open API Developer Portal Open ReDoc Reference

Launch sequence

  1. Validate auth/token lifecycle and tenant context.
  2. Generate SDK/client stubs from OpenAPI.
  3. Execute workflow smoke tests with Postman collection.
  4. Run CI contract/readiness gates before promotion.
Canonical surfaces

Live docs and contract assets

All links below target the runtime-generated docs APIs under /api/v1/docs.

Swagger Console

Interactive endpoint execution and request/response validation.

Open /docs

ReDoc API Reference

Schema-first operation reference tuned for client integration teams.

Open API-scoped ReDoc

Developer Portal API

Guided implementation, readiness gates, and domain workflow mapping.

Open API portal

OpenAPI External

Contract source for code generation and CI schema checks.

Open external audience spec

Postman Collection

Generated from live OpenAPI contract for deterministic API testing.

Download collection

Client Readiness

Category-wise schema readiness and response-contract gap inventory.

Open readiness JSON

Integration Readiness

Capability-level readiness scores with gap tracking and status rollups.

Open integration readiness

Endpoint Lifecycle

Endpoint registry with lifecycle stage, version introduction, and deprecation targets.

Open lifecycle registry

Integration Changelog

Version-aware changelog feed for SDK pinning and migration planning.

Open changelog feed
Implementation

Client integration playbook

Reference sequence for backend, frontend, and QA teams integrating RegNovaIQ APIs.

1. Identity and session bootstrap

Use POST /api/v1/auth/login, persist tokens securely, and validate tenant scope with GET /api/v1/auth/me.

2. Core workflow integration

Implement screening, case-management, transaction monitoring, and customer-risk workflows in that order.

3. Contract-driven CI

Wire OpenAPI schema checks and non-2xx error-envelope validation into CI before any staging promotion.

4. Production readiness

Confirm observability, audit lineage, and route-health probes using the developer resources endpoints.

Support links

Auth Screening Cases Transactions Compliance Observability

Open developer resources JSON

Platform context

Architecture and governance references

Use these pages for product context while implementation remains anchored on API-scoped docs links. Signal Exchange Layer architecture references remain available via the whitepaper route.

Reference pages

Go-live

Run contract and readiness checks before shipping

Use the API developer portal for route-health, schema readiness, implementation checklist, and CI-quality gates.

Open runtime docs portal