ReconbankerReconbanker
API Reference

API overview

Base URL, authentication, error shape, and route groups for the Reconbanker HTTP API.

API overview

You can do everything in Reconbanker either from the dashboard or by calling the HTTP API directly. The API is what your back-office system will talk to when you want to integrate Reconbanker programmatically.

Base URL

Reconbanker is self-hosted. Your base URL is the address of your own instance, for example:

https://reconbanker.your-domain.com

During local development, the API is served at:

http://localhost:3000

Authentication

Every endpoint except /auth/* and /health requires a bearer token in the Authorization header:

Authorization: Bearer <jwt>

You obtain the token by calling POST /auth/login with your Reconbanker email and password. The token is valid for 7 days; re-authenticate when it expires.

Public routes

These do not require a token:

  • GET /health - liveness check. Returns { "ok": true }.
  • POST /auth/register
  • POST /auth/login

Everything else is protected.

Error shape

Errors always come back as JSON with this shape:

{ "error": "human-readable message" }

The HTTP status code tells you the broad category.

Common status codes

StatusMeaning
200OK - the request succeeded.
201Created - a new resource was created.
202Accepted - Reconbanker has queued the work; check back for the result.
204No Content - deletion succeeded.
400Bad Request - something in your request body is missing or invalid.
401Unauthorized - your token is missing, expired, or invalid.
404Not Found - the resource does not exist.
409Conflict - a uniqueness rule was violated (for example, email already in use).
500Internal Server Error - something went wrong on our side.

Route groups

PrefixPage
/authAuthentication
/accountsAccounts
/banksBanks
/conciliationConciliation
/scriptsScripts