Fellow Finance API

Fellow Finance ​Order API allows investors to integrate with Fellow Finance platform. The API is created for investors ​willing to ​use their own credit scoring criteria. ​Fellow Finance Order API provides direct access to the credit application flow with a possibility to place an instant offer.

Order API will send every new credit application instantly to API investors and will insert ​new investment offers from the investor APIs to the Fellow Finance Marketplace.

The API users and Fellow Finance website users have similar possibilities to invest into new loan applications.

Start investing

Who may use the API?

Fellow finance Order API can be used for:

The functionalities of API can be utilized by creating RESTful services according to Fellow Finance Order API specifications, ​thus solid programming skills and ​ability to utilize credit ​modeling are required to join the order flow with customized software and to execute desired investment strategy efficiently. The API is targeted for institutional investors but can be utilized ​by private lenders with the ​required skillset.

What services are available?

Currently order API ​services for lenders include:

The services are continously developed and API usage is carefully monitored to ensure reliable credit application delivery and investment process.

How to enable order API?

The following two steps are required to enable programming interface:

Please contact customerservice@fellowfinance.fi for further instructions.

Overview of order ​API

In order to work with the API, an investor must ​build a RESTful API ​that can be used over HTTPS protocol. All ​communication between Fellow Finance and ​investor implementation of Order API is based on standard HTTP methods.

All API data ​transferred by and to Fellow Finance is application/json coded​. Example:

curl -X POST "https://​yourdomain.com/api/ExternalApiAccept" -H "Accept: application/json" -H "Content-Type: application/json" -d "{"LenderNumber":"12", "BidAmountWon":12.2, "ExternalReference":"123"}"

Order API description

Fellow Finance order API is ​a RESTful API that uses standard HTTP calls for data transfer. It's designed to be as simple as possible with minimum effort required for application developers.

In order to work with order API, an investor must implement and publish the methods. Fellow Finance will POST data for each investor Order API simultaneously. Currently the wait time for investment order is 5000 milliseconds. Replies containing ​an investment order that are not given inside that time frame are discarded, thus they are not part of the loan allocation process.

API definitions

The following table describes the actions that are performed to RESTful Order API by Fellow Finance:

Purpose HTTP Verb URI Request and response description
New credit application POST https://yourdomain/ffOrder New application request body and response definition
Accepted investment POST https://yourdomain/ffOrderAccept Accept request body and response definition
Declined investment POST https://yourdomain/ffOrderDecline Decline request body and response definition
Cancelled investment POST https://yourdomain/ffOrderCancel Cancel request body and response definition

Order API ​URI ​must be ​specified in Autoinvestor settings. URI for the new credit application is used by as the base URI for the Accept / Decline and Cancel POSTs. The base URI will be ​altered with the terms Accept / Decline and Cancel, respectively.

Example:

Action performed by Fellow Finance URI
POST new credit application https://yourdomain/ffOrder
Base URI set up by investor
POST Accept https://yourdomain/ffOrderAccept
Generated by Fellow Finance from the base URI
POST Decline https://yourdomain/ffOrderDecline
Generated by Fellow Finance from the base URI
POST Cancel https://yourdomain/ffOrderCance
Generated by Fellow Finance from the base URI

New credit application

When an underwritten credit application is inserted to the marketplace, it's instantly POSTed to all API allocators. An investor can reply with an investment offer inside the given time frame.

Example new credit application request:

curl -X POST "https://yourdomain.com/api/ffOrder" -H "Accept: application/json" -H "Content-Type: application/json" -d "{
  "CustomerNumber": "sample string 1",
  "LenderNumber": "sample string 2",
  "ApplicationNumber": "sample string 3",
  "PrivateKey": "sample string 4",
  "Loan_Brand": 0,
  "Loan_Brand_Id": "sample string 5",
  "Loan_Amount": 6.0,
  "Loan_Purpose": 0,
  "Loan_Purpose_Id": "sample string 7",
  "Loan_Purpose_Int": 8,
  "Loan_MonthlyPmt": 9.0,
  "Loan_RiskClass": 10,
  "Loan_Length": 11,
  "Loan_Currency": "sample string 12",
  "IncomeAndExpenses_GrossIncomePerMonth": 13.0,
  "IncomeAndExpenses_CostOfHousingPerMonth": 14.0,
  "IncomeAndExpenses_OtherCostsPerMonth": 15.0,
  "IncomeAndExpenses_IncomeVerificationDatetime": "2016-03-09T19:58:58.6889315+00:00",
  "IncomeAndExpenses_OtherIncomePerMonth": 17.0,
  "IncomeAndExpenses_OtherLoanPaymentsPerMonth": 18.0,
  "IncomeAndExpenses_StatisticalExpensesPerMonth": 19.0,
  "IncomeAndExpenses_LoanPaymentsPerMonths": 20.0,
  "IncomeAndExpenses_CreditLimit_Base": 21.0,
  "LoanHistory_AveragePaymentDelay": 22.0,
  "LoanHistory_MaxPaymentDelayInDays": 23,
  "LoanHistory_PaidInstallmentCount": 24,
  "LoanHistory_CreditBureauReportingTime": "2016-03-09T19:58:58.6889315+00:00",
  "LoanHistory_PaidLoanCount": 26,
  "LoanHistory_PaidLoans": 27.0,
  "Customer_Age": 28,
  "Customer_Language": 0,
  "Customer_Language_Id": "sample string 29",
  "Customer_ResidenceType": 0,
  "Customer_ResidenceType_Id": "sample string 30",
  "Customer_ResidenceOwnership": 0,
  "Customer_ResidenceOwnership_Id": "sample string 31",
  "Customer_Gender": 0,
  "Customer_Gender_Id": "sample string 32",
  "Customer_MaritalStatus": 0,
  "Customer_MaritalStatus_Id": "sample string 33",
  "Customer_BusinessType": 0,
  "Customer_BusinessType_Id": "sample string 34",
  "Customer_EmploymentStatus": 0,
  "Customer_EmploymentStatus_Id": "sample string 35",
  "Cust_City": "sample string 36",
  "Customer_Children": 37,
  "Customer_EducationLevel": 0,
  "Customer_EducationLevel_Id": "sample string 38",
  "Customer_hasCreditCard": true
}"

Example ​response for new credit application from an investor API:

"{ "InvestmentAmount": 499.80, "InvestmentRate": 17, "ExternalReference": "​123445" }"

For the detailed information about the enumerations, please refer to API definitions.

Accepted / Declined / Cancelled

After all investment orders are in place, a credit application is allocated with investment orders. If the API order is accepted among the lowest participating orders, Fellow Finance will POST Accept with the investment amount.

News

      Social media