Developer reference
Registered endpoint catalog
Registered methods, paths and scopes for Helm’s owned HTTP API.
How to read the catalog
The following methods and scope requirements reflect the current registered API operations. Named :segments are route parameters. Resource IDs must belong to the authenticated user.
Use POST /v2/loans/record for loan intent; the older standalone loan-create operation is deprecated and can be refused. Imports use their explicit lifecycle actions. A registry row does not waive request-body validation or domain constraints.
Methods, routes and scopes
| Method | Path | Scope |
|---|---|---|
GET | /api/v1/v2/imports | imports:read |
POST | /api/v1/v2/imports | imports:write |
GET | /api/v1/v2/imports/setup | imports:read |
GET | /api/v1/v2/imports/:job | imports:read |
GET | /api/v1/v2/imports/:job/upload | imports:read |
GET | /api/v1/v2/imports/:job/source/:index | imports:read |
PUT | /api/v1/v2/imports/:job/source/:index | imports:write |
GET | /api/v1/v2/imports/:job/rows | imports:read |
PATCH | /api/v1/v2/imports/:job/rows/:identity | imports:write |
POST | /api/v1/v2/imports/:job/preview | imports:read |
GET | /api/v1/preferences | read:finance |
PATCH | /api/v1/preferences | write:finance |
GET | /api/v1/v2/institutions | read:finance |
POST | /api/v1/v2/institutions | write:finance |
GET | /api/v1/v2/institutions/:id | read:finance |
POST | /api/v1/v2/institutions/:id/archive | write:finance |
POST | /api/v1/v2/institutions/:id/unarchive | write:finance |
PATCH | /api/v1/v2/institutions/:id | write:finance |
DELETE | /api/v1/v2/institutions/:id | delete:finance |
GET | /api/v1/v2/cards | read:finance |
POST | /api/v1/v2/cards | write:finance |
PATCH | /api/v1/v2/cards/:id | write:finance |
DELETE | /api/v1/v2/cards/:id | delete:finance |
GET | /api/v1/v2/counterparties | read:finance |
POST | /api/v1/v2/counterparties | write:finance |
POST | /api/v1/v2/counterparties/:id/archive | write:finance |
POST | /api/v1/v2/counterparties/:id/unarchive | write:finance |
GET | /api/v1/v2/counterparties/:id | read:finance |
PATCH | /api/v1/v2/counterparties/:id | write:finance |
DELETE | /api/v1/v2/counterparties/:id | delete:finance |
GET | /api/v1/v2/loans | read:finance |
POST | /api/v1/v2/loans | write:finance |
POST | /api/v1/v2/loans/record | write:finance |
GET | /api/v1/v2/loans/:id | read:finance |
PATCH | /api/v1/v2/loans/:id | write:finance |
DELETE | /api/v1/v2/loans/:id | delete:finance |
GET | /api/v1/v2/income-sources | read:finance |
POST | /api/v1/v2/income-sources | write:finance |
PATCH | /api/v1/v2/income-sources/:id | write:finance |
DELETE | /api/v1/v2/income-sources/:id | delete:finance |
GET | /api/v1/v2/events | read:finance |
POST | /api/v1/v2/events | write:finance |
PATCH | /api/v1/v2/events/:id | write:finance |
DELETE | /api/v1/v2/events/:id | delete:finance |
GET | /api/v1/v2/obligations | read:finance |
POST | /api/v1/v2/obligations | write:finance |
GET | /api/v1/v2/obligations/:id | read:finance |
PATCH | /api/v1/v2/obligations/:id | write:finance |
DELETE | /api/v1/v2/obligations/:id | delete:finance |
GET | /api/v1/v2/categories | read:finance |
POST | /api/v1/v2/categories | write:finance |
PATCH | /api/v1/v2/categories/:id | write:finance |
DELETE | /api/v1/v2/categories/:id | delete:finance |
GET | /api/v1/v2/tags | read:finance |
POST | /api/v1/v2/tags | write:finance |
PATCH | /api/v1/v2/tags/:id | write:finance |
DELETE | /api/v1/v2/tags/:id | delete:finance |
POST | /api/v1/v2/transaction-tags | write:finance |
DELETE | /api/v1/v2/transaction-tags/:id/:id | delete:finance |
PATCH | /api/v1/v2/transaction-entries/:id | write:finance |
GET | /api/v1/v2/identities | read:finance |
POST | /api/v1/v2/identities | write:finance |
GET | /api/v1/v2/identities/:id | read:finance |
PATCH | /api/v1/v2/identities/:id | write:finance |
DELETE | /api/v1/v2/identities/:id | delete:finance |
GET | /api/v1/v2/gameyyas | read:finance |
POST | /api/v1/v2/gameyyas | write:finance |
GET | /api/v1/v2/gameyyas/:id | read:finance |
PATCH | /api/v1/v2/gameyyas/:id | write:finance |
DELETE | /api/v1/v2/gameyyas/:id | delete:finance |
GET | /api/v1/v2/reminders | read:finance |
PATCH | /api/v1/v2/reminders/:id/:dueDate | write:finance |
GET | /api/v1/v2/settlements | read:finance |
POST | /api/v1/v2/settlements | write:finance |
PATCH | /api/v1/v2/settlements/:id | write:finance |
DELETE | /api/v1/v2/settlements/:id | delete:finance |
GET | /api/v1/v2/settlement-candidates | read:finance |
GET | /api/v1/v2/fx-quote | read:finance |
POST | /api/v1/v2/fx-refresh | write:finance |
GET | /api/v1/v2/overview | read:finance |
GET | /api/v1/v2/accounts | read:finance |
POST | /api/v1/v2/accounts | write:finance |
GET | /api/v1/v2/accounts/:id | read:finance |
PATCH | /api/v1/v2/accounts/:id | write:finance |
PATCH | /api/v1/v2/accounts/:id/institution | write:finance |
PATCH | /api/v1/v2/accounts/:id/collateral | write:finance |
POST | /api/v1/v2/accounts/:id/balance | write:finance |
DELETE | /api/v1/v2/accounts/:id | delete:finance |
GET | /api/v1/v2/obligation-board | read:finance |
GET | /api/v1/v2/anomalies | read:finance |
GET | /api/v1/v2/smart-alerts | read:finance |
GET | /api/v1/v2/income-breakdown | read:finance |
GET | /api/v1/v2/spending-by-context | read:finance |
GET | /api/v1/v2/savings-rate | read:finance |
GET | /api/v1/v2/affordability | read:finance |
GET | /api/v1/v2/net-worth-history | read:finance |
GET | /api/v1/v2/transactions | read:finance |
POST | /api/v1/v2/transactions | write:finance |
POST | /api/v1/v2/transactions/:id/reverse | write:finance |
POST | /api/v1/v2/transactions/:id/correct | write:finance |
POST | /api/v1/v2/transactions/:id/restore | write:finance |
GET | /api/v1/v2/transactions/:id | read:finance |
DELETE | /api/v1/v2/transactions/:id | delete:finance |
GET | /api/v1/v2/sms | read:finance |
POST | /api/v1/v2/sms/import | write:finance |
POST | /api/v1/v2/sms/:id/process | imports:write |
POST | /api/v1/v2/sms/reprocess | imports:write |
PATCH | /api/v1/v2/sms/:id/resolve | write:finance |
GET | /api/v1/v2/sms/stats | read:finance |
GET | /api/v1/v2/sms/review | read:finance |
GET | /api/v1/api-tokens | manage:tokens |
POST | /api/v1/api-tokens | manage:tokens |
DELETE | /api/v1/api-tokens/:id | manage:tokens |
POST | /api/v1/v2/imports/:job/seal | imports:write |
POST | /api/v1/v2/imports/:job/configure | imports:write |
POST | /api/v1/v2/imports/:job/start | imports:write |
POST | /api/v1/v2/imports/:job/continue | imports:write |
POST | /api/v1/v2/imports/:job/cancel | imports:write |
POST | /api/v1/v2/imports/:job/undo | imports:write |
POST | /api/v1/v2/imports/:job/reprocess | imports:write |
POST | /api/v1/v2/imports/:job/resolve-balance | imports:write |
POST | /api/v1/v2/imports/:job/restore-source | imports:write |
POST | /api/v1/v2/imports/:job/restart-upload | imports:write |
Authentication and request bodies
Authentication routes are described separately in authentication. Some first-party read branches are not available through the registered API-token surface; do not guess additional token endpoints from UI requests.
For a first request, use the read-only quickstart. For money commands, read idempotency before implementing retries. Import actions require preview and consent for the intended source version; see import semantics.