GuidesRecipesAPI Reference
Log In
API Reference

🚧 Update a loan application (BETA)

patch
https://api.ncinomortgage.com/loan_applications/
🚧

Under construction

This endpoint is in beta. Functionality may change without notice, support is limited, and use in production is not recommended. Your feedback is appreciated.

Update a loan application. Param keys with _INDEX should replace _INDEX with a number 1-5 for each entity being verified (e.g. vogg_gift_amount_1 for first gift, vogg_gift_amount_2 for second gift).

đź“Ś

Replacing indexed key series

Use lists_to_update to replace indexed key series.
Keys are the value prefix (e.g. global_asset_type for keys like global_asset_type_1, global_asset_type_2).
All existing keys matching {prefix}_{number} are removed and replaced with the provided values.
Each prefix is processed independently. Pass an empty hash to remove all keys for that prefix.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Loan application ID

Body Params

The available properties for creating and modifying a loan application record

string | null

Borrower's first name. Including first_name and last_name enables prospect creation and CRM sync.

string | null

Borrower's last name. Including first_name and last_name enables prospect creation and CRM sync.

boolean | null

Whether additional real estate is owned.

string | null

Borrower's street.

integer | null

Amount of alimony paid by the borrower.

string | null

Specifies other Asian origin if applicable.

integer | null

Checking and savings account(s) amount.

integer | null

Additional asset(s) amount.

integer | null

Borrower's retirement assets amount.

borrower_bankruptcy_types
array of objects | null

Types of bankruptcies declared by the borrower.

borrower_bankruptcy_types
Allowed:
string | null

Borrower's cell phone number.

string | null

Borrower's country of citizenship.

string | null
enum

Types of citizenship a borrower declares on an application.

Allowed:
string | null

Borrower's work phone number.

boolean | null

Whether the borrower has conveyed a title in lieu of foreclosure.

string | null

Specifies other domestic relationships for the borrower.

enum

U.S. state where the borrower's domestic relationship is recognized.

State abbreviated code.

string | null
enum

Types of domestic relationship a borrower declares on an application.

Allowed:
string | null

External customer identifier for the borrower, persisted on the borrower's own AppUser record.

boolean | null

Whether borrower has a family or business relationship with the seller.

string | null

Borrower's home phone number.

borrower_military_details
array of objects | null

Details about the borrower's military service (e.g. currently on active duty, surviving spouse).

borrower_military_details
Allowed:
boolean | null

Whether the borrower has military service history.

date | null

Expiration date of borrower's military service if on active duty.

string | null

Borrower's mobile phone number.

boolean | null

Whether the borrower has property rights with a non-spouse.

integer | null

Amount of money borrowed or obtained from another source.

boolean | null

Whether borrower has a lien on another property.

boolean | null

Whether borrower has an undisclosed mortgage closing on or before a certain date.

boolean | null

Whether borrower has undisclosed new credit.

boolean | null

Whether borrower has undergone pre-foreclosure or a short sale.

boolean | null

Whether borrower is still employed at their second employer.

boolean | null

Authorization for borrower information sharing.

integer | null

How long the borrower has lived at the current address.

boolean | null

Whether borrower is self-employed in VOE employment.

string | null
enum

Types of service branches a borrower declares on an application.

Allowed:
boolean | null

Whether CHARM acknowledgments are signed (e.g. have they received a booklet?).

string | null

Borrower's city.

boolean | null

Whether coborrower’s income and employment verification is complete.

string | null

Coborrower's street.

boolean | null

Whether coborrower's address is the same as borrower's.

string | null
enum

Types of Asian origin a borrower declares on an application.

Allowed:
coborrower_bankruptcy_types
array of objects | null

Types of bankruptcies declared by the coborrower.

coborrower_bankruptcy_types
Allowed:
string | null
enum

Types of service branches a borrower declares on an application.

Allowed:
string | null

Coborrower’s cell phone number.

string | null

Coborrower’s country of citizenship.

string | null
enum

Types of citizenship a borrower declares on an application.

Allowed:
string | null

Coborrower’s city.

string | null

Coborrower’s work phone number.

boolean | null

Whether coborrower has conveyed title in lieu of foreclosure.

boolean | null

Whether coborrower has authorized credit checks.

string | null

Ages of coborrower’s dependents.

string | null

Coborrower’s date of birth (MM-DD-YYYY).

string | null

Specifies other domestic relationships for coborrower.

enum

U.S. state where the coborrower's domestic relationship is recognized.

State abbreviated code.

string | null
enum

Types of domestic relationship a borrower declares on an application.

Allowed:
boolean | null

Whether coborrower has provided eConsent.

string | null

Coborrower’s email address.

