No Docs. Just Build.
Every endpoint. Live sandbox. Real responses. No PDF, no Postman, no separate docs site — everything you need to integrate is right here.
Get your credentials from Admin Panel → top header → API Access — or use Smart Login in the sidebar
Everything you need to integrate — auth, signing, error codes, and more. No external docs needed.
Every API request must include these 4 headers. Missing any one will result in a 401 error.
X-API-Key
Your API key starting with vk_live_
X-Timestamp
Current Unix timestamp in seconds. Must be within 5 minutes of server time.
X-Signature
HMAC-SHA256 hex digest signed with your API secret.
X-Tenant-Code
Your 6-digit tenant path code. Not part of the signature.
The signature proves your request is authentic and hasn't been tampered with.
1714728000timestamp + HTTP method (uppercase) + full endpoint path with query string + JSON body (empty string for GET)X-Signature headerUse the above to test your signing logic.
Not all modules are available by default. Access depends on your plan.
Requests are limited per API key per minute. If you exceed the limit, you'll receive a 429 response with error code RATE_LIMITED. Wait and retry.
Every API key requires at least 1 whitelisted IP (max 5). Requests from non-whitelisted IPs are rejected with 403 and error code AUTH_IP_BLOCKED. Manage IPs from Admin Panel → API Access.
All errors return JSON with success: false, an error_code string, and a human-readable message. Always check the HTTP status first, then parse error_code for programmatic handling.
401
AUTH_MISSING_KEY
X-API-Key header not sent
401
AUTH_INVALID_KEY
API key not found
401
HMAC_INVALID
Signature mismatch
401
TIMESTAMP_EXPIRED
Timestamp older than 5 minutes
403
AUTH_IP_BLOCKED
IP not whitelisted
403
MODULE_ACCESS_DENIED
Not authorized for this module
429
RATE_LIMITED
Too many requests per minute
422
VALIDATION_ERROR
Invalid or missing parameters
POST requests return predefined dummy responses. No wallet charges. Safe for testing your integration logic. GET requests still return real data even in sandbox.
Response header: X-API-Mode: sandbox
All requests hit real APIs. POST requests will charge your wallet. Use only after your integration is tested and verified in sandbox.
Response header: X-API-Mode: live
Toggle between modes from Admin Panel → API Access → Sandbox/Live switch.