V3 Update External Organization

patch

https://api.elliemae.com/encompass/v3/settings/externalOrganizations/tpos/{orgId}

Update an external organization.

Usage Notes

To update the TPO Organization Settings, you must have the TPO Org Settings permission including a permission for the underlying object being modified (e.g., DBA, Warehouse).
External user is not authorized to edit org details.

Path Params

orgId

string

required

Organization ID. Required

Body Params

integer

RetrieveOnly. Unique Identifier of the Third-Party Originator (TPO) company / external organization. Required for retrieving, updating, or deleting the org details or orgId.

tpoId

string

RetrieveOnly. System generated unique identifier for the TPO company and its branches in its hierarchy.

parentOrg

object

RetrieveOnly. Details about the parent organization.

childOrganizations

array of objects

RetrieveOnly. Details about the child organizations.

childOrganizations

primarySalesRepAe

object

Required. Indicates your company’s account executive assigned to this TPO as a primary sales representative. An external organization must have an associated primary sales representative.

Name

string

Name of the TPO company. This is the unique identifier for the company. Maximum length is 128 characters.

hierarchyPath

string

RetrieveOnly. Represents the hierarchy path from root level for the current organization. Example: Third Party Originators\Loan Officers.

isLoginDisabled

boolean

Indicates if the TPO company is deactivated.

isMfaEnabled

boolean

Indicates if multi-factor authentication (MFA) is required for the TPO company connect sites.

brokerOptions

string

Used to select whether you want to "Disable Fee Management" for your brokers (default), enable them to "Request LE & Disclosures" or enable them to "Generate LE & Disclosures". Only one option can be selected.

Enum: DisableFeeManagement, RequestLEAndDisclosures, GenerateLE, GenerateLEAndDisclosures

companyDetails

object

Indicates the basic and corporate information related to the TPO company.

basicInfo

object

Indicates the additional information like Rate Lock, Product and Pricing, Approval Status, and Business information related to the TPO company.

dba

object

Used for managing multiple DBA (Doing Business As) names associated with the TPO company. Authorized users can add, edit, delete, and arrange the sequence of DBA names displayed in the DBA list. You can also indicate the default DBA for the TPO company.

warehouse

object

Used to manage the warehouse banks associated with this TPO. Authorized users have the ability to select from a list of banks set up by the Encompass administrator in the Banks setting.

You can also update business information related to the bank, include notes, and update contact information associated with the bank.

Commitments

object

Used to manage and track the TPO company's assigned commitment authority.

loanCriteria

object

Used to manage external org loan criteria and specify the type of loans, and from which loan origination channel that the TPO can submit to your company.

CustomFields

object

Used to manage custom fields. Authorized users can enter custom data for these fields. The custom fields are configured in the TPO Custom fields settings.

tpocSetup

object

Used to manage the TPOC setup. This will define TPO Connect site details that the TPO company will use to manage loan files.

Headers

Authorization

string

required

Bearer token

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

Language

URL

Loading…

Response

Choose an example:

application/json

200OK