This end point allows the caller to retrieve specific detail of an individual based on the specified request type and phone number provided in the call
Request Message Description
| # | Field Name | Data Type | Max Length / Format | Required | Description |
| 1 | requestType | String | Yes | This field specify the request type which can be any of the values in { KYC, SMS, TRANSACTION} | |
| 2 | startDate | Date | YYYY-MM-dd | Yes | This field specify the beginning of your report. The dataset will cover all records between the value specified in this field and the endDate field. |
| 3 | endDate | Date | YYYY-MM-dd | Yes | This field specified the report end date |
Endpoint: Dataset API endpoint for individual
/api/v1/request/ils/{{msisdn}}?pageNumber=0&pageSize=20
Headers:
NOTE: Change the {{msisdn}} in the url to a valid msisdn E.g. /api/v1/request/ils/2349011111111?pageNumber=0&pageSize=2
HTTP Method: POST
Authentication: User Access Token or Client Access Token
Content-Type: application/json
2.3.1 SMS
Sample
Request: {"requestType": "sms","startDate": "2021-04-01","endDate": "2021-08-01"} |
Sample
Response:{"responseCode": "00","responseMessage": "Successful","count": 4,"data": [{"balance": "3.45","bank": "ACCESS.TNS","currency": "NGN","msisdn": "1220210701075312673697","telco": "Operator.ExchangeTelecom.MTN.Trans:107676833","txn_amount": 20.0,"txn_date": "Thu Jul 01 07:53:12 WAT 2021","txn_type": "Debit","year": "2021","month": "Jul"},{"balance": "18207.0","bank": "ACCESS.TNS","currency": "NGN","msisdn": "1220210701075313424770","telco": "Operator.ExchangeTelecom.MTN.Trans:107676948","txn_amount": 20000.0,"txn_date": "Thu Jul 01 07:53:13 WAT 2021","txn_type": "Debit","year": "2021","month": "Jul"}]} |
2.3.2 Transaction
Sample
Request: {"requestType": "transaction","startDate": "2020-02-01","endDate": "2020-06-05"} |
Sample
response: {"responseCode": "00","responseMessage": "Successful","count": 3,"data": [{"id": 0,"msisdn": "F675BFC43D7C39E4FFBF254A7A1DF2FA","accountNumber": "0F7E44A922DF352C05C5F73CB40BA115","panEncrypted": "0A4131EDE8BC19616107D876B607DEFB","amount": 500000,"transactionType": "CASH WITHDRAWAL","channel": "ATM","paymentItem": "OYIGBO BRANCH","merchantBiller": "Port Harcourt","cardBrand": "VERVE","acqiurerBank": null,"issuerBank": "FCMB","transactionDate": "2020-02-04 00:00:00.0","transactionTime": "2020-02-04 08:42:23.0","responseCode": "00","extraData": null,"cbnBankCode": "032","transactionRef": "12AE9B04-76D5-4F3B-8C0A-B56D0F2AE22F"},{"id": 0,"msisdn": "F675BFC43D7C39E4FFBF254A7A1DF2FA","accountNumber": "853181CA90009927F0FFC32001DCAD61","panEncrypted": "32E874D676AFE8859E209D00D6DB62D7","amount": 900000,"transactionType": "CASH WITHDRAWAL","channel": "ATM","paymentItem": "OYIGBO BRANCH","merchantBiller": "Port Harcourt","cardBrand": "MASTERCARD","acqiurerBank": null,"issuerBank": "GTB","transactionDate": "2020-02-04 00:00:00.0","transactionTime": "2020-02-04 08:42:23.0","responseCode": "00","extraData": null,"cbnBankCode": "058","transactionRef": "3FA9A519-510B-4FA6-9DF0-17B4FE7FA673"}]} |
2.3.3 KYC
Sample
Request: {"requestType": "kyc","startDate": "2020-02-01","endDate": "2020-06-05"} |
Sample
Response: {"responseCode": "00","responseMessage": "Successful","count": 0,"data": []} |