Total Expert Loan Endpoints API
The Loan Endpoints API from Total Expert — 10 operation(s) for loan endpoints.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/total-expert-loan-endpoints-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Total Expert Public Loan Endpoints API
version: v1
description: The Total Expert REST API allows you to programmatically create, retrieve, update, and delete information through various endpoints.
contact:
url: https://developer.totalexpert.net
servers:
- url: https://public.totalexpert.net
description: Total Expert external API — production
- url: https://public.vt.totalexpert.net
description: Total Expert external API — development/sandbox domain (isolated from live data; per the Vendor OAuth Integration Guide)
security:
- oauth2: []
tags:
- name: Loan Endpoints
paths:
/v1/loans/{loan_id}:
get:
operationId: fetchLoan
summary: Fetch Loan
description: Fetch a specific loan type specified by ID.
tags:
- Loan Endpoints
responses:
'200':
description: Success. See the Total Expert Public API documentation for the response shape.
parameters:
- name: loan_id
in: path
required: true
schema:
type: string
patch:
operationId: updateLoan
summary: Update Loan
description: Update an existing loan by ID.
tags:
- Loan Endpoints
responses:
'200':
description: Success. See the Total Expert Public API documentation for the response shape.
parameters:
- name: loan_id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
example:
external_id: '2161006'
loan_number: '2161006'
loan_rate: '4.00'
loan_term: 360
appraised_value: '450000.00'
is_first_time_buyer: 0
address: 446 Second St
city: Middlesex
state: NJ
zip_code: 8846
loan_amount: '357904.00'
loan_to_value_combined: '86.24'
occupancy_type: Owner
lock_status: Locked
escrow_waived: 0
application_date: '2016-07-27 00:00:00'
appraisal_ordered_date: '2017-04-21 00:00:00'
appraisal_received_date: '2017-04-28 00:00:00'
closing_date: '2017-05-19 00:00:00'
created_date: '2017-06-06 15:51:19'
last_modified_date: '2017-05-15 06:55:00'
first_payment_date: '2017-06-01 00:00:00'
lock_date: '2017-04-26 00:00:00'
lock_expiration_date: '2017-05-25 00:00:00'
processing_start_date: '2016-08-05 00:00:00'
underwriting_submission_date: '2016-08-02 00:00:00'
internal_created_at: '2017-06-06 15:51:19'
internal_updated_at: '2017-06-06 15:51:20'
coborrower:
id: 1186
loan_program:
loan_program: 30-year Fixed
loan_purpose:
loan_purpose: New
loan_status:
loan_status: In review
loan_type:
loan_type: Conventional Fixed Rate
account_class:
class_name: mortgage
class_type: LOAN
delete:
operationId: deleteLoan
summary: Delete Loan
description: Deletes a loan by ID.
tags:
- Loan Endpoints
responses:
'200':
description: Success. See the Total Expert Public API documentation for the response shape.
parameters:
- name: loan_id
in: path
required: true
schema:
type: string
/v1/loans:
get:
operationId: fetchLoans
summary: Fetch Loans
description: Fetch a page of loans. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.
tags:
- Loan Endpoints
responses:
'200':
description: Success. See the Total Expert Public API documentation for the response shape.
parameters:
- name: page[number]
in: query
required: false
schema:
type: string
example: '1'
- name: page[size]
in: query
required: false
schema:
type: string
example: '10'
post:
operationId: createLoanAsAdmin
summary: Create Loan (as Admin)
description: 'Create a loan.
Required Attributes:
external_id
Required Relationships:
owner
borrower
Must have required fields for contact creation, found here: Create Contact (as Admin)
any other required loan participant roles, which can be found using the Fetch Loan Participant Roles request (requires describeSchema scope to access)
Alternate documented request: Create Loan (as User).'
tags:
- Loan Endpoints
responses:
'200':
description: Success. See the Total Expert Public API documentation for the response shape.
requestBody:
content:
application/json:
examples:
default:
value:
external_id: '2161010'
loan_number: '2161010'
address: 446 Second St
city: Middlesex
state: NJ
zip_code: 08846
owner:
username: jsmith
borrower:
source: PCLender
first_name: Jenny
last_name: Kristoff
email: jennyK@example.com
custom:
- field_name: custom_string
value: the custom field string value
coborrower:
source: PCLender
first_name: Anthony
last_name: Kristoff
email: anthonyK@example.com
loan_program:
loan_program: 10-year Fixed
loan_purpose:
loan_purpose: Refinance
loan_status:
loan_status: Pending
loan_type:
loan_type: Conventional Fixed Rate
loan_subordinate_financing_type:
loan_subordinate_financing_type: HELOC
buyers_agent:
source: PCLender
first_name: Jay
last_name: Jenkel
email: jagent@example.com
sellers_agent:
source: PCLender
first_name: Fred
last_name: Ingle
email: fseller@example.com
settlement_agent:
source: PCLender
first_name: Angie
last_name: Deedle
email: asettlement@example.com
account_class:
class_name: mortgage
class_type: LOAN
custom:
- field_name: custom_string
value: the custom field string value
create-loan-as-user:
value:
external_id: '2161006'
loan_number: '2161006'
loan_rate: '4.00'
loan_term: 360
appraised_value: '450000.00'
is_first_time_buyer: 0
address: 446 Second St
city: Middlesex
state: NJ
zip_code: 08846
loan_amount: '357904.00'
loan_to_value_combined: '86.24'
occupancy_type: Owner
lock_status: Locked
escrow_waived: 0
application_date: '2016-07-27 00:00:00'
appraisal_ordered_date: '2017-04-21 00:00:00'
appraisal_received_date: '2017-04-28 00:00:00'
closing_date: '2017-05-19 00:00:00'
created_date: '2017-06-06 15:51:19'
last_modified_date: '2017-05-15 06:55:00'
first_payment_date: '2017-06-01 00:00:00'
lock_date: '2017-04-26 00:00:00'
lock_expiration_date: '2017-05-25 00:00:00'
processing_start_date: '2016-08-05 00:00:00'
underwriting_submission_date: '2016-08-02 00:00:00'
internal_created_at: '2017-06-06 15:51:19'
internal_updated_at: '2017-06-06 15:51:20'
borrower:
id: 502
coborrower:
id: 502
loan_program:
loan_program: 30-year Fixed
loan_purpose:
loan_purpose: New
loan_status:
loan_status: In review
loan_type:
loan_type: Conventional Fixed Rate
loan_subordinate_financing_type:
loan_subordinate_financing_type: HELOC
account_class:
class_name: mortgage
class_type: LOAN
custom:
- field_name: custom_string
value: the custom field string value
/v1/loan-types/{type_id}:
get:
operationId: fetchLoanType
summary: Fetch Loan Type
description: Fetch a specific loan type specified by ID.
tags:
- Loan Endpoints
responses:
'200':
description: Success. See the Total Expert Public API documentation for the response shape.
parameters:
- name: type_id
in: path
required: true
schema:
type: string
/v1/loan-types:
get:
operationId: fetchLoanTypes
summary: Fetch Loan Types
description: Fetch a page of loan types. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.
tags:
- Loan Endpoints
responses:
'200':
description: Success. See the Total Expert Public API documentation for the response shape.
parameters:
- name: page[number]
in: query
required: false
schema:
type: string
example: '1'
- name: page[size]
in: query
required: false
schema:
type: string
example: '10'
post:
operationId: createLoanType
summary: Create Loan Type
description: 'Create a loan type.
Required Attributes:
loan_type
Required Relationships:
owning_organization*
*required if authenticated as an TE admin'
tags:
- Loan Endpoints
responses:
'200':
description: Success. See the Total Expert Public API documentation for the response shape.
requestBody:
content:
application/json:
example:
loan_type: Conventional Fixed Rate
account_class:
class_name: mortgage
class_type: LOAN
/v1/loan-statuses/{status_id}:
get:
operationId: fetchLoanStatus
summary: Fetch Loan Status
description: Fetch a specific loan status specified by ID.
tags:
- Loan Endpoints
responses:
'200':
description: Success. See the Total Expert Public API documentation for the response shape.
parameters:
- name: status_id
in: path
required: true
schema:
type: string
/v1/loan-statuses:
get:
operationId: fetchLoanStatuses
summary: Fetch Loan Statuses
description: Fetch a page of loan statuses. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.
tags:
- Loan Endpoints
responses:
'200':
description: Success. See the Total Expert Public API documentation for the response shape.
parameters:
- name: page[number]
in: query
required: false
schema:
type: string
example: '1'
- name: page[size]
in: query
required: false
schema:
type: string
example: '10'
post:
operationId: createLoanStatus
summary: Create Loan Status
description: 'Create a loan status.
Required Attributes:
loan_status
Required Relationships:
owning_organization*
*required if authenticated as an TE admin'
tags:
- Loan Endpoints
responses:
'200':
description: Success. See the Total Expert Public API documentation for the response shape.
requestBody:
content:
application/json:
example:
loan_status: Pending
account_class:
class_name: mortgage
class_type: LOAN
/v1/loan-purposes/{purpose_id}:
get:
operationId: fetchLoanPurpose
summary: Fetch Loan Purpose
description: Fetch a specific loan purpose specified by ID.
tags:
- Loan Endpoints
responses:
'200':
description: Success. See the Total Expert Public API documentation for the response shape.
parameters:
- name: purpose_id
in: path
required: true
schema:
type: string
/v1/loan-purposes:
get:
operationId: fetchLoanPurposes
summary: Fetch Loan Purposes
description: Fetch a page of loan purposes. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.
tags:
- Loan Endpoints
responses:
'200':
description: Success. See the Total Expert Public API documentation for the response shape.
parameters:
- name: page[number]
in: query
required: false
schema:
type: string
example: '1'
- name: page[size]
in: query
required: false
schema:
type: string
example: '10'
post:
operationId: createLoanPurpose
summary: Create Loan Purpose
description: 'Create a loan purpose.
Required Attributes:
loan_purpose
Required Relationships:
owning_organization*
*required if authenticated as an TE admin'
tags:
- Loan Endpoints
responses:
'200':
description: Success. See the Total Expert Public API documentation for the response shape.
requestBody:
content:
application/json:
example:
loan_purpose: Refinance
account_class:
class_name: mortgage
class_type: LOAN
/v1/loan-programs/{program_id}:
get:
operationId: fetchLoanProgram
summary: Fetch Loan Program
description: Fetch a specific loan program specified by TE ID.
tags:
- Loan Endpoints
responses:
'200':
description: Success. See the Total Expert Public API documentation for the response shape.
parameters:
- name: program_id
in: path
required: true
schema:
type: string
/v1/loan-programs:
get:
operationId: fetchLoanPrograms
summary: Fetch Loan Programs
description: Fetch a page of loan programs. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.
tags:
- Loan Endpoints
responses:
'200':
description: Success. See the Total Expert Public API documentation for the response shape.
parameters:
- name: page[number]
in: query
required: false
schema:
type: string
example: '1'
- name: page[size]
in: query
required: false
schema:
type: string
example: '10'
post:
operationId: createLoanProgram
summary: Create Loan Program
description: 'Create a loan program.
Required Attributes:
loan_program
Required Relationships:
owning_organization*
*required if authenticated as an TE admin'
tags:
- Loan Endpoints
responses:
'200':
description: Success. See the Total Expert Public API documentation for the response shape.
requestBody:
content:
application/json:
example:
loan_program: 10-year Fixed
account_class:
class_name: mortgage
class_type: LOAN
components:
securitySchemes:
oauth2:
type: oauth2
description: OAuth 2.0. Obtain a token from POST /v1/token using HTTP Basic (client_id:client_secret base64-encoded) plus a grant_type body. Access tokens are bearer tokens, expires_in 3600.
flows:
clientCredentials:
tokenUrl: https://public.totalexpert.net/v1/token
scopes:
crm: Documented example scope (Vendor OAuth Integration Guide authorize example)
leadInteraction: Lead interaction access (documented in the collection token examples)
loanInteraction: Loan interaction access (documented in the collection token examples)
leadSurveyInteraction: Lead survey interaction access (documented example in the Vendor OAuth Integration Guide)
postLeads: Post leads access (documented example in the Vendor OAuth Integration Guide)
authorizationCode:
authorizationUrl: https://public.totalexpert.net/v1/authorize
tokenUrl: https://public.totalexpert.net/v1/token
refreshUrl: https://public.totalexpert.net/v1/token
scopes:
crm: Documented example scope (Vendor OAuth Integration Guide authorize example)
leadInteraction: Lead interaction access (documented in the collection token examples)
loanInteraction: Loan interaction access (documented in the collection token examples)
leadSurveyInteraction: Lead survey interaction access (documented example in the Vendor OAuth Integration Guide)
postLeads: Post leads access (documented example in the Vendor OAuth Integration Guide)
externalDocs:
description: Total Expert Public API documentation (Postman)
url: https://documenter.getpostman.com/view/1929166/total-expert-public-api/6Z2RYyU