https://{your-domain}.fincode.software/api/v1/services/user/loan-application-details/{loan-application-id}
{
"status": "<string>",
"data": {
"loanDetails": {
"id": "<string>",
"dateOfRequest": "<string>",
"loanRequestUserId": "<string>",
"loanProduct": "<string>",
"organisation": "<string>",
"loanApplicationStatusEnum": "<string>",
"requestedLoanAmount": 123,
"loanDuration": 123,
"loanRepaymentMethodEnum": "<string>",
"customerCreditAccountId": "<string>",
"employmentStatus": "<string>",
"monthlyIncome": 123,
"currencyCode": "<string>",
"durationCounter": "<string>",
"customerName": "<string>",
"email": "<string>",
"loanApplicationId": "<string>",
"phoneNumber": "<string>",
"dateOfBirth": "<string>"
},
"loanProductName": "<string>"
}
}API Endpoints
Loan Application Details
Retrieves comprehensive details of a loan application including full application information and loan product name.
GET
/
api
/
v1
/
services
/
user
/
loan-application-details
/
{loan-application-id}
https://{your-domain}.fincode.software/api/v1/services/user/loan-application-details/{loan-application-id}
{
"status": "<string>",
"data": {
"loanDetails": {
"id": "<string>",
"dateOfRequest": "<string>",
"loanRequestUserId": "<string>",
"loanProduct": "<string>",
"organisation": "<string>",
"loanApplicationStatusEnum": "<string>",
"requestedLoanAmount": 123,
"loanDuration": 123,
"loanRepaymentMethodEnum": "<string>",
"customerCreditAccountId": "<string>",
"employmentStatus": "<string>",
"monthlyIncome": 123,
"currencyCode": "<string>",
"durationCounter": "<string>",
"customerName": "<string>",
"email": "<string>",
"loanApplicationId": "<string>",
"phoneNumber": "<string>",
"dateOfBirth": "<string>"
},
"loanProductName": "<string>"
}
}Fetches detailed information about a loan application including all application fields, customer information, loan terms, and the associated loan product name.
https://{your-domain}.fincode.software/api/v1/services/user/loan-application-details/{loan-application-id}
Request Headers
string
required
The JWT Access Token obtained from the
/login or /refresh-token endpoint.string
required
Unique idempotency key for the request to prevent duplicate processing.
string
required
The date and time at which the request was initiated (ISO 8601 format).
string
required
The IP address of the customer making the request.
string
required
Unique identifier for the interaction/session.
Path Parameters
string
required
The unique identifier (UUID) of the loan application to retrieve.
Response
Returns comprehensive loan application details including full application information and loan product name.string
default:"SUCCESS"
Overall status of the API request.
object
Response object containing loan details and product name.
Show data object
Show data object
object
Complete loan application details.
Show loanDetails object
Show loanDetails object
string
Unique identifier of the loan application.
string
Date when the loan application was created.
string
Unique identifier of the user who requested the loan.
string
Unique identifier of the loan product.
string
Unique identifier of the organisation.
string
Current status of the loan application (e.g.,
REQUESTED, APPROVED, OFFER_SENT, ACCEPTED, DISBURSED).number
The loan amount requested by the customer.
number
Loan duration.
string
Repayment method (e.g.,
External Bank Transfer, Internal Bank Transfer).string
Unique identifier of the customer’s credit account.
string
Customer’s employment status.
number
Customer’s monthly income.
string
Currency code with symbol (e.g.,
NGN (₦)).string
Duration counter unit (e.g.,
MONTH, WEEK, DAY).string
Customer’s name.
string
Customer’s email address.
string
Loan application identifier.
string
Customer’s phone number.
string
Customer’s date of birth.
string
Name of the loan product associated with this application.
Code Examples
curl --location 'https://{your-domain}.fincode.software/api/v1/services/user/loan-application-details/123e4567-e89b-12d3-a456-426614174000' \
--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'
const axios = require('axios');
const BASE_URL = 'https://{your-domain}.fincode.software/api/v1/services/user';
async function getLoanApplicationDetails(accessToken, loanApplicationId) {
try {
const response = await axios.get(
`${BASE_URL}/loan-application-details/${loanApplicationId}`,
{
headers: {
'X-Auth-Token': accessToken,
'x-idempotency-key': `key-${Date.now()}`,
'x-fapi-auth-date': new Date().toISOString(),
'x-fapi-customer-ip-address': '192.168.1.1',
'x-fapi-interaction-id': `interaction-${Date.now()}`,
},
}
);
const { loanDetails, loanProductName } = response.data.data;
console.log('Loan Product:', loanProductName);
console.log('Application Status:', loanDetails.loanApplicationStatusEnum);
console.log('Requested Amount:', loanDetails.requestedLoanAmount);
console.log('Customer:', loanDetails.customerName);
return response.data.data;
} catch (error) {
console.error(
'Failed to fetch loan application details:',
error.response?.data || error.message
);
throw error;
}
}
// Usage Example
const accessToken = 'YOUR_JWT_ACCESS_TOKEN';
const loanApplicationId = '123e4567-e89b-12d3-a456-426614174000';
getLoanApplicationDetails(accessToken, loanApplicationId);