Skip to main content
POST
/
loans
Create Loan
curl --request POST \
  --url https://los.universal.rollout.com/api/loans \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "type": "<string>",
  "term": 123,
  "loanNumber": "<string>",
  "interestRate": 123,
  "borrowers": [
    {
      "name": "<string>",
      "taxId": "<string>",
      "role": "<string>",
      "emails": [
        {
          "value": "<string>",
          "type": "<string>",
          "status": "<string>",
          "isPrimary": true
        }
      ],
      "phones": [
        {
          "value": "<string>",
          "type": "<string>",
          "status": "<string>",
          "isPrimary": true
        }
      ],
      "addresses": [
        {
          "type": "<string>",
          "street": "<string>",
          "city": "<string>",
          "state": "<string>",
          "code": "<string>",
          "country": "<string>"
        }
      ],
      "bio": {},
      "type": "<string>"
    }
  ],
  "statusDate": "<string>",
  "applicationDate": "<string>",
  "closingDate": "<string>",
  "fundingDate": "<string>",
  "loanToValue": 123,
  "purpose": "<string>",
  "stage": "<string>",
  "status": "<string>",
  "monthlyPayment": 123,
  "escrowIncluded": true,
  "pmiRequired": true,
  "pmiRate": 123,
  "participatingUserIds": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "interestRate": 123,
  "amount": 123,
  "term": 123,
  "loanToValue": 123,
  "type": "<string>",
  "purpose": "<string>",
  "status": "<string>",
  "statusDate": "<string>",
  "applicationDate": "<string>",
  "closingDate": "<string>",
  "fundingDate": "<string>",
  "rateAndTerms": {
    "monthlyPayment": 123,
    "escrowIncluded": true,
    "pmiRequired": true,
    "pmiRate": 123
  },
  "originalIds": {},
  "original": {},
  "created": "<string>",
  "updated": "<string>",
  "userParticipantIds": [
    "<string>"
  ],
  "borrowerParticipantIds": [
    "<string>"
  ],
  "stage": "<string>",
  "stageHistory": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "scheduledStartDate": "2023-11-07T05:31:56Z",
      "actualStartDate": "2023-11-07T05:31:56Z",
      "completedDate": "2023-11-07T05:31:56Z",
      "plannedDurationDays": 123,
      "actualDurationDays": 123,
      "assignee": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "role": "<string>"
      },
      "requiresReview": true,
      "isReviewed": true,
      "order": 123,
      "isRequired": true,
      "notes": "<string>",
      "metadata": null
    }
  ],
  "rolloutUpdated": "<string>"
}

Body

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

Response

Created

id
string
required
interestRate
number
required
amount
number
required
term
number
required
loanToValue
number
required
type
string
required
purpose
string
required
status
string
required
statusDate
string
required
applicationDate
string
required
closingDate
string
required
fundingDate
string
required
rateAndTerms
object
required
originalIds
object
required
original
object
required
created
string
required
updated
string
required
userParticipantIds
string[]
required
borrowerParticipantIds
string[]
required
stage
string
required
stageHistory
object[]
required
rolloutUpdated
string
required