# Introduction

The banta API connects the mortgage management platform to your other systems: marketing sites and landing pages, CRMs, automation tools (Make, Zapier, n8n), BI and internal tools. Every call operates on the data of the organization that owns the API key - and only on it.

## What you can do

- **Leads** - capture leads from forms and campaigns, update their status, list and search them.
- **Customers and contacts** - manage customer records and professional contacts (bankers, appraisers, lawyers).
- **Mortgage files** - create and update files, including borrowers, incomes, obligations and purposes.
- **File management** - tasks, notes, reminders, watchers, file contacts and milestones.
- **Documents** - document statuses, signatures and generated documents (read).
- **Billing** - charges, payments, calculator mixes and file analyses.
- **System lists** - fixed values (employment types, mortgage types, statuses) for building forms.

## Base URL

All endpoints live under:

```
https://app.banta.co.il/api-service
```

For example, listing leads: `GET https://app.banta.co.il/api-service/leads`.

## Data format

- **JSON only** - requests with a body are sent with `Content-Type: application/json`, and responses are always UTF-8 JSON.
- **IDs** - every identifier is a UUID.
- **Dates** - ISO 8601. Date-time fields (`created_at`, `updated_at`) include a time zone; date-only fields are `YYYY-MM-DD`.
- **Amounts** - numbers (not strings), in Israeli shekels (ILS) unless a field says otherwise.
- **Text** - much of the data your organization stores (names, notes, statuses) is in Hebrew. Make sure your client handles UTF-8 end to end.
- **Errors** - one consistent shape, see [Errors](https://docs.banta.co.il/guides/errors.md).

## Versioning and compatibility

The current API version is 1.1.0. API URLs do not include a version number. Additive changes - new fields or new endpoints - can ship at any time, so write clients that ignore fields they don't recognize. Breaking changes are announced in advance on the [Changelog](https://docs.banta.co.il/guides/changelog.md). Security fixes are the exception: they may ship immediately.

## Docs for AI agents

All of this documentation is also published as clean text for AI agents and LLMs: [`llms.txt`](https://docs.banta.co.il/llms.txt), [`llms-full.txt`](https://docs.banta.co.il/llms-full.txt) and a Markdown file per endpoint. You can also connect banta directly to Claude or ChatGPT over MCP. See [AI agents & MCP](https://docs.banta.co.il/guides/ai-agents.md).

## Not available yet

- **Webhooks** - the API doesn't push events. Poll for new records instead; [Rate limits](https://docs.banta.co.il/guides/rate-limits.md) describes an efficient sync pattern.
- **Idempotency keys** - read [Errors](https://docs.banta.co.il/guides/errors.md) before re-sending a `POST` after a timeout.
- **A sandbox** - every key works on live data. See "Testing safely" in the [Quickstart](https://docs.banta.co.il/guides/quickstart.md).

## Support

API questions: [support@banta.co.il](mailto:support@banta.co.il). Product guides (in Hebrew) are in the [Help Center](https://help.banta.co.il). This documentation is also available [in Hebrew](https://docs.banta.co.il/he/).

---

Part of the banta API documentation. Full index: https://docs.banta.co.il/llms.txt