> This page is for API. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.spreadspace.app/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.spreadspace.app/_mcp/server. # Create loan POST https://api.spreadspace.app/api/borrowers/{borrower_id}/loans Content-Type: application/json Creates a loan for a borrower. `loan_type` is one of `AlternativeFinancing`, `SBA`, `CommercialTerm`, `CommercialRealEstate`, `ResidentialMortgage`, `Auto`, `Personal`; `loan_sub_type` must belong to it; `rate_type` is `Fixed`, `SOFR` or `Prime`, and `Fixed` when omitted. Requires the `loans:write` scope. Rate limit: 200 requests per minute per key (the `api` lane). Reference: https://docs.spreadspace.app/api/api-reference/loans/create ## Authentication - `Authorization` header (bearer token, required) — Bearer token. Use `ss_live_…` for live data or `ss_test_…` for the sandbox (test mode). See [Authentication](https://docs.spreadspace.app/api/authentication). ## Request ### Path parameters - `borrower_id` (string, required) — The borrower's id. ### Headers - `Idempotency-Key` (string, optional) — Idempotency token. Retries that reuse the key within 24h replay the original response. Up to 255 characters; a UUID is typical. See [Idempotency](https://docs.spreadspace.app/api/idempotency). - `SpreadSpace-Version` (string, optional) — Pin the API version, e.g. `2026-10-07`. Omit to get the latest. See [Versioning](https://docs.spreadspace.app/api/versioning). ### Body (application/json) This endpoint expects a CreateLoanRequest. - `name` (string, required) - `loan_type` (enum, optional) — One of `AlternativeFinancing`, `SBA`, `CommercialTerm`, `CommercialRealEstate`, `ResidentialMortgage`, `Auto`, `Personal`, `Transaction`. Case-insensitive. Any other value is rejected with 400. - Allowed values: `AlternativeFinancing`, `SBA`, `CommercialTerm`, `CommercialRealEstate`, `ResidentialMortgage`, `Auto`, `Personal`, `Transaction` - `loan_sub_type` (string, optional, nullable) — A subtype of the given `loan_type`; a subtype that belongs to a different type is rejected with 400. - `loan_number` (string, optional, nullable) - `requested_amount` (string, optional, nullable) — Monetary amount as a decimal string with exactly two decimal places. From 0.00 through 999999999999.99. - `rate_type` (enum, optional) - Allowed values: `Fixed`, `SOFR`, `Prime` - `interest_rate` (double, optional, nullable) - `term_months` (integer, optional, nullable) - `notes` (string, optional, nullable) - `guarantors` (list of string, optional, nullable) — Guarantor names declared on the loan. They can be declared before any document is uploaded; each one is matched by name to the people the loan's documents identify. ## Response ### 201 Created - `loan_id` (string, required) - `borrower_id` (string, required) - `assignees` (list of LoanAssigneeResponse, required) - `status` (string, required) - `created_at` (datetime, required) - `updated_at` (datetime, required) - `borrower` (LoanBorrowerSummary, required, nullable) — Borrower summary nested into a LoanResponse when the caller requests `?include=borrower` on a loan list endpoint. Carries the borrower metadata the list surface already exposes (name, entity type, location, industry), never a tax identifier, so a per-loan borrower read is not needed. - `borrower_name` (string, optional, nullable) - `loan_type` (string, optional, nullable) - `loan_sub_type` (string, optional, nullable) - `loan_type_label` (string, optional, nullable) - `loan_sub_type_label` (string, optional, nullable) - `name` (string, optional, nullable) - `loan_number` (string, optional, nullable) - `requested_amount` (string, optional, nullable) — Monetary amount as a decimal string with exactly two decimal places. From 0.00 through 999999999999.99. - `rate_type` (string, optional, nullable) - `interest_rate` (double, optional, nullable) - `term_months` (integer, optional, nullable) - `priority` (string, optional, nullable) - `notes` (string, optional, nullable) - `guarantors` (list of string, optional, nullable) — Guarantor names declared on the loan. Gated like Notes: null when the caller may not read the loan file, and null when none were declared. - `documents` (list of LoanDocumentSummary, optional, nullable) — Nested per-loan document summaries. Populated only when the loan list endpoint was called with `?include=documents` and the caller may read this loan, and null otherwise. The field is always present on the wire; an empty list means the loan has no documents yet. ## Errors ### 400 Bad Request Error Bad request: validation failed, the cursor is malformed, or the API version is unknown. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 401 Unauthorized Error Unauthorized: the bearer token or API key is missing or invalid. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 402 Payment Required Error Payment required: the standard error envelope with `type` `subscription_required` when the workspace has no active or trialing subscription, or `billing_required` where a plan entitlement applies. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 403 Forbidden Error Forbidden: authentication succeeded but the caller is not permitted to perform this action, for example an API key missing the required scope, an embed session reaching a loan it was not minted for, or a feature outside the workspace's plan. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 404 Not Found Error Not found: the resource does not exist or is not visible to the calling tenant. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 409 Conflict Error Conflict: a version mismatch, where `details.current_version` carries the version the resource is actually at so the client can reload and re-apply, or an idempotency key reused with a different request body. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 429 Too Many Requests Error Too many requests: the rate limit was hit, or an idempotency-key replay is still in progress. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 500 Internal Server Error Internal server error: an unexpected failure. Quote the `request_id` in support tickets. A mutation sent with an `Idempotency-Key` replays this fault under that key rather than re-running; confirm the resource state before resending with a new key. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ## Types ### LoanAssigneeResponse One user assigned to a loan. `display_name` and `email` are present for workspace callers only; an API-key or embed caller receives `user_id` and `assigned_at` alone. - `user_id` (string, required) - `assigned_at` (datetime, required) ### LoanBorrowerSummary Borrower summary nested into a LoanResponse when the caller requests `?include=borrower` on a loan list endpoint. Carries the borrower metadata the list surface already exposes (name, entity type, location, industry), never a tax identifier, so a per-loan borrower read is not needed. - `borrower_id` (string, required) - `name` (string, required) - `dba_name` (string, optional, nullable) - `legal_entity_type` (string, optional, nullable) - `city` (string, optional, nullable) - `state` (string, optional, nullable) - `industry` (string, optional, nullable) ### LoanDocumentSummary Per-document summary row nested into a LoanResponse when the caller requests `?include=documents`. Summary only (id, category, filename, extraction status, the sentence for a document that could not be extracted, created at), never the extracted figures. Nested only for loans the caller may read. - `extracted_document_id` (string, required) - `document_category` (string, required) - `created_at` (datetime, required) - `original_filename` (string, optional, nullable) - `extraction_status` (string, optional, nullable) - `unextractable_reason` (string, optional, nullable) — A sentence you can show for a document that could not be extracted, for example a bank statement that did not include all of its pages. Null otherwise. ### ApiErrorBody Inner body of the canonical API error envelope. - `type` (string, required) — Stable error type identifier. Pattern-match on this value, not the human-readable message. - `message` (string, required) — Human-readable error message. Subject to wording changes; do not parse. - `request_id` (string, optional, nullable) — Per-request correlation ID (matches `X-Request-ID` response header). Quote in support tickets. - `details` (map from string to string, optional, nullable) — Structured detail. Some error types populate documented keys in every environment: a version conflict (409) carries `current_version`, the version the resource is actually at, so the client can reload and re-apply. Free-form diagnostic detail beyond those keys appears in development environments only. An `insufficient_credits` 402 carries `balance_usd`, `reserved_usd`, `in_flight_docs`, `incoming_docs` and `per_doc_reservation_usd` as decimal strings. ## Examples **Request** ```json { "name": "Small Business Loan", "loan_type": "CommercialTerm", "loan_sub_type": "TermLoan", "requested_amount": "250000.00", "rate_type": "Fixed", "interest_rate": 5.75, "term_months": 60 } ``` **Response** ```json { "loan_id": "4b3a2918171615141312a1b0", "borrower_id": "9f8e7d6c5b4a3210a1b2c3d4", "assignees": [], "status": "active", "created_at": "2024-01-15T09:30:00.125293+00:00", "updated_at": "2024-01-15T09:30:00.125293+00:00", "borrower": null, "borrower_name": "Acme Corporation", "loan_type": "CommercialTerm", "loan_sub_type": "TermLoan", "loan_type_label": "Commercial Term", "loan_sub_type_label": "Term Loan", "name": "Small Business Loan", "loan_number": null, "requested_amount": "250000.00", "rate_type": "Fixed", "interest_rate": 5.75, "term_months": 60, "priority": null, "notes": null, "guarantors": null, "documents": null } ``` **SDK Code** ```python import requests url = "https://api.spreadspace.app/api/borrowers/9f8e7d6c5b4a3210a1b2c3d4/loans" payload = { "name": "Small Business Loan", "loan_type": "CommercialTerm", "loan_sub_type": "TermLoan", "requested_amount": "250000.00", "rate_type": "Fixed", "interest_rate": 5.75, "term_months": 60 } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.spreadspace.app/api/borrowers/9f8e7d6c5b4a3210a1b2c3d4/loans'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"name":"Small Business Loan","loan_type":"CommercialTerm","loan_sub_type":"TermLoan","requested_amount":"250000.00","rate_type":"Fixed","interest_rate":5.75,"term_months":60}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.spreadspace.app/api/borrowers/9f8e7d6c5b4a3210a1b2c3d4/loans" payload := strings.NewReader("{\n \"name\": \"Small Business Loan\",\n \"loan_type\": \"CommercialTerm\",\n \"loan_sub_type\": \"TermLoan\",\n \"requested_amount\": \"250000.00\",\n \"rate_type\": \"Fixed\",\n \"interest_rate\": 5.75,\n \"term_months\": 60\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.spreadspace.app/api/borrowers/9f8e7d6c5b4a3210a1b2c3d4/loans") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"name\": \"Small Business Loan\",\n \"loan_type\": \"CommercialTerm\",\n \"loan_sub_type\": \"TermLoan\",\n \"requested_amount\": \"250000.00\",\n \"rate_type\": \"Fixed\",\n \"interest_rate\": 5.75,\n \"term_months\": 60\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.spreadspace.app/api/borrowers/9f8e7d6c5b4a3210a1b2c3d4/loans") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"name\": \"Small Business Loan\",\n \"loan_type\": \"CommercialTerm\",\n \"loan_sub_type\": \"TermLoan\",\n \"requested_amount\": \"250000.00\",\n \"rate_type\": \"Fixed\",\n \"interest_rate\": 5.75,\n \"term_months\": 60\n}") .asString(); ``` ```php request('POST', 'https://api.spreadspace.app/api/borrowers/9f8e7d6c5b4a3210a1b2c3d4/loans', [ 'body' => '{ "name": "Small Business Loan", "loan_type": "CommercialTerm", "loan_sub_type": "TermLoan", "requested_amount": "250000.00", "rate_type": "Fixed", "interest_rate": 5.75, "term_months": 60 }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.spreadspace.app/api/borrowers/9f8e7d6c5b4a3210a1b2c3d4/loans"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"name\": \"Small Business Loan\",\n \"loan_type\": \"CommercialTerm\",\n \"loan_sub_type\": \"TermLoan\",\n \"requested_amount\": \"250000.00\",\n \"rate_type\": \"Fixed\",\n \"interest_rate\": 5.75,\n \"term_months\": 60\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "name": "Small Business Loan", "loan_type": "CommercialTerm", "loan_sub_type": "TermLoan", "requested_amount": "250000.00", "rate_type": "Fixed", "interest_rate": 5.75, "term_months": 60 ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.spreadspace.app/api/borrowers/9f8e7d6c5b4a3210a1b2c3d4/loans")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```