# banta API > Official documentation for the banta API - the mortgage advisory and mortgage-file management platform. API-key auth, leads, customers, mortgage files, tasks, documents, billing and milestones. REST over HTTPS with JSON. Base URL: `https://app.banta.co.il/api-service`. Auth: `x-api-key` header with a key created in the organization settings (one key = one organization). Rate limit: 60 requests per minute per key. Lists return `{ data, count }` with `limit` (max 500) and `offset`. ## Guides - [Introduction](https://docs.banta.co.il/guides/introduction.md): What you can build with the banta API, the base URL, data format and versioning policy. - [Quickstart](https://docs.banta.co.il/guides/quickstart.md): Create an API key, make your first call and create a lead - in five minutes. - [Authentication & permissions](https://docs.banta.co.il/guides/authentication.md): API keys, the x-api-key header, the resource/action permission model and per-organization data isolation. - [Pagination, search & responses](https://docs.banta.co.il/guides/conventions.md): Response shapes for lists and single records, limit/offset pagination, text search and success codes. - [Errors](https://docs.banta.co.il/guides/errors.md): The error response shape, the status codes the API returns and what to do about each. - [Rate limits](https://docs.banta.co.il/guides/rate-limits.md): 60 requests per minute per API key, what happens when you exceed it and how to design within it. - [AI agents & MCP](https://docs.banta.co.il/guides/ai-agents.md): The LLM version of these docs (llms.txt, Markdown per endpoint) and connecting banta to Claude, ChatGPT and other agents over MCP. - [Changelog](https://docs.banta.co.il/guides/changelog.md): API and documentation changes, newest first. ## Core resources · Leads Inquiries from prospective customers: creation, updates, status changes, and permanent deletion - [List leads](https://docs.banta.co.il/reference/getLeads.md): `GET /api-service/leads` - [Create a lead](https://docs.banta.co.il/reference/createLead.md): `POST /api-service/leads` - [Get a lead](https://docs.banta.co.il/reference/getLeadById.md): `GET /api-service/leads/{id}` - [Update a lead](https://docs.banta.co.il/reference/updateLead.md): `PUT /api-service/leads/{id}` - [Permanently delete a lead](https://docs.banta.co.il/reference/deleteLead.md): `DELETE /api-service/leads/{id}` - [Partially update a lead](https://docs.banta.co.il/reference/patchLead.md): `PATCH /api-service/leads/{id}` - [Update a lead's status](https://docs.banta.co.il/reference/updateLeadStatus.md): `PATCH /api-service/leads/{id}/status` - [List lead statuses](https://docs.banta.co.il/reference/getLeadStatuses.md): `GET /api-service/leads/statuses` ## Core resources · Customers The organization's customers: the people and entities who act as borrowers on files - [List customers](https://docs.banta.co.il/reference/getCustomers.md): `GET /api-service/customers` - [Create a customer](https://docs.banta.co.il/reference/createCustomer.md): `POST /api-service/customers` - [Get a customer](https://docs.banta.co.il/reference/getCustomerById.md): `GET /api-service/customers/{id}` - [Update a customer](https://docs.banta.co.il/reference/updateCustomer.md): `PUT /api-service/customers/{id}` - [Delete a customer](https://docs.banta.co.il/reference/deleteCustomer.md): `DELETE /api-service/customers/{id}` - [Partially update a customer](https://docs.banta.co.il/reference/partialUpdateCustomer.md): `PATCH /api-service/customers/{id}` - [List a customer's mortgage files](https://docs.banta.co.il/reference/getCustomerMortgageFiles.md): `GET /api-service/customers/{id}/mortgage-files` ## Core resources · Contacts The organization's professional contacts: bankers, appraisers, lawyers, and more - [List contacts](https://docs.banta.co.il/reference/getContacts.md): `GET /api-service/contacts` - [Create a contact](https://docs.banta.co.il/reference/createContact.md): `POST /api-service/contacts` - [Get a contact](https://docs.banta.co.il/reference/getContactById.md): `GET /api-service/contacts/{id}` - [Update a contact](https://docs.banta.co.il/reference/replaceContact.md): `PUT /api-service/contacts/{id}` - [Delete a contact](https://docs.banta.co.il/reference/deleteContact.md): `DELETE /api-service/contacts/{id}` - [Partially update a contact](https://docs.banta.co.il/reference/updateContact.md): `PATCH /api-service/contacts/{id}` ## Core resources · Mortgage files Mortgage files: creation (including borrowers, incomes, and obligations), updates, status changes, and deletion - [List mortgage files](https://docs.banta.co.il/reference/getMortgageFiles.md): `GET /api-service/mortgage-files` - [Create a mortgage file](https://docs.banta.co.il/reference/createMortgageFile.md): `POST /api-service/mortgage-files` - [Get a mortgage file](https://docs.banta.co.il/reference/getMortgageFileById.md): `GET /api-service/mortgage-files/{id}` - [Update a mortgage file](https://docs.banta.co.il/reference/updateMortgageFile.md): `PUT /api-service/mortgage-files/{id}` - [Delete a mortgage file](https://docs.banta.co.il/reference/deleteMortgageFile.md): `DELETE /api-service/mortgage-files/{id}` - [Partially update a mortgage file](https://docs.banta.co.il/reference/patchMortgageFile.md): `PATCH /api-service/mortgage-files/{id}` - [Update a mortgage file's status](https://docs.banta.co.il/reference/updateMortgageFileStatus.md): `PATCH /api-service/mortgage-files/{id}/status` - [List mortgage file statuses](https://docs.banta.co.il/reference/getMortgageFileStatuses.md): `GET /api-service/mortgage-files/statuses` - [List a customer's mortgage files](https://docs.banta.co.il/reference/getCustomerMortgageFiles.md): `GET /api-service/customers/{id}/mortgage-files` ## Core resources · Tasks Tasks, linked to a file, lead, or customer, or standalone - [List tasks](https://docs.banta.co.il/reference/getTasks.md): `GET /api-service/tasks` - [Create a task](https://docs.banta.co.il/reference/createTask.md): `POST /api-service/tasks` - [Get a task](https://docs.banta.co.il/reference/getTask.md): `GET /api-service/tasks/{taskId}` - [Update a task](https://docs.banta.co.il/reference/updateTask.md): `PUT /api-service/tasks/{taskId}` - [Partially update a task](https://docs.banta.co.il/reference/patchTask.md): `PATCH /api-service/tasks/{taskId}` - [Update a task's status](https://docs.banta.co.il/reference/patchTaskStatusTopLevel.md): `PATCH /api-service/tasks/{taskId}/status` - [List a mortgage file's tasks](https://docs.banta.co.il/reference/getMortgageFileTasks.md): `GET /api-service/mortgage-files/{id}/tasks` - [Create a task in a mortgage file](https://docs.banta.co.il/reference/createMortgageFileTask.md): `POST /api-service/mortgage-files/{id}/tasks` - [Get a mortgage file task](https://docs.banta.co.il/reference/getMortgageFileTask.md): `GET /api-service/mortgage-files/{id}/tasks/{taskId}` - [Update a mortgage file task](https://docs.banta.co.il/reference/updateMortgageFileTask.md): `PUT /api-service/mortgage-files/{id}/tasks/{taskId}` - [Partially update a mortgage file task](https://docs.banta.co.il/reference/patchMortgageFileTask.md): `PATCH /api-service/mortgage-files/{id}/tasks/{taskId}` - [Update a mortgage file task's status](https://docs.banta.co.il/reference/patchMortgageFileTaskStatus.md): `PATCH /api-service/mortgage-files/{id}/tasks/{taskId}/status` ## Mortgage file · Borrowers Borrowers on a mortgage file. Each borrower is linked to a customer record - [List a mortgage file's borrowers](https://docs.banta.co.il/reference/getMortgageFileBorrowers.md): `GET /api-service/mortgage-files/{id}/borrowers` - [Add a borrower to a mortgage file](https://docs.banta.co.il/reference/addBorrowerToMortgageFile.md): `POST /api-service/mortgage-files/{id}/borrowers` - [Update a borrower](https://docs.banta.co.il/reference/updateMortgageFileBorrower.md): `PUT /api-service/mortgage-files/{id}/borrowers/{borrowerId}` - [Remove a borrower from a mortgage file](https://docs.banta.co.il/reference/removeBorrowerFromMortgageFile.md): `DELETE /api-service/mortgage-files/{id}/borrowers/{borrowerId}` - [Partially update a borrower](https://docs.banta.co.il/reference/patchMortgageFileBorrower.md): `PATCH /api-service/mortgage-files/{id}/borrowers/{borrowerId}` ## Mortgage file · Timeline Timeline events of a mortgage file (read-only) - [Get a mortgage file's timeline](https://docs.banta.co.il/reference/getMortgageFileTimeline.md): `GET /api-service/mortgage-files/{id}/timeline` - [Get a mortgage file's status history](https://docs.banta.co.il/reference/getMortgageFileStatusHistory.md): `GET /api-service/mortgage-files/{id}/status-history` ## Mortgage file · Notes Free-text notes on a mortgage file - [List a mortgage file's notes](https://docs.banta.co.il/reference/getMortgageFileNotes.md): `GET /api-service/mortgage-files/{id}/notes` - [Create a note in a mortgage file](https://docs.banta.co.il/reference/createMortgageFileNote.md): `POST /api-service/mortgage-files/{id}/notes` - [Get a note](https://docs.banta.co.il/reference/getMortgageFileNote.md): `GET /api-service/mortgage-files/{id}/notes/{noteId}` - [Update a note](https://docs.banta.co.il/reference/updateMortgageFileNote.md): `PUT /api-service/mortgage-files/{id}/notes/{noteId}` - [Partially update a note](https://docs.banta.co.il/reference/patchMortgageFileNote.md): `PATCH /api-service/mortgage-files/{id}/notes/{noteId}` ## Mortgage file · File contacts Linking the organization's contacts to a mortgage file - [List a mortgage file's contacts](https://docs.banta.co.il/reference/getMortgageFileContacts.md): `GET /api-service/mortgage-files/{id}/contacts` - [Link a contact to a mortgage file](https://docs.banta.co.il/reference/linkMortgageFileContact.md): `POST /api-service/mortgage-files/{id}/contacts` - [Update a file contact's notes](https://docs.banta.co.il/reference/updateMortgageFileContactLink.md): `PUT /api-service/mortgage-files/{id}/contacts/{linkId}` - [Partially update a file contact's notes](https://docs.banta.co.il/reference/patchMortgageFileContactLink.md): `PATCH /api-service/mortgage-files/{id}/contacts/{linkId}` ## Mortgage file · Watchers Organization users who watch a mortgage file - [List a mortgage file's watchers](https://docs.banta.co.il/reference/getMortgageFileWatchers.md): `GET /api-service/mortgage-files/{id}/watchers` - [Add a watcher to a mortgage file](https://docs.banta.co.il/reference/addMortgageFileWatcher.md): `POST /api-service/mortgage-files/{id}/watchers` ## Mortgage file · Reminders Scheduled reminders on a mortgage file - [List a mortgage file's reminders](https://docs.banta.co.il/reference/getMortgageFileReminders.md): `GET /api-service/mortgage-files/{id}/reminders` - [Create a reminder for a mortgage file](https://docs.banta.co.il/reference/createMortgageFileReminder.md): `POST /api-service/mortgage-files/{id}/reminders` - [Get a reminder](https://docs.banta.co.il/reference/getMortgageFileReminder.md): `GET /api-service/mortgage-files/{id}/reminders/{reminderId}` - [Update a reminder](https://docs.banta.co.il/reference/updateMortgageFileReminder.md): `PUT /api-service/mortgage-files/{id}/reminders/{reminderId}` - [Partially update a reminder](https://docs.banta.co.il/reference/patchMortgageFileReminder.md): `PATCH /api-service/mortgage-files/{id}/reminders/{reminderId}` ## Mortgage file · Milestones The file's milestones: combined view, custom milestones, progress, and checklist items - [List a mortgage file's milestones](https://docs.banta.co.il/reference/getMortgageFileMilestonesOverview.md): `GET /api-service/mortgage-files/{id}/milestones` - [List a mortgage file's custom milestones](https://docs.banta.co.il/reference/getMortgageFileCustomMilestones.md): `GET /api-service/mortgage-files/{id}/milestones/custom` - [Create a custom milestone](https://docs.banta.co.il/reference/createMortgageFileCustomMilestone.md): `POST /api-service/mortgage-files/{id}/milestones/custom` - [Update a custom milestone](https://docs.banta.co.il/reference/updateMortgageFileCustomMilestone.md): `PUT /api-service/mortgage-files/{id}/milestones/custom/{milestoneId}` - [Partially update a custom milestone](https://docs.banta.co.il/reference/patchMortgageFileCustomMilestone.md): `PATCH /api-service/mortgage-files/{id}/milestones/custom/{milestoneId}` - [List milestone progress](https://docs.banta.co.il/reference/getMortgageFileMilestoneProgress.md): `GET /api-service/mortgage-files/{id}/milestones/progress` - [Update milestone progress](https://docs.banta.co.il/reference/updateMortgageFileMilestoneProgress.md): `PUT /api-service/mortgage-files/{id}/milestones/progress/{progressId}` - [Partially update milestone progress](https://docs.banta.co.il/reference/patchMortgageFileMilestoneProgress.md): `PATCH /api-service/mortgage-files/{id}/milestones/progress/{progressId}` - [List milestone checklist items](https://docs.banta.co.il/reference/getMortgageFileMilestoneChecklist.md): `GET /api-service/mortgage-files/{id}/milestones/checklist` - [Update a checklist item](https://docs.banta.co.il/reference/updateMortgageFileMilestoneChecklistItem.md): `PUT /api-service/mortgage-files/{id}/milestones/checklist/{itemId}` - [Partially update a checklist item](https://docs.banta.co.il/reference/patchMortgageFileMilestoneChecklistItem.md): `PATCH /api-service/mortgage-files/{id}/milestones/checklist/{itemId}` ## Mortgage file · Custom fields Values of the custom fields the organization has defined for mortgage files - [List a mortgage file's custom fields](https://docs.banta.co.il/reference/getMortgageFileCustomFields.md): `GET /api-service/mortgage-files/{id}/custom-fields` - [Set a custom field value](https://docs.banta.co.il/reference/upsertMortgageFileCustomField.md): `PUT /api-service/mortgage-files/{id}/custom-fields/{customFieldId}` - [Set a custom field value (PATCH)](https://docs.banta.co.il/reference/patchMortgageFileCustomField.md): `PATCH /api-service/mortgage-files/{id}/custom-fields/{customFieldId}` ## Documents · Documents The customer's documents in the file and the file's document requirements (read-only) - [List a mortgage file's documents](https://docs.banta.co.il/reference/getMortgageFileDocuments.md): `GET /api-service/mortgage-files/{id}/documents` - [Get a document](https://docs.banta.co.il/reference/getMortgageFileDocument.md): `GET /api-service/mortgage-files/{id}/documents/{docId}` - [List a mortgage file's document requirements](https://docs.banta.co.il/reference/getMortgageFileRequiredDocuments.md): `GET /api-service/mortgage-files/{id}/required-documents` ## Documents · Document statuses Tracking the documents requested from the file's borrowers and updating their status - [List a mortgage file's document statuses](https://docs.banta.co.il/reference/getMortgageFileDocumentStatuses.md): `GET /api-service/mortgage-files/{id}/document-statuses` - [Update a document status](https://docs.banta.co.il/reference/updateMortgageFileDocumentStatus.md): `PUT /api-service/mortgage-files/{id}/document-statuses/{statusId}` - [Partially update a document status](https://docs.banta.co.il/reference/patchMortgageFileDocumentStatus.md): `PATCH /api-service/mortgage-files/{id}/document-statuses/{statusId}` ## Documents · Signatures Borrower signatures on the file's documents (read-only) - [List a mortgage file's signatures](https://docs.banta.co.il/reference/getMortgageFileSignatures.md): `GET /api-service/mortgage-files/{id}/signatures` ## Documents · Generated documents Documents generated from templates for the file (read-only) - [List a mortgage file's generated documents](https://docs.banta.co.il/reference/getMortgageFileGeneratedDocuments.md): `GET /api-service/mortgage-files/{id}/generated-documents` - [Get a generated document](https://docs.banta.co.il/reference/getMortgageFileGeneratedDocument.md): `GET /api-service/mortgage-files/{id}/generated-documents/{docId}` ## Billing & analysis · Charges Charges (payment requests) on a file, including links to milestones - [List a mortgage file's charges](https://docs.banta.co.il/reference/getMortgageFileCharges.md): `GET /api-service/mortgage-files/{id}/charges` - [Create a charge](https://docs.banta.co.il/reference/createMortgageFileCharge.md): `POST /api-service/mortgage-files/{id}/charges` - [Get a charge](https://docs.banta.co.il/reference/getMortgageFileCharge.md): `GET /api-service/mortgage-files/{id}/charges/{chargeId}` - [Update a charge](https://docs.banta.co.il/reference/updateMortgageFileCharge.md): `PUT /api-service/mortgage-files/{id}/charges/{chargeId}` - [Partially update a charge](https://docs.banta.co.il/reference/patchMortgageFileCharge.md): `PATCH /api-service/mortgage-files/{id}/charges/{chargeId}` ## Billing & analysis · Payments Payments received on a file - [List a mortgage file's payments](https://docs.banta.co.il/reference/getMortgageFilePayments.md): `GET /api-service/mortgage-files/{id}/payments` - [Record a payment](https://docs.banta.co.il/reference/createMortgageFilePayment.md): `POST /api-service/mortgage-files/{id}/payments` - [Get a payment](https://docs.banta.co.il/reference/getMortgageFilePayment.md): `GET /api-service/mortgage-files/{id}/payments/{paymentId}` - [Update a payment](https://docs.banta.co.il/reference/updateMortgageFilePayment.md): `PUT /api-service/mortgage-files/{id}/payments/{paymentId}` - [Partially update a payment](https://docs.banta.co.il/reference/patchMortgageFilePayment.md): `PATCH /api-service/mortgage-files/{id}/payments/{paymentId}` ## Billing & analysis · File analysis Saved analyses on a file (free-form JSON) - [List a mortgage file's analyses](https://docs.banta.co.il/reference/getMortgageFileAnalyses.md): `GET /api-service/mortgage-files/{id}/analysis` - [Save a file analysis](https://docs.banta.co.il/reference/createMortgageFileAnalysis.md): `POST /api-service/mortgage-files/{id}/analysis` - [Get a file analysis](https://docs.banta.co.il/reference/getMortgageFileAnalysis.md): `GET /api-service/mortgage-files/{id}/analysis/{analysisId}` ## Billing & analysis · Calculator mixes Mortgage mixes saved to the file from the calculator - [List a mortgage file's calculator mixes](https://docs.banta.co.il/reference/getMortgageFileCalculatorMixes.md): `GET /api-service/mortgage-files/{id}/calculator-mixes` - [Create a calculator mix](https://docs.banta.co.il/reference/createMortgageFileCalculatorMix.md): `POST /api-service/mortgage-files/{id}/calculator-mixes` - [Get a calculator mix](https://docs.banta.co.il/reference/getMortgageFileCalculatorMix.md): `GET /api-service/mortgage-files/{id}/calculator-mixes/{mixId}` - [Update a calculator mix](https://docs.banta.co.il/reference/updateMortgageFileCalculatorMix.md): `PUT /api-service/mortgage-files/{id}/calculator-mixes/{mixId}` - [Partially update a calculator mix](https://docs.banta.co.il/reference/patchMortgageFileCalculatorMix.md): `PATCH /api-service/mortgage-files/{id}/calculator-mixes/{mixId}` ## System lists · Lists Fixed system value lists (read-only): employment types, mortgage types, document statuses, and more - [List available lists](https://docs.banta.co.il/reference/getAvailableLists.md): `GET /api-service/lists` - [List employment types](https://docs.banta.co.il/reference/getEmploymentTypes.md): `GET /api-service/lists/employment-types` - [List additional income types](https://docs.banta.co.il/reference/getIncomeTypes.md): `GET /api-service/lists/income-types` - [List obligation types](https://docs.banta.co.il/reference/getObligationTypes.md): `GET /api-service/lists/obligation-types` - [List mortgage types](https://docs.banta.co.il/reference/getMortgageTypes.md): `GET /api-service/lists/mortgage-types` - [List property registration types](https://docs.banta.co.il/reference/getRegistrationTypes.md): `GET /api-service/lists/registration-types` - [List real estate tax (Mas Shevach) declaration types](https://docs.banta.co.il/reference/getMishachTypes.md): `GET /api-service/lists/mishach-types` - [List document upload statuses](https://docs.banta.co.il/reference/getUploadDocumentStatuses.md): `GET /api-service/lists/upload-document-statuses` - [List document signature statuses](https://docs.banta.co.il/reference/getSignatureDocumentStatuses.md): `GET /api-service/lists/signature-document-statuses` - [List additional expense types](https://docs.banta.co.il/reference/getAdditionalExpenseTypes.md): `GET /api-service/lists/additional-expense-types` - [List calendar event types](https://docs.banta.co.il/reference/getCalendarEventTypes.md): `GET /api-service/lists/calendar-event-types` ## Optional - [Full documentation in one file](https://docs.banta.co.il/llms-full.txt): every guide and every endpoint - [OpenAPI (JSON)](https://docs.banta.co.il/openapi.json): the complete OpenAPI document - [OpenAPI (YAML)](https://docs.banta.co.il/openapi.yaml): the same document as YAML - [MCP server](https://db.banta.co.il/functions/v1/mcp-server): connect AI agents to organization data (OAuth 2.1). Setup: https://docs.banta.co.il/guides/ai-agents.md - [Hebrew version](https://docs.banta.co.il/he/llms.txt): the same documentation in Hebrew