Build against RegNovaIQ with deterministic contracts and runtime-ready guides.
The API reference, OpenAPI contract and Postman collection are shared with evaluation partners on request. There is no public API endpoint yet.
Launch sequence
- Validate auth/token lifecycle and tenant context.
- Generate SDK/client stubs from OpenAPI.
- Execute workflow smoke tests with Postman collection.
- Run CI contract/readiness gates before promotion.
Documentation and contract assets
Generated from the platform’s OpenAPI contract and shared on request while there is no public API endpoint. Request access.
Swagger Console
Interactive endpoint execution and request/response validation.
ReDoc API Reference
Schema-first operation reference tuned for client integration teams.
Developer Portal API
Guided implementation, readiness gates, and domain workflow mapping.
OpenAPI External
Contract source for code generation and CI schema checks.
Postman Collection
Generated from the OpenAPI contract for deterministic API testing.
Client Readiness
Category-wise schema readiness and response-contract gap inventory.
Integration Readiness
Capability-level readiness scores with gap tracking and status rollups.
Endpoint Lifecycle
Endpoint registry with lifecycle stage, version introduction, and deprecation targets.
Integration Changelog
Version-aware changelog feed for SDK pinning and migration planning.
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
Architecture and governance references
Use these pages for product context. Signal Exchange Layer architecture references remain available via the whitepaper route.
Run contract and readiness checks before shipping
Route-health, schema-readiness and CI-quality checks are part of the documentation pack shared on request.