string | null

Coborrower’s employer name.

integer | null

Number of years coborrower has been with current employer.

string | null
enum

Types of employment status a borrower declares on an application.

Allowed:
string | null
enum

Types of ethnicity a borrower declares on an application.

Allowed:
string | null
enum

Types of latin ethnicity a borrower declares on an application.

Allowed:
string | null

External customer identifier for the coborrower, persisted on the coborrower's own AppUser record.

boolean | null

Whether coborrower has an affiliation with the seller.

string | null

Coborrower’s first name.

string | null
enum

Types of gender a borrower declares on an application.

Allowed:
boolean | null

Whether coborrower pays alimony.

boolean | null

Whether coborrower has declared bankruptcy.

boolean | null

Whether coborrower has delinquent debt.

boolean | null

Whether coborrower has had a foreclosure.

boolean | null

Whether coborrower has financial obligations.

boolean | null

Whether coborrower has outstanding judgments.

boolean | null

Whether coborrower has ownership interest in a property.

boolean | null

Whether coborrower is a co-maker or endorser on a loan.

boolean | null

Whether coborrower’s down payment is borrowed.

boolean | null

Whether coborrower is a first-time homebuyer.

boolean | null

Whether coborrower is a permanent resident.

boolean | null

Whether the coborrower will occupy the property as a primary residence.

boolean | null

Whether coborrower is self-employed.

boolean | null

Whether coborrower is a U.S. citizen.

string | null
enum

Languages a borrower declares on an application.

string | null

Other language preference specified by coborrower.

string | null

Coborrower’s last name.

string | null

Coborrower’s mailing street.

string | null

Coborrower’s mailing city.

boolean | null

Whether coborrower’s mailing address is the same as current.

string | null

Coborrower’s mailing state.

string | null

Coborrower’s mailing unit number.

string | null

Coborrower’s mailing zip code.

string | null
enum

Martial statuses a borrower declares on an application.

Allowed:
string | null

Coborrower’s middle name.

coborrower_military_details
array of objects | null

Details regarding coborrower’s military service.

coborrower_military_details
Allowed:
boolean | null

Whether coborrower has military service history.

date | null

Expiration date of coborrower’s military service if on active duty.

integer | null

Coborrower’s monthly income.

boolean | null

Whether coborrower has property rights with a non-spouse.

integer | null

Number of dependents of the coborrower.

string | null

Specifies other Hispanic or Latino origin for coborrower.

integer | null

Amount of money borrowed or obtained from another source by coborrower.

boolean | null

Whether coborrower has a lien on another property.

boolean | null

Whether coborrower has an undisclosed mortgage closing on or before a certain date.

boolean | null

Whether coborrower has undisclosed new credit.

string | null
enum

Types of Pacific Islander origin a borrower declares on an application.

Allowed:
string | null

Specifies other Pacific Islander origin for coborrower.

boolean | null

Whether coborrower is a party to a lawsuit.

boolean | null

Whether coborrower has undergone pre-foreclosure or a short sale.

string | null
enum

Types of title declaration a borrower declares on an application.

Allowed:
string | null
enum

Types of property declaration a borrower declares on an application.

Allowed:
integer | null

Number of months coborrower has owned the property.

string | null
enum

Types of residential ownership a borrower declares on an application.

Allowed:
integer | null

Number of years coborrower has owned the property.

string | null
enum

Types of race a borrower declares on an application.

Allowed:
string | null

Specifies other American Indian origin for coborrower.

string | null
enum

Types of Asian origin a borrower declares on an application.

Allowed:
integer | null

Monthly rent payment by coborrower.

boolean | null

Authorization for coborrower’s information sharing.

string | null

Coborrower’s Social Security Number.

string | null

Coborrower’s state of residence.

string | null
enum

Suffixes a borrower declares on an application.

Allowed:
boolean | null

Whether coborrower has the same time at the current address as borrower.

integer | null

How long the coborrower has lived at the current address.

string | null
enum

Types of military service a borrower declares on an application.

Allowed:
string | null

Coborrower’s unit number.

boolean | null

Whether coborrower is self-employed in VOE employment.

string | null

Coborrower’s zip code.

string | null
enum

Methods in which a borrower gives credit authorization on an application.

Allowed:
boolean | null

Authorization for credit check.

string | null

Ages of dependents.

integer | null

Desired monthly payment.

string | null

Borrower's date of birth (MM-DD-YYYY).

integer | null

Down payment amount.

integer | null

Exact down payment amount.

integer | null

Percentage of down payment.

string | null
enum

Down payment sources a borrower declares on an application.

boolean | null

Borrower’s electronic consent.

string | null

Employer's street.

string | null

Employer's city.

