Create a Refinancing Application

To get the refinancing process started, create an application by sending a POST request to the endpoint. Since applications are associated with a user and designed to be modified before they are submitted, the only required field is a userId.

Request Examples

To simplify your implementation we've put together an example for each liability type. Make sure to plug in your own values but these should get you started.

Personal loan refinancing application example
{
  "financingDetails": {
    "loanAmount": 10000,
    "from": {
      "liabilities": [
        {
          "liabilityType": "CREDIT_CARD",
          "liabilityAccounts": [
            {
              "id": "c9186d99-b5c4-4356-8c5a-3c6b50b5b8e2",
              "amount": 10000,
              "monthlyPayment": 371.04
            }
          ]
        }
      ]
    },
    "to": {
      "liabilityType": "PERSONAL_LOAN"
    },
    "type": "REFINANCE",
    "loanPurpose": "LP1001"
  },
  "userProfile": {
    "personalInformation": {
      "ssn": "123456789",
      "ssnLastFourDigits": "6789",
      "citizenshipStatus": "CS1001",
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "1988-07-23T00:00:00.000Z",
      "email": "[email protected]",
      "phones": [
        {
          "type": "HOME",
          "phoneNumber": "+12345678901234"
        }
      ],
      "addresses": [
        {
          "addressLine1": "123 Main St",
          "addressLine2": "Unit: 234",
          "city": "Austin",
          "state": "TX",
          "zip": "78732",
          "currentAddress": true,
          "startDate": "2021-07-23T00:00:00.000Z",
          "endDate": "2021-07-23T00:00:00.000Z"
        }
      ]
    },
    "education": {
      "highestDegree": "ED1002",
      "educationHistory": [
        {
          "startDate": "2021-07-23T00:00:00.000Z",
          "endDate": "2021-07-23T00:00:00.000Z",
          "degree": "ED1002",
          "major": "EM1010",
          "schoolId": "10145900"
        }
      ]
    },
    "employment": {
      "employmentHistory": [
        {
          "employerName": "string",
          "position": "EP1001",
          "startDate": "2021-07-23T00:00:00.000Z",
          "endDate": "2021-07-23T00:00:00.000Z",
          "annualIncome": 10,
          "type": "ET1002",
          "isCurrent": true,
          "industry": "ID1010"
        }
      ]
    },
    "financials": {
      "creditScore": 450,
      "totalAssetsValue": 1000,
      "assets": {
        "list": [
          {
            "type": "PROPERTY",
            "value": 1000
          }
        ]
      },
      "expenses": {
        "list": [
          {
            "type": "STUDENT_LOAN",
            "monthlyExpense": 100
          }
        ]
      }
    }
  },
  "userId": "8933b8ab-9893-4b85-83e3-69417a91e8c1"
}
Auto loan refinancing application example
{
  "financingDetails": {
    "loanAmount": 10000,
    "from": {
      "liabilities": [
        {
          "liabilityType": "AUTO_LOAN",
          "liabilityAccounts": [
            {
              "id": "c9186d99-b5c4-4356-8c5a-3c6b50b5b8e2",
              "amount": 10000,
              "monthlyPayment": 371.04
            }
          ],
          "collateral": {
            "vehicle": {
              "year": 2018,
              "make": "Honda",
              "model": "Odyssey",
              "trim": "LX",
              "licensePlate": "6TRJ244",
              "licensePlateState": "CA",
              "vin": "1FBSS3BL1CDA96461",
              "estimatedMileage": 62394,
              "isNewVehicle": false,
              "monthlyPayment": 456
            }
          }
        }
      ]
    },
    "to": {
      "liabilityType": "AUTO_LOAN"
    },
    "type": "REFINANCE",
    "goal": "MAXIMIZE_SAVINGS"
  },
  "userProfile": {
    "personalInformation": {
      "ssn": "123456789",
      "ssnLastFourDigits": "6789",
      "citizenshipStatus": "CS1001",
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "1988-07-23T00:00:00.000Z",
      "email": "[email protected]",
      "phones": [
        {
          "type": "HOME",
          "phoneNumber": "+12345678901234"
        }
      ],
      "addresses": [
        {
          "addressLine1": "123 Main St",
          "addressLine2": "Unit: 234",
          "city": "Austin",
          "state": "TX",
          "zip": "78732",
          "currentAddress": true,
          "startDate": "2021-07-23T00:00:00.000Z",
          "endDate": "2021-07-23T00:00:00.000Z"
        }
      ]
    },
    "education": {
      "highestDegree": "ED1002",
      "educationHistory": [
        {
          "startDate": "2021-07-23T00:00:00.000Z",
          "endDate": "2021-07-23T00:00:00.000Z",
          "degree": "ED1002",
          "major": "EM1010",
          "schoolId": "10145900"
        }
      ]
    },
    "employment": {
      "employmentHistory": [
        {
          "employerName": "string",
          "position": "EP1001",
          "startDate": "2021-07-23T00:00:00.000Z",
          "endDate": "2021-07-23T00:00:00.000Z",
          "annualIncome": 10,
          "type": "ET1002",
          "isCurrent": true,
          "industry": "ID1010"
        }
      ]
    },
    "financials": {
      "creditScore": 450,
      "totalAssetsValue": 1000,
      "assets": {
        "list": [
          {
            "type": "PROPERTY",
            "value": 1000
          }
        ]
      },
      "expenses": {
        "list": [
          {
            "type": "STUDENT_LOAN",
            "monthlyExpense": 100
          }
        ]
      }
    }
  },
  "userId": "8933b8ab-9893-4b85-83e3-69417a91e8c1"
}
Student loan refinancing application example
{
  "financingDetails": {
    "loanAmount": 13000,
    "type": "REFINANCE",
    "from": {
      "liabilities": [
        {
          "liabilityType": "STUDENT_LOAN",
          "liabilityAccounts": [
            {
              "liabilityId": "c9186d99-b5c4-4356-8c5a-3c6b50b5b8e2",
              "amount": 13000,
              "monthlyPayment": 278.66
            }
          ]
        }
      ]
    },
    "to": {
      "liabilityType": "STUDENT_LOAN"
    },
    "goal": "MAXIMIZE_SAVINGS"
  },
  "userProfile": {
    "personalInformation": {
      "ssn": "123456789",
      "ssnLastFourDigits": "6789",
      "citizenshipStatus": "CS1001",
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "1988-07-23T00:00:00.000Z",
      "email": "[email protected]",
      "phones": [
        {
          "type": "HOME",
          "phoneNumber": "+12345678901234"
        }
      ],
      "addresses": [
        {
          "addressLine1": "123 Main St",
          "addressLine2": "Unit: 234",
          "city": "Austin",
          "state": "TX",
          "zip": "78732",
          "currentAddress": true,
          "startDate": "2021-07-23T00:00:00.000Z",
          "endDate": "2021-07-23T00:00:00.000Z"
        }
      ]
    },
    "education": {
      "highestDegree": "ED1002",
      "educationHistory": [
        {
          "startDate": "2021-07-23T00:00:00.000Z",
          "endDate": "2021-07-23T00:00:00.000Z",
          "degree": "ED1002",
          "major": "EM1010",
          "schoolId": "10145900"
        }
      ]
    },
    "employment": {
      "employmentHistory": [
        {
          "employerName": "string",
          "position": "EP1001",
          "startDate": "2021-07-23T00:00:00.000Z",
          "endDate": "2021-07-23T00:00:00.000Z",
          "annualIncome": 10,
          "type": "ET1002",
          "isCurrent": true,
          "industry": "ID1010"
        }
      ]
    },
    "financials": {
      "creditScore": 450,
      "totalAssetsValue": 1000,
      "assets": {
        "list": [
          {
            "type": "PROPERTY",
            "value": 1000
          }
        ]
      },
      "expenses": {
        "list": [
          {
            "type": "STUDENT_LOAN",
            "monthlyExpense": 100
          }
        ]
      }
    }
  },
  "userId": "8933b8ab-9893-4b85-83e3-69417a91e8c1"
}
Language
Authentication
Header
URL
Click Try It! to start a request and see the response here!