canonical: https://jentic.com/apis/besmartee.com/besmartee

# BeSmartee API

Jentic publishes the only available OpenAPI specification for BeSmartee API, keeping it validated and agent-ready. The BeSmartee API exposes mortgage technology for lenders, brokers, partners, and AMC integrations covering loan creation, borrower data, pricing engine queries, conditions, document upload and download, e-sign URLs, and order management. It is used to originate and progress loans, pull APR and closing cost quotes, and integrate vendor services such as appraisal management. The spec covers 36 endpoints scoped to lender accounts authenticated by a partner access token.

## For AI agents

Originate mortgage loans, query the pricing engine for rates and APR, manage borrower documents and conditions, and place vendor orders on BeSmartee.

## Scope

Does not handle credit pulls, automated underwriting decisions, or post-close servicing - use for mortgage origination, pricing quotes, document handling, and vendor order placement only.

## Capabilities

- Create loans, import loans, and update loan data through the lender pipeline
- Query the pricing engine for APR and closing cost quotes
- Upload and download borrower documents and condition documents
- Manage borrowers, co-borrowers, and lender users on a loan file
- Generate e-sign URLs and single-sign-on URLs for borrower workflows
- Place and track AMC and vendor orders against a loan

## Use cases

### Loan Origination Pipeline

Drive a complete mortgage origination flow from lead capture to underwriting using create-lead, create-loan, and update-loan-data endpoints. The API also covers borrower additions, condition tracking, and document handling so a loan officer's CRM can stay in sync with BeSmartee. A working integration with create, update, and document upload is typically 3 to 5 days of work including auth and webhook handling.

Example prompt: POST /create-loan with borrower and property data, then POST /add-coborrowers and POST /upload-documents to attach the initial disclosures

### Real-Time Mortgage Pricing

Surface live APR and closing cost quotes inside a partner site or chat assistant. The pricing endpoints accept loan scenario inputs and return rate, points, and closing-cost figures suitable for borrower-facing display. Wiring up a quote widget via /get-apr-closing-costs and /get-ppe-anonymous is typically a 1 to 2 day job.

Example prompt: POST /get-apr-closing-costs with loan amount, FICO, property value, and occupancy and return the top three rate-and-points combinations

### Borrower Document Management

Programmatically pull required disclosures and condition documents into a loan file and download executed copies for archival. /upload-documents and /download-documents handle borrower paperwork while /download-condition-documents handles underwriting conditions. Document automation against an internal LOS typically takes 2 days for a baseline integration.

Example prompt: POST /upload-documents with the disclosure PDF and loan id, then poll /download-condition-documents to retrieve any new condition deliverables

### AI Agent for Loan Officers

An AI agent uses Jentic to discover BeSmartee operations and assist a loan officer: pulling a quick APR quote during a call, opening a loan from a lead form, or summarising outstanding conditions on a file. The agent searches by intent, loads schemas from Jentic, and executes against BeSmartee without browsing the 36 endpoints manually. Through Jentic, integration takes under an hour.

Example prompt: Search Jentic for 'get mortgage rate quote' and execute /get-apr-closing-costs with the borrower scenario captured from the lead form

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/create-loan` | Create a new loan file |
| POST | `/get-apr-closing-costs` | Quote APR and closing costs for a scenario |
| POST | `/get-list-loans` | List loans for a lender account |
| POST | `/upload-documents` | Upload a document to a loan |
| POST | `/download-documents` | Download documents from a loan |
| POST | `/add-coborrowers` | Add co-borrowers to a loan |
| POST | `/orders` | Place a vendor or AMC order |
| POST | `/access-token` | Issue a partner access token |

## Key resources

- **Loans** — Create, import, retrieve, and update loan files and their borrower data
- **Pricing** — Query the BeSmartee pricing engine for APR, closing costs, and rate watch
- **Documents** — Upload, download, and manage borrower and condition documents
- **Borrowers** — Add primary borrowers and co-borrowers and update borrower information
- **Users** — Add and update internal lender users and their account status
- **Orders** — Place, update, and check status of vendor and AMC orders
- **Access** — Issue and destroy access tokens and generate SSO and e-sign URLs

## Why Jentic

- **Setup:** Wiring the BeSmartee API by hand means running the access-token exchange, carrying the Authorization header, and posting to each RPC-style loan, pricing, and document endpoint yourself. Through Jentic you install once, import the BeSmartee API from the API Directory, store the partner key once, and your agent calls it.
- **Permission scoping:** BeSmartee uses RPC-style endpoints that take their targets in the request body rather than as a resource in the URL path, so scope the agent to the operations it needs, such as creating a loan or getting an APR quote. You choose that operation set, so document downloads or vendor order placement are not included unless you add them.
- **Credential handling:** Your BeSmartee partner API key is stored once, encrypted, by your own Jentic One instance and injected as the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a mortgage loan' or 'get an APR quote', and Jentic returns the matching BeSmartee operation with its parameter schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Plaid API** — Borrower bank and asset verification data to feed into a BeSmartee loan file
- **Stripe API** — Collect application fees or appraisal payments alongside a BeSmartee loan
- **HubSpot CRM Deals** — Track lead and applicant pipelines in HubSpot while loans live in BeSmartee

## FAQ

### Why is there no official OpenAPI spec for BeSmartee API?

BeSmartee does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call BeSmartee API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the BeSmartee API use?

The BeSmartee API uses an API key passed in the Authorization request header. Tokens are issued and revoked through POST /access-token and POST `/access-token/destroy.` When called via Jentic, the partner key is stored encrypted in your Jentic One instance and never appears in the agent's context.

### Can I run a pricing quote without creating a loan first?

Yes. POST /get-ppe-anonymous returns pricing engine results for a borrower scenario without requiring a loan id, and POST /get-apr-closing-costs returns rate and closing cost figures for the same scenario. Use these for site-wide quote widgets or chat assistants before opening a loan.

### How do I create a loan through Jentic?

Run pip install jentic and search for 'create mortgage loan in besmartee'. Jentic returns the POST /create-loan operation, the agent loads its schema, and executes with borrower, property, and loan amount fields. Follow up with /add-coborrowers and /upload-documents to complete the file.

### What rate limits apply to the BeSmartee API?

The OpenAPI specification does not document explicit rate limits. Treat 429 responses as a back-off signal and consult the BeSmartee documentation at https://api.besmartee.com/api/docs/overview for partner-specific quotas before running bulk imports or pricing sweeps.

### Can I place appraisal and AMC orders through the API?

Yes. POST /orders places a vendor or AMC order against a loan, POST /order returns details for a specific order, POST `/order/status` checks current order state, and POST `/order/update` applies an update such as a status change or revised due date.

### Can I limit what my agent is allowed to do with the BeSmartee API?

Yes. Jentic One runs self-hosted, so your own rules decide which BeSmartee operations and credentials the agent may use. Because BeSmartee uses RPC-style endpoints that take their targets in the request body, you scope the agent to just the operations it needs, such as POST /create-loan or POST /get-apr-closing-costs for pricing quotes. Operations like POST /upload-documents, POST /download-documents, or POST /orders for vendor and AMC placement stay off limits unless you add them, and your encrypted partner key is injected only for the calls you allow.