string | null

Name of employer.

string | null

Employer's state.

integer | null

Years employed at current employer.

string | null

Employer's zip code.

string | null
enum

Types of employment status a borrower declares on an application.

Allowed:
integer | null

Estimated value of the property.

string | null
enum

Types of ethnicity a borrower declares on an application.

Allowed:
string | null
enum

Types of latin ethnicity a borrower declares on an application.

Allowed:
string | null
enum

Types of gender a borrower declares on an application.

Allowed:
boolean | null

Whether borrower pays alimony.

boolean | null

Whether borrower has declared bankruptcy.

boolean | null

Whether application has a coborrower.

boolean | null

Whether borrower has delinquent debt.

boolean | null

Whether borrower has had a foreclosure.

boolean | null

Whether borrower has other financial obligations.

boolean | null

Whether borrower has outstanding judgments.

boolean | null

Whether borrower has ownership interest in a property.

boolean | null

Whether borrower is a co-maker or endorser.

boolean | null

Whether down payment is borrowed.

boolean | null

Whether borrower is a first-time homebuyer.

boolean | null

Whether borrower is a permanent resident.

boolean | null

Whether the borrower will occupy the property as a primary residence.

boolean | null

Whether borrower is self-employed.

boolean | null

Whether borrower is a U.S. citizen.

boolean | null

Whether borrower has veteran status.

string | null
enum

Languages a borrower declares on an application.

string | null

Other language preference specified by borrower.

integer | null

Loan amount requested.

string | null

Loan and refinance information.

string | null
enum

Types of loan purposes a borrower declares on an application.

Allowed:
string | null

Borrower’s mailing address.

string | null

Borrower’s mailing city.

boolean | null

Whether mailing address is the same as current.

string | null

Borrower’s mailing state.

string | null

Borrower’s mailing unit number.

string | null

Borrower’s mailing zip code.

string | null
enum

Martial statuses a borrower declares on an application.

Allowed:
string | null

Borrower’s middle name.

integer | null

Borrower’s monthly income.

integer | null

Borrower’s monthly liabilities.

integer | null

Number of dependents of the borrower.

string | null
enum

Types of occupancy a borrower declares on an application.

Allowed:
string | null

Specifies other Hispanic or Latino origin.

boolean | null

Whether borrower owns another property.

string | null
enum

Types of Pacific Islander origin a borrower declares on an application.

Allowed:
string | null

Specifies other Pacific Islander origin.

boolean | null

Whether borrower is a party to a lawsuit.

string | null
enum

Types of title declaration a borrower declares on an application.

Allowed:
string | null
enum

Types of property declaration a borrower declares on an application.

Allowed:
string | null

City where the property is located.

integer | null

Number of months borrower has owned the property.

string | null
enum

Types of residential ownership a borrower declares on an application.

Allowed:
string | null

State where the property is located.

string | null

Street address of the property.

string | null
enum

Types of properties a borrower declares on an application.

string | null

Unit number of the property.

integer | null

Number of years borrower has owned the property.

string | null

Zip code of the property.

integer | null

Purchase price of the property.

string | null
enum

Types of race a borrower declares on an application.

Allowed:
string | null

Specifies other American Indian origin.

string | null
enum

Types of Asian origin a borrower declares on an application.

Allowed:
string | null

Name of the referral company.

string | null
enum

Types of referral a borrower declares on an application.

Allowed:
string | null

Current address for refinance.

string | null
enum

Types of refinance purposes a borrower declares on an application.

integer | null

Monthly rent payment.

string | null

City of the rental property.

string | null

State of the rental property.

string | null

Street address of the rental property.

string | null

Unit number of the rental property.

string | null

Zip code of the rental property.

integer | null

Number of years borrower attended school.

boolean | null

Whether servicer credit authorization is provided.

string | null

Borrower’s Social Security Number.

enum

U.S. state where borrower resides.

State abbreviated code.

string | null
enum

Suffixes a borrower declares on an application.

Allowed:
string | null
enum

Types of credit a borrower declares on an application.

Allowed:
string | null
enum

Types of properties a borrower declares they intend to use it for on an application.

Allowed:
string | null
enum

Types of military service a borrower declares on an application.

Allowed:
boolean | null

Whether property is under contract.

string | null

Unit number of the property.

boolean | null

Whether borrower’s assets have been verified.

boolean | null

Whether borrower’s income and employment have been verified.

string | null

Borrower’s zip code.

string | null
enum

Types of employment a borrower declares on an application.

Allowed:
string | null
enum

Types of employment ownership a borrower declares on an application.

Allowed:
string | null

Name of employer being verified on borrower.

string | null

Street of borrower's employer's address.

