OpenAPI Specification

ValidonX provides a complete OpenAPI 3.1 specification covering all public API endpoints. Use it to generate client SDKs, import into API tools, or explore the full API contract.

What's included

Spec version	OpenAPI 3.1.0
Operations	80 across Integration, Tenant, Billing, Auth, Onboarding, Account, Marketing, and Monitoring APIs
Authentication	X-API-Key (Integration API) and Bearer token (Dashboard APIs)
Format	YAML

Download

Download openapi.yaml

How to use it

Import into Postman

1. Open Postman and click Import
2. Select the downloaded openapi.yaml file
3. Postman will create a collection with all 80 operations pre-configured
4. Set the X-API-Key variable in your environment to start making requests

Import into Insomnia

1. Open Insomnia and go to Application > Import
2. Choose the openapi.yaml file
3. All endpoints, request bodies, and parameters are pre-populated

Generate a client SDK

Use OpenAPI Generator to create a typed client in your language:

npx @openapitools/openapi-generator-cli generate \
  -i openapi.yaml \
  -g typescript-fetch \
  -o ./validonx-client

Supported languages include TypeScript, Python, PHP, Go, Java, Ruby, C#, and many more.

Try it in the browser

Use the Interactive API Explorer to try endpoints directly in your browser without downloading anything.

Related

• Interactive API Explorer — Try every endpoint in your browser
• Quickstart Guide — Validate your first license in 5 minutes
• Error Codes — Complete error code reference