---
description: >-
  This guide outlines the specifications for integrating and utilizing the
  Consumer API, including authentication steps, token request flow, and data
  retrieval methods.
---

# LenderLink Lite API Integration guide

### Authentication

Obtain a token via the [authentication](authentication "mention") procedure.&#x20;

### Request Borrower Data

### Introduction

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

{% hint style="warning" %}
Note:

To utilize this endpoint, an access token is required. The procedure for obtaining one is detailed in the preceding section.
{% endhint %}

**Borrower Data Request Flow**

To obtain a Borrower data, follow the instructions below.

* GET API URL

```
https://sandbox-app.lenderlink.ph/api/v1/person/lite
```

* Authorization

Use the generated token as Bearer access token and include it into the request.

| Token | `eyJ0eXAiOiJKasd10sJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5YTc4MzVm...` |
| ----- | -------------------------------------------------------------- |

* **Query Params**

<table><thead><tr><th width="258">Parameter</th><th width="125">Type</th><th width="116">Mandatory</th><th>Description</th></tr></thead><tbody><tr><td>requestId</td><td>String</td><td>Yes</td><td>Unique identification code generated by the client</td></tr><tr><td>cellphoneNumber</td><td>String</td><td>Yes</td><td>Borrower's phone number, the format is 639XXXXXXXXX.</td></tr><tr><td>email</td><td>String</td><td>No</td><td>Borrower's email address</td></tr><tr><td>idNumber</td><td>String</td><td>No</td><td>Borrower's ID document number. ID, Driver license, etc</td></tr></tbody></table>

* **Handling the Response**

Upon successful validation, the server will return one of two responses:

1\. No match:

```json

{
    "requestId": "X123-AB45",
    "cellphoneNumber": "63XXXXXXXXXX",
    "matchFlag": "No hit",
    "data": []
}
                                
```

2. Match - aggregated summary block is returned

```json
{
    "requestId": "X123-AB45",
    "matchFlag": "Hit",
    "cellphoneNumber": "63XXXXXXXXXX",
    "data": {
        "msisdn": "63XXXXXXXXXX",
        "numApp": 1,
        "numAcc": 1,
        "wasDpd30Ever": 1,
        "wasDpd90Ever": 0,
        "wasDpd30Last3Months": 0,
        "wasDpd90Last3Months": 0,
        "wasDpd30LastYear": 0,
        "wasDpd90LastYear": 0
    }
}
```

