βοΈ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.
Authentication
Obtain a token via the Authentication procedure.
Request Borrower Data
Introduction
This endpoint facilitates the generation of a borrower's full data available by their phone number.
Note:
To utilize this endpoint, an access token is required. The procedure for obtaining one is detailed in the preceding section.
Borrower Data Request Flow
To obtain a Borrower data, follow the instructions below.
GET API URL
https://sandbox-app.lenderlink.ph/api/full/borrower
Authorization
Use the generated token as Bearer access token and include it into the request.
Token
eyJ0eXAiOiJKasd10sJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5YTc4MzVm...
Query Params
requestId
String
Yes
Unique identification code generated by the client
firstName
String
Yes
First Name
lastName
String
Yes
Last Name
dateOfBirth
Date
Yes
Date of Birth - YYYY-MM-DD
cellphoneNumber
String
Yes
Borrower's phone number, the format is 63XXXXXXXXXX.
String
No
Borrower's email address
idNumber
String
No
Borrower's ID document number. ID, Driver license, etc
Handling the Response
Upon successful validation, the server will return one of two responses:
1. No match:
{
"requestId": "X123-AB45",
"cellphoneNumber": "63XXXXXXXXXX",
"matchFlag": "No hit",
"data": []
}
2. Match - data for all loans found in partners databases (full response) is returned
{
"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": "[email protected]",
"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",
"loanInfoCloseDate": "2023-12-28",
"contributorId": "12d3ae45-678d-9ae1-2345-6e789e3xx000"
}
]
}
Last updated