Skip to main content
POST
/
user
/
request-loan
Request Loan
curl --request POST \
  --url https://{tenant}.fincode.software/api/v6/services/user/request-loan \
  --header 'Content-Type: application/json' \
  --data '
{
  "currencyCode": "<string>",
  "dateOfBirth": "<string>",
  "durationCounter": 123,
  "loanApplicationStatusEnum": "REQUESTED",
  "employmentStatus": "<string>",
  "loanAmount": 123,
  "bvn": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "accountNumber": "<string>",
  "bankCode": "<string>",
  "phoneNumber": "<string>",
  "loanDuration": 123,
  "loanProductId": "<string>",
  "loanRepaymentMethodEnum": "<string>",
  "monthlyIncome": 123,
  "eligibilityAnswers": [
    {
      "questionId": "<string>",
      "answer": "<string>"
    }
  ]
}
'
Creates a new loan application request. Customers or agents can use this endpoint to submit loan applications with required details including loan amount, product selection, and eligibility information.

Request Headers

X-Auth-Token
string
required
The JWT Access Token obtained from the /login or /refresh-token endpoint.
x-idempotency-key
string
required
Unique idempotency key for the request to prevent duplicate processing.
x-fapi-auth-date
string
required
The date and time at which the request was initiated (ISO 8601 format).
x-fapi-customer-ip-address
string
required
The IP address of the customer making the request.
x-fapi-interaction-id
string
required
Unique identifier for the interaction/session.
Content-Type
string
default:"application/json"
required
Must be application/json.

Request Body

currencyCode
string
required
The currency code for the loan (e.g., “NGN”).
dateOfBirth
string
required
Customer’s date of birth (YYYY-MM-DD).
durationCounter
number
required
The numeric value of the duration (e.g., 12).
loanApplicationStatusEnum
string
default:"REQUESTED"
required
Initial status of the application. Must be “REQUESTED”.
employmentStatus
string
required
Customer’s employment status (e.g., “EMPLOYED”, “SELF_EMPLOYED”).
loanAmount
number
required
The requested loan amount.
bvn
string
required
Bank Verification Number of the customer.
firstName
string
required
Customer’s first name.
lastName
string
required
Customer’s last name.
accountNumber
string
required
Bank account number for disbursement/repayment.
bankCode
string
required
Code of the bank associated with the account number.
phoneNumber
string
required
Customer’s phone number.
loanDuration
number
required
Duration of the loan.
loanProductId
string
required
The unique identifier of the loan product.
loanRepaymentMethodEnum
string
required
Method of repayment (e.g., “DIRECT_DEBIT”).
monthlyIncome
number
required
Customer’s monthly income.
eligibilityAnswers
array
Array of answers to eligibility questions.

Code Examples

curl --location --request POST 'https://finlend.fincode.software/api/v6/services/user/request-loan' \
--header 'X-Auth-Token: YOUR_JWT_ACCESS_TOKEN' \
--header 'x-idempotency-key: unique-key-12345' \
--header 'x-fapi-auth-date: 2024-01-15T10:30:00Z' \
--header 'x-fapi-customer-ip-address: 192.168.1.1' \
--header 'x-fapi-interaction-id: interaction-12345' \
--header 'Content-Type: application/json' \
--data '{
    "currencyCode": "NGN",
    "dateOfBirth": "1990-01-01",
    "durationCounter": 12,
    "loanApplicationStatusEnum": "REQUESTED",
    "employmentStatus": "EMPLOYED",
    "loanAmount": 50000.00,
    "bvn": "12345678901",
    "firstName": "John",
    "lastName": "Doe",
    "accountNumber": "0123456789",
    "bankCode": "044",
    "phoneNumber": "08012345678",
    "loanDuration": 12,
    "loanProductId": "product-123",
    "loanRepaymentMethodEnum": "DIRECT_DEBIT",
    "monthlyIncome": 150000.00,
    "eligibilityAnswers": [
        {
            "questionId": "q1",
            "answer": "Yes"
        }
    ]
}'

Body

application/json
currencyCode
string
dateOfBirth
string
durationCounter
number
loanApplicationStatusEnum
string
default:REQUESTED
employmentStatus
string
loanAmount
number
bvn
string
firstName
string
lastName
string
accountNumber
string
bankCode
string
phoneNumber
string
loanDuration
number
loanProductId
string
loanRepaymentMethodEnum
string
monthlyIncome
number
eligibilityAnswers
object[]

Response

200

Loan application created successfully