This endpoint returns a result set of customer data specific to the request type.
Request Body Description
| # | Field Name | Data Type | Max Length / Format | Required | Description |
| 2 | requestType | String | Yes | This field specify the request type which can be any of the values in { KYC, SMS, TRANSACTION} | |
| 3 | 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. |
| 4 | endDate | Date | YYYY-MM-dd | Yes | This field specified the report end date |
Resource URL:{{baseurl}}/api/v1/request/ils?pageSize=10&pageNumber=1
Headers
A HTTP Method: POST
Authentication: User Access Token or Client Access Token
Content-Type: application/json
Sample Request
Request: { “requestType” : “SMS”,
“startDate” : “2017-12-20” ,
“endDate” : “2019-12-20” }
Sample Response
Sample Response: {"responseCode": "00","responseMessage": "Successful","data": {"count": 7,"kycData": null,"smsData": [{"id": "01220200312151414817613","key": "ACCPRO.BULK","msisdn": "2347037940455","info": "MTN.DIRECT:bffc505","date": "2020-01-12 15:14 PM UTC","additionalInfo": "Win N1million for your business. Dial *901*5# to... "},{"id": "01220200312151414817633","key": "ACCPRO.BULK","msisdn": "01220200312151414817683","info": "MTN.DIRECT:bffc505","date": "2020-01-12 15:14 PM UTC","additionalInfo": "Win N1million for your business. Dial *901*5# to... "},{"id": "01220200312151414817643","key": "ACCPRO.BULK","msisdn": "01220200312151414817683","info": "MTN.DIRECT:bffc505","date": "2020-01-12 13:14 PM UTC","additionalInfo": "Win N1million for your business. Dial *901*5# to... "},{"id": "01220200312151414817653","key": "ACCPRO.BULK","msisdn": "01220200312151414817683","info": "MTN.DIRECT:bffc505","date": "2020-01-13 15:14 PM UTC","additionalInfo": "Win N1million for your business. Dial *901*5# to... "},{"id": "01220200312151414817663","key": "ACCPRO.BULK","msisdn": "01220200312151414817683","info": "MTN.DIRECT:bffc505","date": "2020-01-14 15:14 PM UTC","additionalInfo": "Win N1million for your business. Dial *901*5# to... "},{"id": "01220200312151414817673","key": "ACCPRO.BULK","msisdn": "01220200312151414817683","info": "MTN.DIRECT:bffc505","date": "2020-01-12 15:15 PM UTC","additionalInfo": "Win N1million for your business. Dial *901*5# to... "},{"id": "01220200312151414817683","key": "ACCPRO.BULK","msisdn": "01220200312151414817683","info": "MTN.DIRECT:bffc505","date": "2020-01-17 15:14 PM UTC","additionalInfo": "Win N1million for your business. Dial *901*5# to... "}],"transactionHistoryData": null}}
2.2.2 Transaction
Sample
Request: {"requestType": "transaction","startDate": "2020-01-01","endDate": "2020-05-01"} |
Sample
Response: {"responseCode": "00","responseMessage": "Successful","dateRange": "6-Months","data": {"count": 9,"kycData": null,"smsData": null,"transactionHistoryData": [{"id": 0,"msisdn": "652061BB92F553B22BA69B526847755E","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": "6CEBD0F0F83B9F920E71D913681BF3DE","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.2.3 KYC
This end point allows the caller to retrieve specific minimal kyc details using a phone number, bvn or bankcode and account number.
URL: /api/v1/request/verification/kycInfo?
Authorization: Bearer Token
Request Message Description
| # | Field Name | Data Type | Combine? | Required | Description |
| 1 | phoneNumber | String | No | No | This field retrieves individual’s kyc details based on the supplied phone number, it take precedence over the other parameters |
| 2 | bvn | String | No | No | This field bvn allows you to retieve information based on supplied bvn |
| 3 | bankCode | String | Yes | No | This field specified bankCode, if supplied, accountNumber is required |
| 4 | accountNumber | String | Yes | No | This field specified a bank account Number, if supplied, bankCode is required |
2.2.3.1 BVNSample
URL: /api/v1/request/verification/kycInfo?bvn=22141888954 |
Sample
Response: {"responseCode": "00","responseMessage": "Successful","data": {"bvn": "22141888954","accountNumber": "0234422322","accountName": "EZINWANNE OKOYE","bankCode": "000013","firstName": "EZINWANNE","lastName": "OKOYE","dob": "16/11/82","phone": "07033943047","residentialAddress": ", 3B,OFF ADENUGA STREET,HARMONY ESTATEODO-ESA CLOSE,IFAKO GBAGADA\""}} |
2.2.3.2 Phone Number
Sample
URL: /api/v1/request/verification/kycInfo?phoneNumber=07033943047 |
Sample
Response: {"responseCode": "00","responseMessage": "Successful","data": {"bvn": "22141888954","accountNumber": "0234422322","accountName": "EZINWANNE OKOYE","bankCode": "000013","firstName": "EZINWANNE","lastName": "OKOYE","dob": "16/11/82","phone": "07033943047","residentialAddress": ", 3B,OFF ADENUGA STREET,HARMONY ESTATEODO-ESA CLOSE,IFAKO GBAGADA\""}} |
2.2.3.3 Bank Code and Bank Account Number
Sample
URL: /api/v1/request/verification/kycInfo?bankCode=000013&account=0234422322 |
Sample
Response: {"responseCode": "00","responseMessage": "Successful","data": {"bvn": "22141888954","accountNumber": "0234422322","accountName": "EZINWANNE OKOYE","bankCode": "000013","firstName": "EZINWANNE","lastName": "OKOYE","dob": "16/11/82","phone": "07033943047","residentialAddress": ", 3B,OFF ADENUGA STREET,HARMONY ESTATEODO-ESA CLOSE,IFAKO GBAGADA\""}} |