βοΈFull Response Consumer API Integration guide
This guide outlines the specifications for integrating and utilizing the Consumer API, including authentication steps, token request flow, and data retrieval methods.
Last updated
{
"requestId": "X123-AB45",
"cellphoneNumber": "63XXXXXXXXXX",
"matchFlag": "No hit",
"data": []
}
{
"requestId": "X123-AB45",
"cellphoneNumber": "63XXXXXXXXXX",
"matchFlag": "Hit",
"data": [
{
"recordID": "123456789",
"kycSurname": "Doe",
"kycFirstName": "John",
"kycMiddleName": "Smith",
"kycDateOfBirth": "1990-01-01",
"kycIdNumber": "ABC123456",
"kycIdType": 4,
"kycMobileNumber": "63XXXXXXXXXX",
"kycEmailAddress": "john.doe@example.com",
"kycAddress": "123 Main St, Anytown, USA",
"loanInfoLoanType": 1,
"loanInfoApplicationDate": "2022-01-01",
"loanInfoOpenDate": "2022-01-01",
"loanInfoLoanTerm": 5,
"loanInfoOpenBalance": 10000,
"loanInfoOutstandingBalance": 8000,
"loanInfoNextDueDate": "2024-05-01",
"loanInfoLastPaymentAmount": 200,
"loanInfoLastPaymentDate": "2024-04-01",
"loanInfoStatusCode": "Active",
"loanInfoInstallmentAmount": 500,
"loanInfoOverdueAmount": 100,
"loanInfoRepaymentFrequency": 1,
"loanInfoRepaymentHistory": "00000",
"loanInfoRepaymentFullHistory": [
{
"dueDate": "2022-02-01",
"paymentDate": "2022-02-01",
"paymentAmount": 500.00
},
{
"dueDate": "2022-03-01",
"paymentDate": "2022-03-01",
"paymentAmount": 500.00
},
{
"dueDate": "2022-04-01",
"paymentDate": "2022-04-01",
"paymentAmount": 500.00
},
{
"dueDate": "2022-05-01",
"paymentDate": "2022-05-01",
"paymentAmount": 500.00
},
{
"dueDate": "2022-06-01",
"paymentDate": "2022-06-01",
"paymentAmount": 500.00
}
],
"loanInfoCloseDate": "2023-12-28",
"loanInfoLenderType": "fintech",
"contributorId": "12d3ae45-678d-9ae1-2345-6e789e3xx000",
"matchedKeys": [
"cellphoneNumber",
"email",
"firstName-lastName-dateOfBirth",
"idNumber"
],
"matchedKeyCount": 4
}
],
"summary": {
"numApp": 1,
"numAcc": 1,
"numReqSameDay": 3,
"wasDpd30Ever": 1,
"wasDpd90Ever": 0,
"wasDpd30Last3Months": 0,
"wasDpd90Last3Months": 0,
"wasDpd30LastYear": 0,
"wasDpd90LastYear": 0,
"numActiveLoan": 1,
"numClosedLoans": 2,
"numCollectionLoans": 0,
"numDelayedLoans": 0,
"numIncompleteLoans": 0,
"numNotDisbLoans": 0,
"numRejectedLoans": 2,
"numWrittenoffLoans": 0,
"minOpenBalance": 500,
"maxOpenBalance": 3000,
"sumOpenBalance": 4500,
"avgOpenBalance": 1500,
"minOutstanding": 3360,
"maxOutstanding": 3360,
"sumOutstanding": 3360,
"avgOutstanding": 3360,
"minLastPayment": 0,
"maxLastPayment": 1000,
"sumLastPayment": 1674,
"avgLastPayment": 837,
"minInstallment": 0,
"maxInstallment": 3360,
"sumInstallment": 4360,
"avgInstallment": 1453.33,
"minOverdue": 0,
"maxOverdue": 0,
"sumOverdue": 0,
"avgOverdue": 0,
"minLoanTerm": 0,
"maxLoanTerm": 1,
"avgLoanTerm": 1,
"avgOpenBalancePerLoan": 1500,
"avgOutstandingPerLoan": 1120,
"ratioDisbAppl": 0.6,
"ratioOutstandingOpenbalance": 0.75,
"ratioOverdueInstallment": 0,
"avgUtilizationRate": 2.24,
"maxUtilizationRate": 1.12,
"paymentToOutstandingRatio": 0.5,
"avgPaymentToInstallmentRatio": 0.58,
"highOutstandingFlag": 0,
"veryHighOutstandingFlag": 0,
"overdueFlag": 0,
"highOverdueFlag": 0,
"openRange": 2500,
"balanceVolatilityProxy": 1.67,
"outstandingRange": 0,
"outstandingVolatilityProxy": 0,
"installmentRange": 3360,
"installmentVolatilityProxy": 2.31,
"outstandingToOpenTrendProxy": 0,
"overdueTrendProxy": 0,
"loanTermTrendProxy": 0,
"avgApplDays": 8,
"daysSinceLastApplication": 1,
"daysSinceLastReject": 1,
"numRecordsLast10Days": 4,
"numRecordsLast30Days": 4,
"numRecordsLast60Days": 5,
"numRecordsLast90Days": 5,
"numRecordsLast180Days": 5,
"maxRecWeek": 2,
"minDaysApp": 1,
"maxDaysApp": 32,
"isFrequentApplicant": 1,
"isMediumFreqApplicant": 0,
"isInfrequentApplicant": 0,
"applicationFrequencyTrend": 0.13,
"numDistContr": 3,
"shareBiggestContr": 0.4,
"numDistIdNum": 1,
"numDistIdType": 1,
"numDistPhones": 1,
"numDistEmail": 1,
"numDistNames": 2,
"closedRate": 0.4,
"activeRate": 0.2,
"delayedRate": 0,
"collectionRate": 0,
"writtenoffRate": 0,
"rejectRate": 0.4,
"notDisbRate": 0,
"incompleteRate": 0,
"noHistPerf": 0,
"hasBadHistory": 0,
"hasCleanClosedHistory": 1,
"badToGoodRatio": 0,
"age": 28,
"numDistLoanType": 2,
"numPaydayLoans": 2,
"numPosLoans": 0,
"numCashLoans": 0,
"numRevLoans": 1,
"numCCLoans": 0,
"numAutoLoans": 0,
"numMotoLoans": 0,
"numHomeLoans": 0
},
"scores": {
"CS": {
"score": 540,
"band": 9
}
}
}