What's new in API 4.1
Upcoming: API 4.1 is planned to take effect on Wednesday, November 18, 2026. Until then,
/api/v4behaves as
documented in version 4.0. Read this page to see what changes on that date.
Planned to take effect on Wednesday, November 18, 2026. API 4.1 replaces 4.0 at the same address: your base path stays /api/v4,
and your API key and sign-in keep working. Every 4.0 endpoint keeps working. 4.1 adds endpoints for tasks,
documents, custom fields, the pipeline summary and your own sign-in. It puts every timestamp in one time
zone and publishes the rate limits. It also changes some behaviour, listed under Changes you may need to
act on. Those changes apply to every call from the release date; there is no setting to keep 4.0's
behaviour, so read that list now.
What stays the same for API keys
If you call the API with a company API key (or a token from POST /api/v4/authenticate), these stay as
they are in 4.0. (A signed-in person, or the LendingWise MCP connector, gets the 4.1 answer noted in
brackets.)
- Reference and directory lists return every row.
GET /api/v4/loan-types,/loan-programs,
/loan-programs-internal,/loan-programs/internal,/loan-primary-statuses,/loan-sub-statuses,
/brokers,/loan-officers,/branchesand/back-office-employeesanswer with every row and
meta.count, and ignorepageandper_page. (A person or MCP gets these lists 25 rows at a time.) - Sensitive fields on a loan keep their 4.0 shapes unless your administrator chose otherwise for your
key (see PII access for API keys). The borrowers' SSN and driver's licence, the entity's EIN and a
broker'sssncome back masked as they do today (***-**-6789for a nine-digit SSN), and dates of birth
come back as stored. Sending back the value you read changes nothing. (A person or MCP sees one mask
shape,****6789, and a date of birth masked to the year,1985-**-**.) One exception, under
Changes you may need to act on: the broker directory'seinNumber. GET /api/v4/loan-programs/internalkeeps working. It answers exactly as its new name,
GET /api/v4/loan-programs-internal.- A loan with no real broker reads your company's placeholder broker id in
loanBrokerID(and its new
namebrokerId), on the single loan, the loan list and the create and update replies, as stored (a slot
holding0reads0). Sending one of
your company's placeholder ids onPOST /api/v4/loansorPATCH /api/v4/loans/{id}stores it, which
is how you take a broker off a loan, as in 4.0. (A person or MCP readsnulland is refused the
placeholder; they usePATCH /api/v4/loans/{id}/brokerwith{"brokerId": null}.) - An empty
loanNumberon aGET /api/v4/loansrow reads"". OnGET /api/v4/loans/{id}it reads
null, as in 4.0. (A person or MCP readsnullon both.) GET /api/v4/loansignoressearch,perPage,archive_stateandprimary_status_id(and their 4.1
spellingsarchiveStateandprimaryStatusId), and the four
directories ignoresearch: no filter, no error, no warning, as in 4.0. A loan page is 25 rows unless
per_pagesays otherwise (its reply carries aDeprecationheader: see New names for existing fields). The other filtersGET /api/v4/loansgains in 4.1 work for you too. (A person
or MCP gets every filter.)POST /api/v4/loans/{id}/membersandPOST /api/v4/loans/{id}/propertiesanswer with the whole loan
file, asGET /api/v4/loans/{id}reads it; a retry with the sameIdempotency-Keyreplays it. (A
person or MCP gets only the members or properties the call created, as a list.)
Loan amounts
For every caller, the base and requested amounts read a stored figure wherever 4.0 had one, so a loan no
longer reads null where 4.0 showed an amount. They are not always the same figure as 4.0's:
loanBaseLoanAmountreads the base stored on the loan file where there is one, and otherwise the
base LendingWise calculates (for a Down Payment %, an LTV % or a sum of payoffs). 4.0 read the
calculated base only, so a loan whose stored base differs from the calculated one now reads the stored
figure. Sending back the figure you read changes nothing.loanRequestedAmountreads the Loan Info "Desired loan amount" first, and the "Desired Funding
Amount" from the loan's additional questions (the only one 4.0 read) where that box is empty. A loan
holding two different figures now reads the Loan Info one.
PII access for API keys
Available from the release date, once LendingWise's Integration Hub offers the choice, shortly after the
release. Until then every key reads as Masked, as in 4.0.
When your LendingWise administrator generates a company API key in the Integration Hub, they choose what
it may read of the borrowers' SSN, driver's licence and dates of birth, the entity's EIN, a broker's SSN
and SSN-type custom fields. The choice is fixed for the key's life; to change it, generate a new key.
| Setting | What the key reads | Sending a value back |
|---|---|---|
Masked (the default; every existing key, and tokens from POST /api/v4/authenticate) | the 4.0 masks above, dates of birth as stored; SSN-type custom fields in full | the value you read changes nothing |
| No | null for each of these fields, SSN-type custom fields included | null changes nothing; a real value still saves; a masked value is refused (422) |
| Yes | the stored values, unmasked | the value you read changes nothing |
⚠️ The broker directory's einNumber is not covered by this setting: every key reads it as stored.
New endpoints
| Area | Endpoint | What it does |
|---|---|---|
| Your sign-in | GET /api/v4/me | Shows who you are signed in as, which company you act for, and which loan files you can reach |
| Health | GET /api/v4/platform/runtime | Shows the platform's time zone, server time and short build id. Needs a credential. For an anonymous health check use GET /api/v4/ping |
| Loans | GET /api/v4/loans/summary | Summarizes the loan pipeline: counts and totals |
| Loan reference data | GET /api/v4/loan-programs-internal | The new name of GET /api/v4/loan-programs/internal, which keeps working |
| Custom fields | GET /api/v4/custom-fields | Lists custom field definitions |
GET, PATCH /api/v4/loans/{id}/custom-fields | Reads and sets a loan file's custom field values | |
GET, PATCH /api/v4/borrowers/{id}/custom-fields | Reads and sets a borrower profile's custom field values | |
| Loan assignments | PATCH /api/v4/loans/{id}/employees | Sets the loan's back-office employees. It replaces the PUT (see Deprecations) |
| Documents | GET /api/v4/document-types, POST /api/v4/document-types | Lists document types and adds one |
GET /api/v4/document-statuses | Lists document statuses | |
GET /api/v4/loans/{id}/document-checklist | Lists a loan's document checklist | |
POST /api/v4/loans/{id}/document-checklist/{slot}/files | Uploads a file into a checklist slot | |
GET /api/v4/loans/{id}/documents | Lists every document on a loan | |
GET /api/v4/loans/{id}/documents/{document}/content | Downloads a document's contents | |
| Tasks | GET /api/v4/tasks, POST /api/v4/tasks | Lists your company's tasks and creates one |
GET, PATCH, DELETE /api/v4/tasks/{id} | Gets, updates and deletes one task |
The full request and response shapes are in the API reference for version 4.1. A few behaviours to
know before you use them:
- Loan custom fields are safe to send back whole. Items equal to what is stored are skipped, so
reading all of a loan's custom fields, changing one and writing them all back neither erases the
borrower profile's answers nor fails on a choice your company has since removed. (Borrower custom
fields do not skip yet; see Known limitations.) Writing an archived loan's custom fields answers 409. - Task
details: a line break you send is stored the way the back office stores it, so every
back-office task screen shows the lines. Details written in the back office read back as plain text:
line breaks kept, the editor's markup dropped. - Uploads over 64 MB are refused with a 422 that names the limit; a request body too large for the
server answers 413 in the standard error envelope. - Downloads never hand you a web page in place of the document.
- Lists added in 4.1 (custom fields, a loan's or a borrower's custom fields, document types and
statuses, a loan's documents, tasks) are paged for every caller, 25 rows by default.
New request features
- Retry a create safely with
Idempotency-Key.POST /api/v4/loans,POST /api/v4/loans/{id}/properties,
POST /api/v4/loans/{id}/members,POST /api/v4/document-types,
POST /api/v4/loans/{id}/document-checklist/{slot}/filesandPOST /api/v4/tasksaccept an
Idempotency-Keyheader: a key you generate, such as a UUID, at most 64 characters. The same key with
the same body returns the original result withIdempotency-Replayed: trueand creates nothing. The
same key with a different body answers 409. Without the header, the endpoint behaves as it always has.
A replay shows the record as it is now, not a copy of the first reply. A key is kept for at least 24
hours; after that, a reused key may replay or may create a new record, so use a new key for each new
request. "The same" means the same path, query string and body. - Preview a loan write with
?dryRun=trueonPOST /api/v4/loansandPATCH /api/v4/loans/{id}. The
request runs and is then undone, so nothing is kept. The answer carriesmeta.dryRun: trueand
meta.effects. Send it in the query string, spelled exactlydryRun. ⚠️ Send it only to a server whose
replies carryX-LW-Capabilities: loan-dry-run. A server without the dry run, including/api/v4
before the release date, ignores the parameter and makes the change. A change that cannot be previewed
safely answers 409 witherror.details.reasonDRY_RUN_UNSAFE. meta.warningssays what was not used. On a loan write,FIELD_IGNOREDnames some fields that were
accepted and not stored (listed under Writes). On anyGET,UNKNOWN_PARAMETERnames a query parameter the endpoint does
not read: it was ignored, so the answer is not narrowed by it.
Timestamps are US Eastern
Every date-time the API returns carries the US Eastern offset (-05:00 in winter, -04:00 in summer),
for example 2026-11-06T14:15:26-05:00. LendingWise's own clock runs on America/New_York, so the API
now reports times the way the platform records them.
meta.timestampon every response used to be UTC with aZ. It is now the same instant written with
the Eastern offset. The deprecatederror.timestampdoes the same.- Task
dueAtandreminderAt, and thedueFromanddueTofilters, are read and returned in Eastern
time. A date-time you send without an offset is read as Eastern. The task-creation email's "Due On"
shows Eastern time withESTorEDT. GET /api/v4/mesignedInAtand documentuploadedAtuse the same form.- One field stays as it was and is deprecated: an employee assignment's
dateAssigned, a bare
YYYY-MM-DD HH:MM:SSwith no offset. UseassignedAtbeside it, which carries the offset. - The loan's
createdAtis a date, not a date-time. It is the old name ofcreatedDate
(YYYY-MM-DD) and is accepted only during the naming window. GET /api/v4/platform/runtimereturnsserverTime.utcbeside the Eastern reading, by design.
If your code compares times, parse the offset. Do not assume Z.
Rate limits
Each API key may make 120 calls a minute. The allowance is counted against your key, not the
machine the call came from, so all your servers share one allowance. A minute starts with your first
call and lasts 60 seconds. Signing in with POST /api/v4/authenticate is limited separately and more
tightly: 30 a minute for each client_id from each address. If you run a large sync that needs
more than 120 calls a minute, ask support: a higher allowance can be set for your key alone.
Every reply to a call made with your API key carries X-RateLimit-Limit and X-RateLimit-Remaining.
Past the limit you get 429 with error.code RATE_LIMITED, a Retry-After header, an
X-RateLimit-Reset header (the same moment as a Unix time in seconds, UTC), and
error.details.retryAfterSeconds. Wait that long, then retry.
The API stores what you send and calculates nothing
The API saves the loan figures you send exactly as you send them. It no longer calculates figures of its
own, such as a rehab amount from a cost and a percent, a fee from a fee percent, totals, ratios or
property analysis figures. LendingWise works those figures out itself, the same way it does after a
save in the back office, shortly after your write. Until that happens, a figure that depends on your
change can still show its previous value, and a property you have just created can show null for its
analysis figures.
What this means for each field:
- Base loan amount (
loanBaseLoanAmount) can be written; 4.0 accepted it and ignored it. A changed
value is saved as a manual entry. Sending back the value you read is a no-op. - Rehab (
loanRehabCost,loanRehabFinanced) is stored as posted.loanRehabFinancedPercentis
read-only: a posted value is dropped and named inmeta.warnings. When you store the financed amount
(or the cost, while a financed amount is stored), the API sets the percent to financed ÷ cost × 100, so the platform's total loan
amount counts your financed amount (it is calculated from the percent). Sendingnullfor the cost or
the financed amount changes nothing. A rehab cost above 99,999,999,999.99 is refused with 422. A rehab
cost or financed amount below 0 is refused with 422 naming the field, on create and update; a negative
amount the loan already stores can be sent back unchanged.
Storing either amount above 0 also setsloanNeedsRehabtotrue, so the back office shows the
rehab fields, unless you sendloanNeedsRehabastrueorfalsein the same request. Clearing the
amounts leavesloanNeedsRehabas it is. If you sendloanNeedsRehab: falsetogether with rehab
amounts, the answer is stored as No and the back office hides the rehab fields, but the total loan
amount LendingWise calculates still counts the financed amount, as it does when the back office saves
the same answers. - Prepaid interest reserve (the Loan Info tab's reserve) has three new fields, stored as sent:
loanPrepaidInterestReserveMonths(a whole number, 0 or more),loanPrepaidInterestReserveAmount
(0 or more; a stored 0 readsnull, as the tab shows it blank) andloanAutoCalcInterestReserve
(trueorfalse). When auto-calculation is on, the back office recalculates the amount on its own
saves. - Fee pairs (exit, origination and broker fee, each an amount and a percent): when you send both and
they disagree, the dollar amount is stored and the percent is dropped, with ameta.warningsentry. A
percent sent alone is stored as posted. Nothing is calculated from either one. For the broker and
origination fees, storing a new dollar amount also ticks the fee's lock box in the back office, so the
next back-office save keeps your amount and works the percent out from it; storing a new percent on its
own unticks it. Clearing a stored amount (nullor0) ticks it too, so the fee stays at 0. Sending back
the value you read leaves the box as it is. Not on loans whose Total Loan Amount is calculated as LTC-2:
there the back office works both fees out from the percent. - Closing costs financed (
loanClosingCostFinanced) is stored as posted. It is no longer replaced by
the sum of the fee rows. - Rate from monthly payment (
loanRateFromMonthlyPayment) is read-only. The back office sets it. - Contingency (
loanContingencyType, percent and amount) is stored as posted. A type of5or10
no longer forces the percent or calculates the amount. - Requested loan amount (
loanRequestedAmount) is written to the Loan Info "Desired loan amount"
box. 4.0 wrote the additional questions' "Desired Funding Amount". - Pipeline figures (
GET /api/v4/loans/summary, theGET /api/v4/loansrows and
loanTotalLoanAmount) read the figures LendingWise last calculated, which it refreshes after your
write, usually within about a minute. A loan created through the API appears in the pipeline totals once
those figures exist. The three commitment figures are summed over
one set of loan files, so the total minus the cash needed at closing equals the unfunded amount, on the
totals and on every group.
What a later save in the back office can still change, so a value you stored can read differently
afterwards:
- An exit fee whose stored amount no percent matches is re-priced from its percent at the next Loan Info
save, when that percent is above 0. A broker or origination fee the API stored before this release
(its lock box is not ticked) is re-priced the same way. - A rehab financed amount that no percent can reproduce (a cost of 0 or none, or a financed amount ten
times the cost or more) can be replaced at the next Loan Info save, and some back-office saves clear
the rehab cost.
Changes you may need to act on
These change what a request that worked on 4.0 returns or accepts, from the release date, on the same
/api/v4 paths.
Responses
- The loan's
summaryblock is no longer returned on loan reads and writes.summary…fields sent on a
write are accepted and ignored. loanFinanceClosingCostsandloanIRFinancedare no longer returned. Sending them still succeeds,
andmeta.warningsnames them (FIELD_IGNORED).loanRequestedAmountreads the Loan Info "Desired loan amount" first, and the additional questions'
"Desired Funding Amount" (what 4.0 read) only where that box is empty; a write goes to the Loan Info box.
It also accepts larger values.- The broker directory's
einNumber(GETandPOST /api/v4/brokers) comes back as stored, for every
key, whatever its PII setting. 4.0 masked it. (A broker'sssnkeeps its 4.0 mask.) - The broker, loan-officer and back-office directories no longer return sign-in and security settings
(require2FA,restApi,allowLoginToBackOffice,allowedToLogin, andlastLoginDateon
POST /api/v4/brokers). - Markup is removed from text on output, and from text written to declared columns. A label that was
nothing but markup readsnull. PATCH /api/v4/loans/{id}/brokerand/loan-officerwith anullid now answer withdata: null.- The employee filter on
GET /api/v4/loansandGET /api/v4/loans/summarymatches only your own
company's employees. - Every 405 carries an
Allowheader naming the methods the path accepts. - A refused call now carries the same
metablock as a success (meta.requestId,meta.timestamp).
error.requestIdanderror.timestampare still sent, deprecated in favour ofmeta. - A
GETnames a query parameter it does not read inmeta.warnings
(UNKNOWN_PARAMETER) and answers without it. (An API key's ignoredGET /api/v4/loansparameters,
listed under What stays the same for API keys, carry no warning.) - A reply to a request that uses an old field or parameter name carries a
Deprecationheader (see
New names for existing fields).
Writes that behave differently
- Saving a loan back unchanged is a true no-op: a
GETbody sent straight back toPATCHwrites
nothing, deletes nothing and runs no automation. - A loan write names some fields it ignores in
meta.warnings(FIELD_IGNORED):loanFinanceClosingCosts,
loanIRFinanced, aloanRehabFinancedPercentthat differs from the stored one, and a fee percent sent
beside its dollar amount. Other keys a write does not store, such as read-only figures like
loanTotalLoanAmountand unknown keys, are dropped without a warning. - Assigning a broker who is not linked to the loan's branch adds that link. A dry run lists the link the
save would add, inmeta.effects.preferredAgentLinks.
Requests that are now refused
- A
loanBaseLoanAmountthat changes the stored figure answers 422 when it is 0 or less, too large for
the column, or sent for a Transactional loan. 4.0 ignored the field. - Sending a masked value that is not this record's own mask answers 422. It used to save the last four
digits over the real number. Sending the record's own mask back is still a no-op, so a read-then-write
round trip is safe. - A misspelt
dryRunin the query string, or?dryRunon a route without the dry run, answers 422 and
names the key, and so does adryRunin the body of a loan, property or member write. It used to run
the write for real. POST /api/v4/brokerswithoutemailanswers 422 onemail. It used to answer 206 and write nothing.PUT /api/v4/loans/{id}/employeeswith an id repeated, sent as text ortrue, or below 1 answers 422
naming the entry. It used to drop the repeat, and readtrueas employee 1.- On
GET /api/v4/loansandGET /api/v4/loans/summary, a date range whoseTois before itsFrom
answers 422 and names theTokey. It used to answer an empty 200. - A custom-field value the field cannot hold answers 422 and names every bad item: text in a number
field, a date that cannot be read, or a phone, ZIP or SSN with no digits. Nothing is written. loanOriginationFeePercentandloanBrokerFeePercentabove 100 answer 422.loanOriginationFeeand
loanBrokerFeeabove 900,000,000 answer 422. An origination or broker fee, or fee percent, that the loan
already stores above its cap can be sent back unchanged. (loanContingencyReservePercent, new in 4.1,
takes 0 to 100; a stored value above 100 cannot be sent back yet, see Known limitations.)loanRehabCostorloanRehabFinancedbelow 0 answers 422 naming the field, on create and update. A
negative amount the loan already stores can be sent back unchanged.- Removing a member from an archived loan answers 409 instead of removing it.
- A
fileTypethat the loan file's branch does not offer answers 422 onfileType. loanContingencyTypeaccepts5,10andOther. The older valuesAmountandDollarare read as
Other.Percentis read as5or10when the loan's stored percent is 5 or 10, and asOther
otherwise.
Credentials
- OAuth client-credentials tokens are not accepted on the loan and directory routes (401). They are for
GET /api/v4/platform/pingand the LendingWise MCP connector. - A person's OAuth token is re-checked on every call, so a person whose access is reduced gets 403 at
once.
Contract corrections that change nothing on the wire
POST /api/v4/loansmarksbranchIdas required. The older spellingbranchIDis still accepted
during the rename window.propertyIdis removed from thePOST /api/v4/loans/{id}/propertiesbody schema. The server never
accepted it.POST /api/v4/brokersreplies:statusCodeis documented as a number, and fields that can come back
empty (address,city,phoneNumberand others) are documented as nullable;statusDateis a date,
andbranches[].contactDateis a date that can benull.- Responses that never carry
meta.paginationormeta.countno longer document them.
Pages that stop answering
/docs,/api/docs,/api/docs/redoc,/api/docs/openapi.jsonand/api/documentationanswer 404 from the
release date. The 4.1 contract is served at/api/docs/v4/openapi.json, with/api/docs/v4and
/api/docs/v4/redocbeside it, and this site documents it.
Known limitations in 4.1
PATCH /api/v4/borrowers/{id}/custom-fieldsdoes not skip unchanged items, so sending back a stored
choice your company has since removed is a 422 for the whole body.- Writes drop unknown query parameters and unknown keys inside the body without a warning; only the
FIELD_IGNOREDcases under Writes are named. A misplaced or misspeltdryRunis the exception (422,
see Writes). - For a fee pair, a change to the percent alone is lost if you send the whole body back: the unchanged
amount wins, andmeta.warningsnames the dropped percent. Send the percent without the amount. - Sending back a stored contingency reserve percent above 100 answers 422.
- A branch that offers no file type refuses any
fileTypewhen a loan is created. - An upload too large for the server can answer with a generic "failed to upload" message rather than
the size message. - Under heavy concurrency the rate limit can admit a few calls over the allowance, and a field the API
skips as unchanged can lose to another save that commits while your request is being processed.
New names for existing fields
4.1 gives some fields and query parameters a new name. During a naming window both names work: a request
may use either, and a reply sends both, with the same value (for active, role and assignedAt, the
same value in its new form). The old names are marked deprecated in the
reference, and a reply to a request that used one carries a Deprecation header. Each old name will be
removed on a date announced in the API changelog, 90 days after the announcement. No date is announced
yet. New code should use the new names.
For an API key, GET /api/v4/loans still ignores search, perPage, archiveState and primaryStatusId
(and archive_state and primary_status_id), as listed under What stays the same for API keys: page
it with per_page. That reply carries a Deprecation header, because per_page is an old name
on other lists: on this route, for an API key, ignore it for now. No removal date is announced.
On the loan file (GET /api/v4/loans/{id}, the GET /api/v4/loans rows, and every reply that returns
the loan file)
| Old name | New name |
|---|---|
branchID | branchId |
loanBrokerID | brokerId |
loanOfficerID | loanOfficerId |
createdAt | createdDate (a date, YYYY-MM-DD) |
activeStatus (1 or 0) | active (true or false) |
primaryStatus | primaryStatusLabel |
borrower.borrowerSSN, borrowerDL, borrowerDLState, borrowerDLExpDate | borrowerSsn, borrowerDl, borrowerDlState, borrowerDlExpDate |
entity.entityEIN | entityEin |
entity.members[].memberSSN, memberDL, memberDLState, memberDOB | memberSsn, memberDl, memberDlState, memberDateOfBirth |
loan.loanARV, loan.propertyHOAFees | loanArv, propertyHoaFees |
loan.amortization.term_months | termMonths |
properties[].propertyLTV, propertyAnnualHOAFees, property30YearAMDSCR | propertyLtv, propertyAnnualHoaFees, property30YearAmDscr |
properties[].propertyITIA, propertyPITIA, propertyInterrestOnlyPayment | propertyItia, propertyPitia, propertyInterestOnlyPayment |
Query parameters on GET /api/v4/loans and GET /api/v4/loans/summary
| Old name | New name |
|---|---|
broker_id, borrower_id, loan_officer_id | brokerId, borrowerId, loanOfficerId |
include_archived, archive_state | includeArchived, archiveState |
loan_number, primary_status_id | loanNumber, primaryStatusId |
created_from, created_to | createdFrom, createdTo |
modified_from, modified_to | modifiedFrom, modifiedTo |
Elsewhere
| Old name | New name | Where |
|---|---|---|
per_page | perPage | Every paged list except GET /api/v4/tasks, which takes only perPage. The reference lists and directories answer an API key with every row and ignore both |
agentType (broker, loan_officer) | role (broker, loan-officer) | Brokers, loan officers, and a loan's broker and loan officer |
activeStatus | active | POST /api/v4/brokers replies |
category | categoryLabel | GET /api/v4/loan-sub-statuses |
section, type | sectionLabel, typeLabel | GET /api/v4/custom-fields |
dateAssigned | assignedAt (with the Eastern offset) | A loan's back-office employees |
timezone | timeZone | GET /api/v4/platform/runtime |
error.requestId, error.timestamp | meta.requestId, meta.timestamp | Every refused call |
The amortization type also accepts interest-only beside interest_only. Replies keep sending
interest_only until the window ends.
Deprecations
| Deprecated | Use instead | Retirement |
|---|---|---|
DELETE /api/v4/loans/{id}/broker | PATCH /api/v4/loans/{id}/broker with {"brokerId": null} | Kept as an alias with a Deprecation header. No sunset date yet |
DELETE /api/v4/loans/{id}/loan-officer | PATCH /api/v4/loans/{id}/loan-officer with {"loanOfficerId": null} | Kept as an alias with a Deprecation header. No sunset date yet |
PUT /api/v4/loans/{id}/employees | PATCH /api/v4/loans/{id}/employees | Sends Sunset: Wed, 09 Dec 2026 00:00:00 GMT. Whether it is removed is decided with the next major version |
POST /api/v4/authenticate, /refresh, /validate | an API key (see Get started) | Legacy sign-in. Still working |
error.requestId, error.timestamp | meta.requestId, meta.timestamp | Removed on a date announced in the API changelog |
| the old names under New names for existing fields | the new names beside them | Both names work during the window. Each is removed on a date announced in the API changelog, 90 days after the announcement |

