Documentation
Back to Home

Credit Appraisal Documentation

Assess creditworthiness using transaction history, income patterns, and behavioural signals.

Overview

The Credit Appraisal Engine analyses transaction data to assess borrower creditworthiness. It evaluates income patterns, spending behaviour, repayment history, and financial stability to deliver consistent, explainable credit decisions in under 30 seconds.

How It Works

Submit transaction data or financial documents. The engine analyses income patterns, identifies recurring expenses, evaluates cash flow stability, and applies configurable risk scoring rules. Results include a credit score, risk flags, and a detailed explanation of the decision factors.

API Reference

Integrate this endpoint into your applications to seamlessly submit a loan application for comprehensive credit appraisal. The engine evaluates financial data, risk factors, and supporting documents, returning a comprehensive assessment with credit score, risk breakdown, and recommendations.

You can create a developer account to get an api key fromhere.

POST https://server.gimele.com/api/v1/credit-appraisal

Analyse a loan application and generate a credit appraisal report.

Headers

Authorization: Bearer <your-api-key>
Content-Type: multipart/form-data

Form Data Parameters

ParameterTypeRequiredDescription
loan_amountfloatYesRequested loan amount in NGN
tenure_monthsintYesLoan repayment period in months
collateral_descriptionstringYesDescription of collateral offered
business_typestringYesType of business (e.g. sole proprietorship, LLC)
annual_revenuefloatNoAnnual business revenue in NGN
existing_debtfloatNoTotal existing debt in NGN
credit_historystringNoDescription of past credit history
industrystringNoIndustry sector of the business
company_age_yearsintNoAge of the business in years
purpose_of_loanstringNoIntended use of the loan funds
collateral_valuefloatNoEstimated market value of collateral
number_of_employeesintNoNumber of employees
bank_statementsFile[]NoPDF bank statements (up to 6000 chars extracted each)
other_documentsFile[]NoSupporting PDF documents
curl -X POST https://server.gimele.com/api/v1/credit-appraisal \
  -H "Authorization: Bearer $GIMELE_API_KEY" \
  -F "loan_amount=5000000" \
  -F "tenure_months=12" \
  -F "business_type=sole_proprietorship" \
  -F "collateral_description=Land deed in Lagos" \
  -F "annual_revenue=15000000" \
  -F "industry=retail" \
  -F "company_age_years=5" \
  -F "bank_statements=@./statements.pdf"

Success Response (200 OK)

{
"credit_score": 72,
"risk_assessment": {
"sectoral": { "score": 7, "description": "Moderate sector risk" },
"technological": { "score": 8, "description": "Good tech adoption" },
"economic": { "score": 6, "description": "Stable economic outlook" },
"legal": { "score": 9, "description": "Strong legal compliance" },
"social": { "score": 7, "description": "Positive social impact" },
"political": { "score": 6, "description": "Moderate political risk" },
"environmental": { "score": 8, "description": "Low env impact" }
},
"financial_ratios": {
"profitability": { "score": 7, "description": "Healthy margins" },
"efficiency": { "score": 6, "description": "Average asset turnover" },
"liquidity": { "score": 5, "description": "Adequate liquidity" },
"capital_structure": { "score": 7, "description": "Moderate leverage" },
"coverage": { "score": 6, "description": "Adequate debt coverage" }
},
"recommendations": [
"Approve loan with 22% interest rate",
"Require quarterly financial reviews"
],
"summary": "Borrower has strong revenue and collateral, recommend approval."
}

Error Responses

502 Bad Gateway — LLM Service Error
{
"detail": "LLM service error: [upstream error]"
}
→ Fix: Retry the request; if persistent, contact support as the upstream AI service may be degraded
500 Internal Server Error — Parse Failure
{
"detail": "Failed to parse LLM response: [error details]"
}
→ Fix: Submit well-structured documents with clear financial data and retry; the AI model may have returned an incomplete response
500 Internal Server Error — Processing Failure
{
"detail": "[error details]"
}
→ Fix: Verify all required fields (loan_amount, tenure_months, business_type, collateral_description) are provided with valid values