KapworkKapwork Partner API

Changelog

API version history

[1.0.0] — 2025-01-06

Added

Receivables API

  • GET /v1/receivables — List verified receivables with filtering
  • GET /v1/receivables/:id — Get receivable details
  • Filtering by vendor, debtor, status, and time range
  • Pagination (up to 500 items per page)

Debtors API

  • GET /v1/debtors — List debtors with receivables

Vendors API

  • GET /v1/vendors — List vendors in organization

Authentication

  • Bearer token authentication with kw_live_ prefixed keys
  • API key management through dashboard
  • Usage tracking and analytics

Security

  • API keys are hashed using SHA256 before storage
  • Keys can be revoked instantly through the dashboard
  • All requests are logged for audit purposes

Versioning Policy

The Partner API uses URL path versioning (/v1/, /v2/, etc.).

  • Minor changes (new fields, new endpoints) are added to the current version
  • Breaking changes introduce a new version number
  • Previous versions are supported for at least 12 months after deprecation

Deprecation Notices

No deprecated endpoints at this time.

On this page