Total Expert Loan Endpoints API
The Loan Endpoints API from Total Expert — 10 operation(s) for loan endpoints.
OpenAPI Specification
openapi: 3.0.3
info:
title: Total Expert Public Account Endpoints Loan Endpoints API
version: v1
description: "The Total Expert REST API allows you to programmatically create, retrieve, update, and delete information through various endpoints.\n\nDocumentation Layout\n\nEach section of this documentation describes a collection of related endpoints that affect a given resource.\n\nWhere applicable, at the top of a section you will find a table listing the attributes for the resource and a second showing its relationships with other resources.\n\nNOTE: If an attribute is marked as 'Assignable', its value can be set via a POST/PATCH. You can also modify the data for an 'Assignable' relationship.\n\nAuthentication in the TE API\n\nInteraction with the TE API is protected with OAuth 2.0. A client ID/secret pair is required to use the API.\n\nThe ID/secret pair is used to request an access token from the '/token' endpoint. This token will need to be present within the header on all calls to the API.\n\nNOTE: See the 'Authentication' endpoint collection for more information. See the 'Heartbeats' endpoint collection for more information on how to test your authentication.\n\nEndpoint Standards\n\nEach endpoint provides interaction with two aspects of an entity:\n\n'Attributes' - Attributes of the entity itself. Includes things like first name, phone number, or birthday of the contact.\nE.g. A 'Contact'\n\n'Relationships' - Describe a relationship between that entity and another entity.\nE.g. A contact that has an owner in the TE System OR a set of contact groups (separate entities with their own endpoint).\n\nAttributes\n\nEach endpoint returns a JSON object with a set of attributes. Each endpoint collection should describe the names and types of attributes available in each endpoint.\n\nData Types\n\nEach attribute has a type. There are four data types in the TE API - Numeric, String, Boolean, and Date.\n\nData Types\n\nType\nDescription\n\nNumeric\nInteger or floating point numbers. Supplied with no surrounding quotes. e.g. { \"loan_rate\":4.5 }\n\nString\nString of characters - supplied surrounded with quotes. e.g. { \"first_name\":\"Clark\" }\n\nBoolean\nTruth value - supplied in one of two ways - see Boolean (String) and Boolean (Numeric) for details\n\nBoolean (String)\nTruth value - supplied as the word \"True\" or \"False\", surrounded by quotes. e.g. { \"first_time_buyer\":\"True\" }\n\nBoolean (Numeric)\nTruth value - supplied as the number 1 or 0, not surrounded by quotes. e.g. { \"first_time_buyer\":0 }\n\nDate\nA date and time - preferred supplied in the format \"YYYY-MM-DD hh:mm:ss\". All dates must be provided in UTC timezone. When returned, the value will be expressed in UTC. To clear a field with a date type, use the value \"0000-00-00 00:00:00\".\n\nPhone Numbers\n\nPhone numbers are accepted in any format. For deduplication, any non-numeric symbols will be stripped out and the numeric phone number will be stored separately. If a numerically identical phone number is used in a different format later, the records are compared using the numeric value only. This applies only to phone numbers with at least 7 digits.\n\nAll phone numbers will also be converted into E164 for use in external services (e.g. Twilio). If a phone number cannot be converted into E164, the number will be marked 'Invalid', and external services that rely on phone numbers will not function.\n\nUniqueness in the TE API\n\nEach type of entity in the TE API can be uniquely identified by a set of attributes. In some cases, multiple options are available to uniquely identify an entity. See each section below for details. These sets of attributes are used to deduplicate entries on creation and to uniquely identify the target in a relationship.\n\nRelationships\n\nRelationships in the TE API are very flexible.\n\n'GET'ing\n\nWhen GETing an entity, a relationship will be returned with only a partial set of attributes that make sense in the context of that endpoint - e.g. the 'contact_groups' relationship on the '/contacts' endpoint will display only the group name of the target contact_group.\n\nPOST and PATCH Requests\n\nWhen setting a relationship (by POST or PATCH), the target entity is specified using one or more attributes that uniquely identify the entity.\n\nThe allowed attributes are listed in the 'Settable Fields' column of each Relationships table. For example, when POSTing to the '/contact-groups' endpoint, either of the following are allowed:\n\n{\n \"group_name\": \"Hot Leads\",\n \"owner\":{\"username\": \"alfred\"}\n }\n OR\n\n{\n \"group_name\": \"Hot Leads\",\n \"owner\":{\"id\": \"123589\"}\n }\n\nIn cases where an endpoint's relationship supports multiple Settable Fields be aware that the request examples may only make use of one of the attributes though any could be used in its place.\n\nInteracting with the API\n\nAdmin Calls vs User Calls\n\nYou'll notice that many sections of the documentation have samples for POSTs and GETs that are labeled \"As Admin\" or \"As User\".\nWhen using client credentials to access the API, you'll use the \"As Admin\" examples. For Authorization Code access, you'll use the \"As User\" examples.\n\n'GET'ing\n\nThere are two types of GETable endpoints in the TE API: Paging and Individual. Paging endpoints provide lists of entities. E.g. '/contacts' returns a list of contacts.\n\nGetting Individual Entities\n\nIndividual endpoints return specific individual entities, specified by TE ID. E.g. '/contacts/51151' returns the contact with the 'id' attribute '51151' (the TE internal identifier).\n\nGetting Multiple Entities (Paging)\n\nPaging endpoints will return an object with two properties: 'objects' and 'links'. The 'objects' property will be an array of entities in 'pages'. Each page will have a number of entities along with a set of links. The page size and page number can be specified using the '?page' GET parameter. Setting '?page[number]=5' will return the fifth page. Setting '?page[size]=100' will make each page consist of 100 items, instead of the default of 10. Both attributes can be set together. E.g. setting '?page[size]=100&page[number]=6' will return items 501-600.\n\nPaging Links\n\nThe 'links' attribute on a page object will have four attributes, specifying metadata about the number of entities available to page.\n\n'first' will be the page number of the first page of entities (always '1').\n\n'last' will be the page number of the last page of entities.\n\n'next' will be the page number of the next page after the currently requested one. 'next' may be null if there are no subsequent pages.\n\n'prev' will be the page number of the page immediately preceding the current one. 'prev' may be null if there are no preceding pages.\n\n'POST'ing\n\nEntities can be created in the TE system by POSTing to paging endpoints. E.g. sending a POST to '/contacts' will create a contact.\n\nDeduplication\n\nWhen POSTing an entity, the TE API will attempt to 'Deduplicate' by searching for existing entities with similar attributes. If such a duplicate does exist, the TE API will treat the POST as a PATCH to that entity instead. See each section for details on what attributes will be used to search for duplicates.\n\n'PATCH'ing\n\nEntities can be updated in the TE system by PATCHing to individual endpoints. E.g. sending a PATCH to '/contacts/51151' will update the attributes of the contact with TE 'id' of '51151'.\n\n'DELETE'ing\n\nEntities can be deleted only by TE ID. Send a DELETE request to the appropriate individual entity endpoint to delete it.\n\nReturn Codes\n\nWhere applicable, the API will respond with an HTTP status code that indicates what happened during the request. Possible values include:\n\nHTTP CODES\n\nStatus Code\nGeneral Description\n\n200 SUCCESS\nThe operation completed successfully. See the response body for details (if applicable).\n\n201 CREATED\nThe object was created successfully. See the response body for details (if applicable).\n\n400 BAD REQUEST\nThe JSON supplied to the API was malformed and unparseable.\n\n401 UNAUTHORIZED\nThe request's credentials are invalid. This could mean your token has expired and should be renewed. See the response body for details.\n\n403 FORBIDDEN\nAn attempt was made to access a resource for which you do not have permission\n\n405 METHOD NOT ALLOWED\nAn attempt was made to interact with an endpoint in an unsupported manner, e.g. sending a POST to '/contacts/1'\n\n415 UNSUPPORTED MEDIA TYPE\nThe API endpoints expect a content type of 'media/json'\n\n422 UNPROCESSABLE ENTITY\nThe JSON body supplied is valid, but not processable semantically. For example, the 'owner' relationship for a contact refers to a User that does not exist in the TE system.\n\n418 I'M A TEAPOT\nThe API is a teapot (See the 'Heartbeat' section for details).\n\n503 SERVICE UNAVAILABLE\nThe API is unavailable. Please try your request again later. If this message persists, please contact Technical Support"
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