V3 Manage Home Counseling Providers List

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
string
required

Unique identifier of the loan. Required.

Query Params
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

boolean

Indicates if the HCP is selected

string

Name of Agency

string

Address of Agency

string

City of Agency

string

State of Agency

string

Postal Code of Agency

string

Direct Phone Number of Agency

string

Toll Free Phone Number of Agency

string

Fax Number of Agency

string

Email Address of Agency

string

Web Address of Agency

string

Languages supported by the Agency

string

Counseling Services Provided by the Agency

boolean

Indicates Agency Affiliation

string

Agency Affiliation Description

string

Source of Agency

number

Number of miles in distance from the address

string

ID of the Agency

string

Home Counseling Provider ID

Headers
string
required

Bearer token

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language
URL
LoadingLoading…
Response
Choose an example:
application/json