Guidelines

This API returns program guidelines for a specified program ID.

Contracts and Attributes

Guidelines Response

The following guidelinesOutput response is returned for a given program ID.

ATTRIBUTEDESCRIPTION
GuidelinesOutput
object
performanceIndicators
object
Object containing the indicators of the API performance.
performanceIndicators.entryStart time of the API
performanceIndicators.elapsedTimeTotal time taken by the API
performanceIndicators.qualification
PerformanceIndicators
Qualification Performance Indicators


allRegsUrl
string
The AllRegs URL being used internally by EPPS.
applicationIdentifier
string
Application Identifier. Application-level configuration set up by EPPS.
passKey
string
The application-level configuration set up by EPPS for pass key.


performanceIndicators
object
performanceIndicators.entry
string
Start time of the API.
performanceIndicators.elapsedTime
integer
Total time taken by the API.
performanceIndicators.qualification
PerformanceIndicators
qualificationPerformanceIndicators
Qualification Performance Indicators.


qualificationPerformanceIndicators
object
qualificationPerformanceIndicators.
total

integer
Total time taken.
qualificationPerformanceIndicators.
preQualification

integer
Time taken for PreQualification.
qualificationPerformanceIndicators.
ruleQualification

integer
Time taken for RuleQualification.
qualificationPerformanceIndicators.
postQualification

integer
Time taken for PostQualification.

Guideline Details Response

The following guidelinesDetailsOutput response is returned for a given program ID and qualification ID.

lUsageFlag (boolean, optional),
pTypeFlag (boolean, optional),
minCreditFlag (boolean, optional),
maxLTVFlag (boolean, optional),
maxCLTVFlag (boolean, optional),
maxHCLTVFlag (boolean, optional),
maxLoanFlag (boolean, optional),
pUsageFlag (boolean, optional),
maxLineFlag (boolean, optional),
guidelineDetailID (integer, optional),
credit (integer, optional),
ltv (number, optional),
cltv (number, optional),
maxLoan (integer, optional),
maxLine (integer, optional),
maxCash (integer, optional),
hcltv (number, optional),
guidelineVersionID (integer, optional),
pUsagesString (string, optional),
pTypesString (string, optional),
lUsageString (string, optional),
ltvString (string, optional),
cltvString (string, optional),
hcltvString (string, optional),
maxLoanString (string, optional),
maxLineString (string, optional)