API Specification

The KINGSTONE B2B Partner API follows the OpenAPI 3.0.3 standard. You can use the spec file with any OpenAPI-compatible tool for automated client generation, interactive exploration, and request validation.

OpenAPI Endpoint

The live specification is available at:

GET /api/partner/v1/openapi.json

Import this URL directly into your tool of choice.

Recommended Tools

• Postman — Import the URL as a collection for interactive testing
• Insomnia — Import OpenAPI spec for request building and environment management
• Swagger UI — Built into the KINGSTONE API at /api-docs (sandbox only)
• openapi-generator — Generate client code in any language from the spec

Base URLs

Environment	Base URL
Sandbox	https://sandbox.kingstone.dev/api
Production	https://api.kingstone.dev/api

All partner endpoints are under the /partner/v1/ prefix. For example, the spin endpoint is:

POST https://sandbox.kingstone.dev/api/partner/v1/spin

Authentication

Every request must include your API key in the X-API-Key header. See the Authentication guide for details.

Response Format

All responses are JSON. Successful responses return the resource directly. Error responses follow a consistent shape:

{
  "message": "Human-readable error description",
  "errorCode": "KS-4201"
}

See the Error Codes reference for the full catalog.