V3 Manage Home Counseling Providers List

patch

https://api.elliemae.com/encompass/v3/loans/{loanId}/homeCounselingProviders

API to manage the list of Home Counseling Providers list in the loan. Possible operations on this entity are: add, update, reorder and delete.

Path Params

loanId

string

required

Unique identifier of the loan. Required.

Query Params

action

string

Action to be performed on the Home Counseling Provider entity. Possible values are: add, update, reorder, delete.

Body Params

string

System-generated, unique identifier for the Home Counseling Provider in the loan

selectedIndicator

boolean

Indicates if the HCP is selected

agencyName

string

Name of Agency

agencyAddress

string

Address of Agency

agencyAddressCity

string

City of Agency

agencyAddressState

string

State of Agency

agencyAddressPostalCode

string

Postal Code of Agency

agencyPhoneDirect

string

Direct Phone Number of Agency

agencyPhoneTollFree

string

Toll Free Phone Number of Agency

agencyFax

string

Fax Number of Agency

agencyEmail

string

Email Address of Agency

agencyWebAddress

string

Web Address of Agency

languagesSupported

string

Languages supported by the Agency

counselingServicesProvided

string

Counseling Services Provided by the Agency

agencyAffiliationIndicator

boolean

Indicates Agency Affiliation

agencyAffiliationDescription

string

Agency Affiliation Description

agencySource

string

Source of Agency

distanceMiles

number

Number of miles in distance from the address

agencyId

string

ID of the Agency

homeCounselingProviderId

string

Home Counseling Provider ID

Headers

Authorization

string

required

Bearer token

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language

URL

Loading…

Response

Choose an example:

application/json

200OK