API Reference Introduction
How to use the VertexY API reference and what is intentionally excluded.
The primary API reference now lives at Interactive API Reference. It is generated from the backend OpenAPI document and includes request schemas, response examples, and runnable client snippets.
Browse the generated customer-facing OpenAPI reference.
Review shared fields, enums, and common payload objects.
Understand validation, auth, permission, billing, and rate-limit failures.
Public reference scope
The public reference focuses on tenant/customer APIs used by product, engineering, and risk teams:
- authentication and session management
- real-time risk assessment
- signed event ingestion
- outcome feedback
- reviews and graph investigation
- policy, analytics, subscriptions, and usage where customer-facing
Superadmin, platform member management, and internal control-plane endpoints are intentionally excluded from public docs.
Base URL
https://api.getvertexy.com/apiUse the dashboard developer settings page for tenant-specific secrets such as webhook signing keys.
Authentication modes
- Bearer access tokens protect most dashboard and risk APIs.
- Refresh tokens rotate sessions through
POST /auth/refresh. - HMAC signatures protect
POST /events/ingest. - Public onboarding endpoints include company registration, login, email verification, password reset, and invitation acceptance.
Next
Open the interactive reference, then follow Quickstart to test the core request flow.