Sign in

v1

latestOpenAPI 3.0.02026-07-2459256884.4 KB
User Management

Update a Home Loan

This API updates user records with accurate home loan account numbers.

patch/v1/users/{userId}/homeLoans/{homeLoanId}

Path parameters

userIdstring required

Spinwheel userId to identify a user (one of userId or extUserId is required).

homeLoanIdstring required

Spinwheel home loan ID associated with the user.

Request body

Example request

{
  "liabilityProfile": {
    "accountNumber": "0045678901234"
  }
}

Response

Success

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": {
    "homeLoanId": "7025c075-e92d-46fa-85e5-ac31ca667079",
    "logoUrl": "https://spinwheel.io/logos/1226cd1b-51dd-4bd1-8dc8-098deb9e0c7b.png",
    "displayName": "TD Bank",
    "updatedOn": 1597753517524,
    "createdOn": 1597753517524,
    "userId": "3fef7131-71ae-4204-a8bd-3fc3ad6b4b82",
    "liabilityProfile": {
      "accountOriginationDate": "2023-01-15",
      "interestRateDerived": 3.5,
      "loanOriginationAmount": 5000,
      "highCreditAmount": 5000,
      "accountRating": "1",
      "liabilitySubtype": "ConventionalRealEstateMortgage",
      "pendingLoanTermInMonthsDerived": 83,
      "loanTermInMonths": 93,
      "closedDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "reviewedInMonths": 6,
      "reportedDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "chargeOffAmount": 5000,
      "chargeOffDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "firstDelinquencyDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "lastActivityDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "accountTypeCode": "O",
      "highestAdverseRatingDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "mostRecentAdverseRatingDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "secondMostRecentAdverseRatingDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "adverseRatingCount": 2,
      "liabilityTransfers": {
        "transferredFrom": {
          "creditorName": "MASTERCARD"
        },
        "transferredTo": {
          "creditorName": "MASTERCARD"
        }
      },
      "narratives": [
        {
          "code": "EP",
          "description": "Fixed rate"
        }
      ],
      "accountNumberLastFour": "1234",
      "accountNumber": "0045678901234",
      "paymentHistory": {
        "lastAssessedStatementDate": "2020-01-01",
        "details": [
          {
            "date": "2020-01-01",
            "description": "The account is current",
            "code": "1"
          }
        ]
      }
    },
    "balanceDetails": {
      "outstandingBalance": 2500,
      "updatedOn": 1597753517524
    },
    "statementSummary": {
      "statementDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "statementBalance": 7469,
      "principalBalance": 2535,
      "minimumPaymentAmount": 100,
      "lastPaymentDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "dueDate": "2023-04-10",
      "amountPastDue": 100,
      "updatedOn": 1597753517524
    },
    "creditor": {
      "industryType": "SalesFinancing",
      "industryCode": "FF",
      "phoneNumber": "8663968254",
      "originalName": "TD BANK",
      "bureauSubscriberCode": "401BB00573",
      "billingAddresses": [
        {
          "addressLine1": "123 Main Street",
          "addressLine2": "Unit 208",
          "city": "San Francisco",
          "state": "CA",
          "zip": "90211",
          "zipExtension": "1234",
          "reportedDate": "2023-09-20T00:00:00.000Z",
          "reportedDateWithFormat": {
            "value": "2020-01-01",
            "format": "YYYY-MM-DD"
          },
          "addressType": "CURRENT"
        }
      ],
      "address": {
        "addressLine1": "123 Main Street",
        "addressLine2": "Unit 208",
        "city": "San Francisco",
        "state": "CA",
        "zip": "90211",
        "zipExtension": "1234"
      },
      "billingAddress": {
        "addressLine1": "123 Main Street",
        "addressLine2": "Unit 208",
        "city": "San Francisco",
        "state": "CA",
        "zip": "90211",
        "zipExtension": "1234"
      }
    }
  }
}