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.

ℹ️
When passing the full 9-digit SSN value, be sure to use the secure endpoint https://secure-api.spinwheel.io/v1/financings

Personal loan refinancing application example - minimum request

{
    "financingDetails": {
        "type": "ORIGINATION",
        "to": {
            "liabilityType": "PERSONAL_LOAN"
        },
        "loanPurpose": "LP1001",
        "loanAmount": 10000
    },
    "userProfile": {
        "personalInformation": {
            "firstName": "NANCY",
            "lastName": "BIRKHEAD",
            "dateOfBirth": "1938-10-14",
      "ssn": "123456789",//do not pass the ssn key or value if you have connected this user via one of the Spinwheel Embedded Debt Connect modules
            "email": "{{userEmail}}",
            "phones": [
                {
                    "type": "HOME",
                    "phoneNumber": "5704414264"
                }
            ],
            "addresses": [
                {
                    "addressLine1": "378 EAST ST",
                    "city": "BLOOMSBURG",
                    "state": "PA",
                    "zip": "17815",
                    "currentAddress": true,
                    "startDate": "2022-07-23"
                }
            ]
        },
        "employment": {
            "employmentHistory": [
                {
                    "annualIncome": 140000,
                    "type": "ET1003",
                    "isCurrent": true
                }
            ]
        },
        "financials": {
            "creditScore": 750,
            "expenses": {
                "list": [
                    {
                        "type": "RENT"
                    }
                ]
            }
        }
    },
    "extUserId": "{{$yourExternalUserId}}"
}

Auto loan refinancing application example

{
  "financingDetails": {
    "loanAmount": 10000,
    "type": "REFINANCE",
    "from": {
      "liabilities": [
        {
          "liabilityType": "AUTO_LOAN",
          "liabilityAccounts": [
            {
              "id": "c9186d99-b5c4-4356-8c5a-3c6b50b5b8e2",
              "amount": 10000,
              "monthlyPayment": 371.04
            }
          ],
          "collateral": {
            "vehicle": {
              "licensePlate": "6TRJ244",
              "licensePlateState": "CA",
              "vin": "1FBSS3BL1CDA96461",//requires VIN -OR- License plate number and state
              "estimatedMileage": 62394,
              "isNewVehicle": false,
              "monthlyPayment": 456
            }
          }
        }
      ]
    },
    "to": {
      "liabilityType": "AUTO_LOAN"
    },
  },
  "userProfile": {
    "personalInformation": {
      "ssn": "123456789",
      "citizenshipStatus": "CS1001",
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "1988-07-23T00:00:00.000Z",
      "email": "user@example.com",
      "phones": [
        {
          "type": "HOME",
          "phoneNumber": "2345678901"
        }
      ],
      "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"
        }
      ]
    },
    "employment": {
      "employmentHistory": [
        {
          "annualIncome": 100000,
          "isCurrent": true,
        }
      ]
    },
    "financials": {
      "totalAssetsValue": 1000,
      "assets": {
        "list": [
          {
            "type": "PROPERTY",
            "value": 1000
          }
        ]
      },
      "expenses": {
        "list": [
          {
            "type": "RENT",
            "monthlyExpense": 1000
          }
        ]
      }
    }
  },
  "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": "user@example.com",
      "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"
}

200Successful response

400Bad request response

401Unauthorized response

404Not found response

500Internal server error response