⛏️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

Prerequisites

In order to obtain an API Token you first need to have client_id and client secret from the previous step.

Token Request Flow

To authenticate and obtain an OAuth token, follow the standard OAuth token request flow.

  • POST API URL

https://sandbox-app.lenderlink.ph/oauth/token
  • Grant Type

Use this grant type when the client is a server and does not require user authentication.

"grant_type": "client_credentials"
  • Requesting the Access Token

To request the Access Token, submit a POST request to the API URL, including the following body parameters in JSON format:


{
    "grant_type": "client_credentials",
    "client_id": "your client id",
    "client_secret": "your client secret",
    "scope": "full-access"
}
                                        
  • Handling the Token Response

Upon successful validation, the authorization server will respond with an access token:


{
    "token_type": "Bearer",
    "expires_in": 86400,
    "access_token": "eyJ0eXAiOiJKasd10sJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5YTc4MzVm..."
}
                                        
  • Token Lifespan

Access tokens have a limited lifespan of 86400 seconds. Once the token expires, you can obtain a new one.

Request Borrower Data

Introduction

This endpoint facilitates the generation of a borrower's full data available by their phone number.

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

Parameter
Type
Mandatory
Description

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.

email

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