Skip to main content
POST
Create Loan

Authorizations

Authorization
string
header
required

Consumer JWT minted by the tenant's backend

X-Rollout-Credential-Id
string
header
required

The Rollout Credential ID to use for queries/mutations

Query Parameters

fields
string

Comma-separated top-level fields to return; the parameter can also be repeated, once per field. id is always returned. Omit it, or pass allFields, to get every field, including original. Unknown names return 400.

Body

amount
number
required
type
string
required
term
number
required
loanNumber
string
required
interestRate
number
required
borrowers
object[]
required
statusDate
string<date-time>
applicationDate
string<date-time>
closingDate
string<date-time>
fundingDate
string<date-time>
loanToValue
number
purpose
string
stage
string
status
string
monthlyPayment
number
escrowIncluded
boolean
pmiRequired
boolean
pmiRate
number
participatingUserIds
string[]

Response

The created loan.

The created loan.

id
string
required

Rollout's stable universal id for this loan. Use this to reference the loan in the Rollout API.

loanNumber
string | null

The human-facing loan number assigned by the source system, or null if it doesn't assign one. This is distinct from the source's internal record id (see originalIds) and from any source-specific GUID (available on original). Present unless the request's fields leaves it out.

interestRate
number | null

The note rate in percent (e.g. 6.5), or null if unknown. Present unless the request's fields leaves it out.

amount
number | null

The loan amount, or null if unknown. Present unless the request's fields leaves it out.

term
number | null

Present unless the request's fields leaves it out.

loanToValue
number | null

Present unless the request's fields leaves it out.

type
string

Present unless the request's fields leaves it out.

purpose
string

Present unless the request's fields leaves it out.

status
string

Present unless the request's fields leaves it out.

statusDate
string<date-time> | null

Present unless the request's fields leaves it out.

applicationDate
string<date-time> | null

Present unless the request's fields leaves it out.

closingDate
string<date-time> | null

Present unless the request's fields leaves it out.

fundingDate
string<date-time> | null

Present unless the request's fields leaves it out.

rateAndTerms
object

Present unless the request's fields leaves it out.

originalIds
object

The source system's own identifiers for this loan, keyed by original entity name (e.g. { loan: "17102475" } is the source's internal loan record id). This is NOT the human loan number (see loanNumber). Present unless the request's fields leaves it out.

original
object

Present unless the request's fields leaves it out.

created
string<date-time> | null

Present unless the request's fields leaves it out.

updated
string<date-time> | null

Present unless the request's fields leaves it out.

userParticipantIds
string[]

The universal ids of the loan team's users. Deprecated: use userParticipants, which also gives each user's role. Present unless the request's fields leaves it out.

userParticipants
object[]

The loan team's users and their roles on the loan (e.g. loan_officer, loan_processor). Present unless the request's fields leaves it out.

borrowerParticipantIds
string[]

The universal ids of the loan's borrowers: LOS application records, served on the LOS category. Present unless the request's fields leaves it out.

peopleParticipants
object[]

The people on the loan and their roles (e.g. borrower, coborrower, buyers_agent). A mortgage CRM's borrowers are people, not borrower records. Present unless the request's fields leaves it out.

stage
string

Present unless the request's fields leaves it out.

stageHistory
object[] | null

Present unless the request's fields leaves it out.

loanFolder
string | null

Present unless the request's fields leaves it out.

archived
boolean | null

Present unless the request's fields leaves it out.

mortgageType
string | null

Present unless the request's fields leaves it out.

lienType
string | null

Present unless the request's fields leaves it out.

amortizationType
string | null

Present unless the request's fields leaves it out.

armInitialPeriodMonths
number | null

Present unless the request's fields leaves it out.

armSubsequentPeriodMonths
number | null

Present unless the request's fields leaves it out.

expectedRentalIncome
number | null

Present unless the request's fields leaves it out.

expectedNetRentalIncome
number | null

Present unless the request's fields leaves it out.

communityProperty
boolean | null

Present unless the request's fields leaves it out.

transactionDetail
string | null

Present unless the request's fields leaves it out.

refinanceType
string | null

Present unless the request's fields leaves it out.

refinanceProgram
string | null

Present unless the request's fields leaves it out.

energyImprovement
string | null

Present unless the request's fields leaves it out.

projectType
string | null

Present unless the request's fields leaves it out.

proposedMonthlyPayment
object | null

Present unless the request's fields leaves it out.

loanFeatures
object | null

Present unless the request's fields leaves it out.

qualifyingFunds
object | null

Present unless the request's fields leaves it out.

titleInfo
object | null

Present unless the request's fields leaves it out.

loanOriginator
object | null

Present unless the request's fields leaves it out.

otherNewMortgageLoans
object[] | null

Present unless the request's fields leaves it out.

giftsOrGrants
object[] | null

Present unless the request's fields leaves it out.

program
string

The loan program (e.g. "30-year Fixed"). Present unless the request's fields leaves it out.

lock
object | null

The rate lock, or null if unknown. Present unless the request's fields leaves it out.

debtToIncome
number | null

Debt-to-income ratio, in percent. Present unless the request's fields leaves it out.

combinedLoanToValue
number | null

Combined loan-to-value ratio of every loan on the property, in percent. Present unless the request's fields leaves it out.

firstTimeBuyer
boolean | null

Present unless the request's fields leaves it out.

estimatedClosingDate
string<date-time> | null

Present unless the request's fields leaves it out.

firstPaymentDate
string<date-time> | null

Present unless the request's fields leaves it out.

preApproval
object | null

Present unless the request's fields leaves it out.

denialReason
string

Present unless the request's fields leaves it out.

referralSource
string

Present unless the request's fields leaves it out.

milestoneDates
object | null

Dates of the loan's milestones beyond its own date fields, or null if the source records none. Present unless the request's fields leaves it out.

rolloutUpdated
string<date-time>

Present unless the request's fields leaves it out.