GET /creditregistry/api/v1/catalog
Returns data.fields[]: groups such as accountType, businessType, gender, repaymentFrequency, interestType, currency, and a reference for how daysInArrears maps to delinquency bands.
Each value includes:
| Property | Meaning |
|---|---|
apiValue | Send this in your JSON (friendly alias or canonical code). |
mappedValue | Value Dikript uses after alias resolution. |
label | Short title. |
description | Plain-language explanation. |
isAlias | true if apiValue is a friendly alias (e.g. PersonalLoan). |
Examples
- Individual loan product:
"accountType": "PersonalLoan"or"PL31_PersonalTermLoan". - Business loan product:
"accountType": "BusinessLoan"or"ML02_SMELoan". - Business entity type:
"businessType": "LimitedLiability"or a sector code from the catalog.
Call the catalog when building UI dropdowns or server-side validation.
{
"status": true,
"message": "Successful",
"code": "200",
"apiVersion": "v1",
"transactionRef": "N202609181143212967",
"data": {
"fields": [
{
"field": "accountType",
"summary": "Type of loan or credit facility being reported. Required on individual and business defaulter requests.",
"usedOn": "Both",
"values": [
{
"apiValue": "PersonalLoan",
"mappedValue": "PL31_PersonalTermLoan",
"label": "Personal term loan",
"description": "Fixed-term personal loan (salary or consumer). Default mapping for generic personal lending.",
"isAlias": true
},
{
"apiValue": "PersonalTermLoan",
"mappedValue": "PL31_PersonalTermLoan",
"label": "Personal term loan",
"description": "Same as PersonalLoan.",
"isAlias": true
},
{
"apiValue": "SalaryAdvance",
"mappedValue": "PL32_PersonalSalaryAdvance",
"label": "Salary advance",
"description": "Short-term salary-backed advance or payday-style product.",
"isAlias": true
},
{
"apiValue": "PersonalSalaryAdvance",
"mappedValue": "PL32_PersonalSalaryAdvance",
"label": "Salary advance",
"description": "Same as SalaryAdvance.",
"isAlias": true
},
{
"apiValue": "Overdraft",
"mappedValue": "PL00_PersonalOverdraft",
"label": "Personal overdraft",
"description": "Personal overdraft or running account facility.",
"isAlias": true
},
{
"apiValue": "Mortgage",
"mappedValue": "PL10_PersonalMortgage",
"label": "Personal mortgage",
"description": "Residential mortgage or home loan to an individual.",
"isAlias": true
},
{
"apiValue": "BusinessLoan",
"mappedValue": "ML02_SMELoan",
"label": "SME loan",
"description": "Small and medium enterprise loan (default for generic business lending on Dikript).",
"isAlias": true
},
{
"apiValue": "SMELoan",
"mappedValue": "ML02_SMELoan",
"label": "SME loan",
"description": "Same as BusinessLoan.",
"isAlias": true
},
{
"apiValue": "MicroLoan",
"mappedValue": "ML01_MicroLoan",
"label": "Micro loan",
"description": "Microfinance loan to individuals or very small businesses.",
"isAlias": true
},
{
"apiValue": "CommercialLoan",
"mappedValue": "CL32_CommercialLoan",
"label": "Commercial loan",
"description": "General commercial loan to a corporate or business borrower.",
"isAlias": true
},
{
"apiValue": "PL20_PersonalAutoLoan",
"mappedValue": "PL20_PersonalAutoLoan",
"label": "Personal auto loan",
"description": "Vehicle purchase finance for individuals.",
"isAlias": false
},
{
"apiValue": "PL40_PersonalEducationLoan",
"mappedValue": "PL40_PersonalEducationLoan",
"label": "Education loan",
"description": "Tuition or education-related personal loan.",
"isAlias": false
},
{
"apiValue": "PL90_PersonalAgricLoan",
"mappedValue": "PL90_PersonalAgricLoan",
"label": "Personal agricultural loan",
"description": "Agricultural lending to individual farmers.",
"isAlias": false
},
{
"apiValue": "ML03_NanoLoan",
"mappedValue": "ML03_NanoLoan",
"label": "Nano loan",
"description": "Very small ticket micro/nano lending.",
"isAlias": false
},
{
"apiValue": "CL31_CommercialTermLoan",
"mappedValue": "CL31_CommercialTermLoan",
"label": "Commercial term loan",
"description": "Fixed-term loan to a commercial entity.",
"isAlias": false
},
{
"apiValue": "CL03_CommercialSecuredLoan",
"mappedValue": "CL03_CommercialSecuredLoan",
"label": "Commercial secured loan",
"description": "Secured commercial lending.",
"isAlias": false
},
{
"apiValue": "CL10_CommercialMortgage",
"mappedValue": "CL10_CommercialMortgage",
"label": "Commercial mortgage",
"description": "Commercial property mortgage.",
"isAlias": false
}
]
},
{
"field": "businessType",
"summary": "Industry or legal classification of the business borrower. Required only on report/business.",
"usedOn": "Business",
"values": [
{
"apiValue": "LimitedLiability",
"mappedValue": "ISIC_46_Wholesale_trade",
"label": "Limited liability company (generic)",
"description": "Default mapping for a generic limited company; use a sector-specific code when you know the business industry.",
"isAlias": true
},
{
"apiValue": "LimitedLiabilityCompany",
"mappedValue": "ISIC_46_Wholesale_trade",
"label": "Limited liability company (generic)",
"description": "Same as LimitedLiability.",
"isAlias": true
},
{
"apiValue": "LLC",
"mappedValue": "ISIC_46_Wholesale_trade",
"label": "LLC (generic)",
"description": "Same as LimitedLiability.",
"isAlias": true
},
{
"apiValue": "SoleProprietorship",
"mappedValue": "RetailShopPharmacyDepartmentStore",
"label": "Sole proprietorship / retail",
"description": "Small retail or sole trader; map to a more specific ISIC code when known.",
"isAlias": true
},
{
"apiValue": "MicrofinanceBank",
"mappedValue": "MicrofinanceBank",
"label": "Microfinance bank",
"description": "Licensed microfinance bank.",
"isAlias": true
},
{
"apiValue": "CommercialBank",
"mappedValue": "CommercialBank",
"label": "Commercial bank",
"description": "Licensed commercial bank.",
"isAlias": true
},
{
"apiValue": "ISIC_10_Manufacture_of_food_products",
"mappedValue": "ISIC_10_Manufacture_of_food_products",
"label": "Food manufacturing",
"description": "Manufacturing of food products.",
"isAlias": false
},
{
"apiValue": "ISIC_46_Wholesale_trade",
"mappedValue": "ISIC_46_Wholesale_trade",
"label": "Wholesale trade",
"description": "Wholesale trade (non-specialized).",
"isAlias": false
},
{
"apiValue": "ISIC_47_Retail_trade",
"mappedValue": "ISIC_47_Retail_trade",
"label": "Retail trade",
"description": "Retail trade.",
"isAlias": false
},
{
"apiValue": "ISIC_26_Manufacture_of_computer_electronic_and_optical_products",
"mappedValue": "ISIC_26_Manufacture_of_computer_electronic_and_optical_products",
"label": "Technology manufacturing",
"description": "Electronics, computers and optical products manufacturing.",
"isAlias": false
},
{
"apiValue": "ISIC_41_Construction_of_buildings",
"mappedValue": "ISIC_41_Construction_of_buildings",
"label": "Construction",
"description": "Construction of buildings.",
"isAlias": false
},
{
"apiValue": "ISIC_472_Retail_sale_of_food_beverages_and_tobacco",
"mappedValue": "ISIC_472_Retail_sale_of_food_beverages_and_tobacco",
"label": "Food retail",
"description": "Retail sale of food and beverages.",
"isAlias": false
},
{
"apiValue": "CourierCompany",
"mappedValue": "CourierCompany",
"label": "Courier / logistics company",
"description": "Courier or logistics operator.",
"isAlias": false
}
]
},
{
"field": "gender",
"summary": "Borrower or guarantor gender. Use one of the values below.",
"usedOn": "Individual",
"values": [
{
"apiValue": "Male",
"mappedValue": "Male",
"label": "Male",
"description": "Male",
"isAlias": false
},
{
"apiValue": "Female",
"mappedValue": "Female",
"label": "Female",
"description": "Female",
"isAlias": false
},
{
"apiValue": "Unknown",
"mappedValue": "Unknown",
"label": "Unknown",
"description": "Unknown or not specified",
"isAlias": false
}
]
},
{
"field": "repaymentFrequency",
"summary": "How often the borrower repays. Use one of the exact strings below.",
"usedOn": "Both",
"values": [
{
"apiValue": "Daily",
"mappedValue": "Daily",
"label": "Daily",
"description": "Daily repayments",
"isAlias": false
},
{
"apiValue": "Weekly",
"mappedValue": "Weekly",
"label": "Weekly",
"description": "Weekly repayments",
"isAlias": false
},
{
"apiValue": "SemiMonthly",
"mappedValue": "SemiMonthly",
"label": "Semi-monthly",
"description": "Twice per month",
"isAlias": false
},
{
"apiValue": "Monthly",
"mappedValue": "Monthly",
"label": "Monthly",
"description": "Monthly instalments (most common)",
"isAlias": false
},
{
"apiValue": "Quarterly",
"mappedValue": "Quarterly",
"label": "Quarterly",
"description": "Quarterly repayments",
"isAlias": false
},
{
"apiValue": "SemiAnnually",
"mappedValue": "SemiAnnually",
"label": "Semi-annually",
"description": "Twice per year",
"isAlias": false
},
{
"apiValue": "Annually",
"mappedValue": "Annually",
"label": "Annually",
"description": "Once per year",
"isAlias": false
},
{
"apiValue": "BulletOneTime",
"mappedValue": "BulletOneTime",
"label": "Bullet (one time)",
"description": "Single bullet repayment at maturity",
"isAlias": false
},
{
"apiValue": "Variable",
"mappedValue": "Variable",
"label": "Variable",
"description": "Variable schedule",
"isAlias": false
}
]
},
{
"field": "interestType",
"summary": "Fixed or variable interest rate.",
"usedOn": "Both",
"values": [
{
"apiValue": "Fixed",
"mappedValue": "Fixed",
"label": "Fixed rate",
"description": "Interest rate is fixed for the facility.",
"isAlias": false
},
{
"apiValue": "Variable",
"mappedValue": "Variable",
"label": "Variable rate",
"description": "Interest rate can change over the life of the loan.",
"isAlias": false
},
{
"apiValue": "Unknown",
"mappedValue": "Unknown",
"label": "Unknown",
"description": "Not specified",
"isAlias": false
}
]
},
{
"field": "currency",
"summary": "Currency code for the facility. NGN is typical for Nigeria.",
"usedOn": "Both",
"values": [
{
"apiValue": "NGN",
"mappedValue": "NGN",
"label": "Nigerian naira",
"description": "Default for local lending.",
"isAlias": false
},
{
"apiValue": "USD",
"mappedValue": "USD",
"label": "US dollar",
"description": "USD-denominated facilities when applicable.",
"isAlias": false
}
]
},
{
"field": "daysInArrears",
"summary": "Send daysInArrears on the request; Dikript maps it to the reported delinquency band (reference only).",
"usedOn": "Both",
"values": [
{
"apiValue": "0",
"mappedValue": "0",
"label": "Performing",
"description": "No arrears.",
"isAlias": false
},
{
"apiValue": "1-29",
"mappedValue": "1-29",
"label": "Late_less_than_30_days",
"description": "Late but under 30 days past due.",
"isAlias": false
},
{
"apiValue": "30-59",
"mappedValue": "30-59",
"label": "Delinquent_over_30_days",
"description": "30+ days past due.",
"isAlias": false
},
{
"apiValue": "60-89",
"mappedValue": "60-89",
"label": "Delinquent_over_60_days",
"description": "60+ days past due.",
"isAlias": false
},
{
"apiValue": "90-119",
"mappedValue": "90-119",
"label": "Sub_standard_90_days",
"description": "90+ days (sub-standard).",
"isAlias": false
},
{
"apiValue": "120-149",
"mappedValue": "120-149",
"label": "Sub_standard_120_days",
"description": "120+ days past due.",
"isAlias": false
},
{
"apiValue": "150-179",
"mappedValue": "150-179",
"label": "Sub_standard_150_days",
"description": "150+ days past due.",
"isAlias": false
},
{
"apiValue": "180-359",
"mappedValue": "180-359",
"label": "Doubtful_180_days",
"description": "Doubtful (180+ days).",
"isAlias": false
},
{
"apiValue": "360+",
"mappedValue": "360+",
"label": "Lost_360_days",
"description": "Lost / severely delinquent (360+ days).",
"isAlias": false
}
]
}
]
},
"error": null
}