Fetch Customers

Search all customers on the application

Search for customers on the application

GET https://<your_business_alias>.lendastack.io/ias/loan/searchcustomer

This endpoint returns a single customer if the number of record found is one(1) or a list of customers if the records found is more than one(1)

Path Parameters

Name	Type	Description
searchType	String	The information on the customer to seach by. Must be one ofUniqueId, Phone, Email, General
parameter	String	The search keyword

Headers

Name	Type	Description
Authentication*	String	The encoded combination of your public key and secret key (see the Test and go live section of the docs)

200: OK Success

{
    "data": {
        "recordsFound": 1,
        "customer": {
            "personId": 1071,
            "firstName": "Segun",
            "lastName": "Ola",
            "dateOfBirth": "2005-02-10",
            "phoneNumber": "0800000000000",
            "emailAddress": "[e-mail]",
            "personCode": "CUS0001071",
            "createdAt": "2023-03-24T11:42:12.0472929",
            "hasActiveLoan": false,
            "isBvnValidated": false
        }
    },
    "status": true,
    "message": "success"
}

200: OK Success

{
    "data": {
        "recordsFound": 6,
        "customers": [
            {
                "personId": 17,
                "firstName": "Ola",
                "lastName": "nce (Gifted Services Nigeria Limited",
                "dateOfBirth": "2021-11-11",
                "phoneNumber": "01234567894",
                "emailAddress": "[e-mail]",
                "bvn": "0987654321",
                "personCode": "",
                "createdAt": "2021-06-10T04:08:28.1252323",
                "hasActiveLoan": true,
                "isBvnValidated": false
            },
            {
                "personId": 227,
                "firstName": "Ola",
                "middleName": "Ade",
                "lastName": "Ada",
                "dateOfBirth": "2021-07-01",
                "phoneNumber": "09090909090",
                "emailAddress": "[e-mail]",
                "createdAt": "2021-07-08T12:20:42.2933279",
                "hasActiveLoan": false,
                "isBvnValidated": false
            },
            {
                "personId": 251,
                "firstName": "Deji",
                "lastName": "Ola",
                "dateOfBirth": "2021-06-28",
                "phoneNumber": "09078499365",
                "emailAddress": "[e-mail]",
                "personCode": "CUS210731",
                "createdAt": "2021-07-26T11:55:57.8315019",
                "hasActiveLoan": true,
                "isBvnValidated": false
            },
            {
                "personId": 756,
                "firstName": "Abiola",
                "middleName": "",
                "lastName": "Ola",
                "dateOfBirth": "",
                "phoneNumber": "808695",
                "emailAddress": "[e-mail]",
                "bvn": "",
                "personCode": "",
                "createdAt": "2022-06-27T15:45:25.7679355",
                "hasActiveLoan": false,
                "isBvnValidated": false
            },
            {
                "personId": 1071,
                "firstName": "Segun",
                "lastName": "Ola",
                "dateOfBirth": "2005-02-10",
                "phoneNumber": "0800000000000",
                "emailAddress": "[e-mail]",
                "personCode": "CUS0001071",
                "createdAt": "2023-03-24T11:42:12.0472929",
                "hasActiveLoan": false,
                "isBvnValidated": false
            },
            {
                "personId": 1072,
                "firstName": "Segun",
                "lastName": "Ola",
                "dateOfBirth": "2005-02-10",
                "phoneNumber": "09076787654",
                "emailAddress": "[e-mail]",
                "personCode": "CUS0001072",
                "createdAt": "2023-03-24T11:47:50.6949176",
                "hasActiveLoan": false,
                "isBvnValidated": false
            }
        ]
    },
    "status": true,
    "message": "success"
}

200: OK Success

{
    "data": {
        "recordsFound": 0,
        "customers": []
    },
    "status": true,
    "message": "success"
}