string | null
enum

Types of residence units a borrower declares on an application.

string | null

Unit number of borrower's employer's address.

string | null

City borrower's employer resides in.

enum

U.S. state borrower's employer resides in.

State abbreviated code.

string | null

Zip code borrower's employer resides in.

string | null

Phone number for the borrower's employer.

string | null

Position or title borrower holds/held at employer.

date | null

Date the borrower was employed at employer.

boolean | null

Whether the borrower is still employer at employer.

date | null

Date the borrower finished working for employer.

integer | null

Income borrower reports if self-employed.

integer | null

Amount of base pay from borrower's employer.

integer | null

Amount of base pay hours from borrower's employer.

integer | null

Additional income amount from borrower's employer.

integer | null

Overtime amount from borrower's employer.

integer | null

Commissions amount from borrower's employer.

integer | null

Bonus amount from borrower's employer.

integer | null

Number of years borrower has been in line of work.

integer | null

Number of months borrower has been in line of work.

string | null

Street of residence being verified on borrower.

string | null

Unit number of residence being verified on borrower.

string | null

City of residence being verified on borrower.

enum

U.S. state of residence being verified on borrower.

State abbreviated code.

string | null

Zip of residence being verified on borrower.

integer | null

Number of years at residence being verified on borrower.

integer | null

Number of months at residence being verified on borrower.

string | null
enum

Types of residential ownership a borrower declares on an application.

Allowed:
string | null
enum

Types of employment a borrower declares on an application.

Allowed:
string | null
enum

Types of employment ownership a borrower declares on an application.

Allowed:
string | null

Name of employer being verified on coborrower.

string | null

Street of coborrower's employer's address.

string | null
enum

Types of residence units a borrower declares on an application.

string | null

Unit number of coborrower's employer's address.

string | null

City coborrower's employer resides in.

enum

U.S. state coborrower's employer resides in.

State abbreviated code.

string | null

Zip code coborrower's employer resides in.

string | null

Phone number for the coborrower's employer.

string | null

Position or title coborrower holds/held at employer.

date | null

Date the coborrower was employed at employer.

boolean | null

Whether the coborrower is still employer at employer.

date | null

Date the coborrower finished working for employer.

integer | null

Income coborrower reports if self-employed.

integer | null

Amount of base pay from coborrower's employer.

integer | null

Amount of base pay hours from coborrower's employer.

integer | null

Additional income amount from coborrower's employer.

integer | null

Overtime amount from coborrower's employer.

integer | null

Commissions amount from coborrower's employer.

integer | null

Bonus amount from coborrower's employer.

string | null

Details about coborrower's line of work.

integer | null

Number of years coborrower has been in line of work.

integer | null

Number of years coborrower has been in line of work.

string | null

Street of residence being verified on coborrower.

string | null

Unit number of residence being verified on coborrower.

string | null

City of residence being verified on coborrower.

enum

U.S. state of residence being verified on coborrower.

State abbreviated code.

string | null

Zip of residence being verified on coborrower.

integer | null

Number of years at residence being verified on borrower.

integer | null

Number of months at residence being verified on borrower.

string | null
enum

Types of residential ownership a borrower declares on an application.

Allowed:
string | null

Financial institution name.

string | null
enum

Applicant types of a borrower on an application.

Allowed:
string | null
enum

Types of gifts a borrower declares on an application.

Allowed:
string | null
enum

Applicant types of a borrower on an application.

Allowed:
boolean | null

Whether the gift has been deposited.

integer | null

Amount of the gift.

string | null
enum

Sources of gifts a borrower declares on an application.

string | null
enum

Types of additional assets a borrower declares on an application.

integer | null

Value of another asset.

string | null
enum

Applicant types of a borrower on an application.

Allowed:
string | null
enum

Types of additional liabilities a borrower declares on an application.

Allowed:
integer | null

Amount of other liability.

string | null
enum

Applicant types of a borrower on an application.

Allowed:
string | null

Street of mortgage being verified.

string | null

Unit number of mortgage being verified.

string | null

City of mortgage being verified.

enum

U.S. state of mortgage being verified.

State abbreviated code.

string | null

Zip of mortgage being verified.

string | null

Market value of mortgage being verified.

integer | null

Balance of mortgage being verified.

string | null
enum

Types of mortgage properties a borrower declares on an application.

date | null

Date acquired for mortgage being verified.

string | null

Loan amount of mortgage being verified.

integer | null

Payment of mortgage being verified.

string | null
enum

How a borrower uses a mortgage property.

Allowed:
integer | null

Income from property if rented of mortgage being verified.

Headers
string

Specify API version, for example '1.0'. By default, the version configured in the company settings is used.

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?