Clients

Get all clients

Get clients

GET {base url}/v1/clients?page={page}&perPage={perPage}

Returns paginated list of all clients

Query Parameters

Headers

{
    "message": "No authorization token found",
    "code": 90
}
{
    "responseCode": "00",
    "message": "Clients fetch successful",
    "data": [
        {
            "id": "059cf55a-0e1b-4650-b97a-152af3d5dc03",
            "organizationId": "ab3b150e-6a5d-429f-b499-f2d6ea99f668",
            "clientRef": "v8sj5vlg4u8kkdir4shaj0dapwdcs66o",
            "email": "",
            "firstName": "client1",
            "lastName": "clet",
            "middleName": "",
            "dob": "2023-12-05",
            "status": "active",
            "address": "no 10 ogujobi street",
            "city": "",
            "state": "Abia",
            "country": "Nigeria",
            "phoneNumber": "",
            "image": "https://res.cloudinary.com/dtui4qk9s/image/upload/v1701795434/uploads/h8gtnwawaawbmvm3nw7u.png",
            "customData": {
                "custom_7nuu": "55555",
                "custom_fjgu": "ggggggg",
                "custom_fsmm": "4444",
                "custom_gdwn": "ggffff",
                "custom_mkmj": "hhhhh",
                "custom_otjq": "555",
                "custom_pgcx": "ggggggg",
                "custom_rwgv": "gggggggg",
                "custom_seo8": "hhhhh",
                "custom_snnd": "444",
                "custom_tapp": "fgggg",
                "custom_vyc9": "4444",
                "custom_wiet": "4344",
                "client custom": "https://res.cloudinary.com/dtui4qk9s/image/upload/v1701778690/uploads/nupq9qxyhjprvsblkg2j.png",
                "client again custom": "9989898"
            },
            "created_at": "2023-12-05T12:18:13.396Z",
            "updated_at": "2023-12-05T17:00:40.697Z"
        }
    ]
}

Get client by clientRef

Get client by Reference

GET {base url}/v1/clients/{clientRef}

Get a single client by client reference

Query Parameters

Headers

{
    "message": "unauthorize",
    "code": 92
}
{
    "responseCode": "00",
    "message": "Client fetch successful",
    "data": {
        "id": "d7e57674-b0d9-462e-8636-453c6b3de7f5",
        "organizationId": "ab3b150e-6a5d-429f-b499-f2d6ea99f668",
        "clientRef": "d7e57674-b0d9-462e-8636-453c6b3de7f5",
        "email": "suleaishat990@gmail.com",
        "firstName": "Sule",
        "lastName": "Aladi",
        "middleName": "Aishat",
        "dob": "1998-12-12",
        "status": "active",
        "address": "GP. 782, olobayo estate lokoja",
        "city": "Aba",
        "state": "Abia",
        "country": "Nigeria",
        "phoneNumber": "0806 693 1689",
        "image": null,
        "customData": {},
        "created_at": "2023-06-23T08:48:27.986Z",
        "updated_at": "2023-06-23T13:45:06.649Z",
        "documentCount": 0,
        "depositCount": 0,
        "loanCount": 0
    }
}

Get client loans

Get clients loans

GET {base url}/v1/clients/${clientId}/loans?page={page}&perPage={perPage}

Returns paginated list of all clients

Query Parameters

Headers

{
    "message": "unauthorized",
    "code": 92
}
{
    "responseCode": "00",
    "message": "Loan fetch successful",
    "data": [
        {
            "id": "104d3cad-a9a1-4598-be48-631fe75de1e5",
            "organizationId": "a5f38f16-6c44-408f-b7ff-6775f02b83ac",
            "loanName": "a test loan 9",
            "loanProductId": "79963366-6aad-489a-82db-84d5374f707a",
            "amount": 20000,
            "totalDue": 0,
            "totalPaid": 0,
            "interestRate": 5,
            "gracePeriod": null,
            "accountNumber": "0000001163",
            "accountHolder": "665b5c8a-d30d-41f1-b6e1-508562b4eecb",
            "accountHolderType": "clients",
            "tenure": 5,
            "customData": {
                "cipn": "1000",
                "dep test": "ererere",
                "file type": "https://res.cloudinary.com/dtui4qk9s/image/upload/v1702139767/uploads/qlept2xandaph21zkknu.jpg"
            },
            "balances": {
                "totalAccruedFees": 0,
                "totalAccruedPenalty": 0,
                "totalAccruedinterest": 0,
                "totalPrincipalBalance": 20000
            },
            "tranches": null,
            "status": "inactive",
            "document": null,
            "state": "PENDING",
            "riskState": "PERFOMRING",
            "comment": null,
            "created_at": "2023-12-09T16:36:10.374Z",
            "updated_at": "2023-12-09T16:36:10.374Z",
            "firstName": "Lamidi",
            "lastName": "AdeDola",
            "clientkey": "665b5c8a-d30d-41f1-b6e1-508562b4eecb",
            "name": null,
            "accountholdername": null,
            "companykey": null,
            "loanproductname": "testing",
            "currency": "NGN"
        }
    ]
}

Get client deposits

Get client deposits

GET {base url}/v1/clients/{clientId}/deposits?page={page}&perPage={perPage}

Returns paginated list of all client deposits

Query Parameters

Headers

{
    "message": "unauthorize",
    "code": 92
}
{
    "responseCode": "00",
    "message": "deposits fetch successful",
    "data": [
    {
          "id": "844e2eaa-61a1-4099-8407-55a4b24df294",
          "organizationId": "a5f38f16-6c44-408f-b7ff-6775f02b83ac",
          "depositProductId": "aeec33a0-059f-4a4a-b122-357eec1572c2",
          "accountNumber": "0000000692",
          "accountName": "new depo 34",
          "accountHolder": "05768940-15ed-450c-8d8e-70f36ffffff8",
          "accountHolderType": "companies",
          "depositTenure": null,
          "accruedInterest": 0,
          "customData": {},
          "accountBalance": 19000,
          "accountLedgerBalance": 19000,
          "maturityDate": null,
          "status": "active",
          "updated_at": "2023-12-12T00:01:02.256Z",
          "firstName": null,
          "lastName": null,
          "clientkey": null,
          "name": "chowDeck",
          "accountholdername": "chowDeck",
          "companykey": "05768940-15ed-450c-8d8e-70f36ffffff8",
          "productName": "new product 1000",
          "productType": "savings_account"
      }
    ]
}

Update Client

Update client

PATCH {base url}/v1/clients/{clientId}

Update client data

Query Parameters

Headers

Request Body

{
    "message": "unauthorize",
    "code": 92
}

{
    "firstName": "john",
    "lastName": "doe",
    "middleName": "louis",
    "dob": "2022-03-19",
    "image": "https://www.aihr.com/wp-content/uploads/organizational-design-cover.png",
    "address": "Lagos",
    "city": "Lagos",
    "state": "Lagos",
    "country": "Nigeria",
    "phoneNumber": "091781094158963",
    "email": "",
    "customData": { "ID Type": "id", "bvn": "12345678911"}

}

Delete client

Delete client

DELETE {base url}/v1/clients/{clientId}

Delete client

Query Parameters

Headers

{
    "message": "unauthorize",
    "code": 92
}
{
    "responseCode": "00",
    "message": "Client data deleted successfully"
}

search client

Search client

GET {base url}/v1/clients/{search}

Search client

Query Parameters

Headers

{
    "message": "unauthorize",
    "code": 92
}
{
    "responseCode": "00",
    "message": "Clients fetch successful",
    "data": [
        {
            "id": "27536765-c575-4189-a365-8940c3bd9124",
            "organizationId": "038f1d6c-dd3a-4aa2-adf3-be4f591cf132",
            "clientRef": "s9o1ac6l",
            "email": "zodravem@oobla.io",
            "firstName": "Mason",
            "lastName": "Louis",
            "middleName": "Terry",
            "dob": "1982-12-12",
            "status": "active",
            "address": "18 Ikefah Ln",
            "city": "Yola",
            "state": "Adamawa",
            "country": "Nigeria",
            "phoneNumber": "08062249291",
            "image": "https://res.cloudinary.com/dtui4qk9s/image/upload/v1695387366/uploads/sxqyxmvqneba5vt5xiv2.jpg",
            "customData": {},
            "created_at": "2023-09-22T12:56:07.799Z",
            "updated_at": "2023-09-22T12:56:07.799Z"
        },
        
    ]
}

Create client

Create client

POST {base url}/v1/clients

create a single client

Headers

Request Body

{
    "responseCode": "00",
    "message": "Client created successfully",
    "data": {
        "organizationId": "a5f38f16-6c44-408f-b7ff-6775f02b83ac",
        "clientRef": "x4sopax1z1oh347131dlglpp9n4m40si",
        "firstName": "Lamidi",
        "lastName": "AdeDola",
        "middleName": "Aduke",
        "email": "",
        "phoneNumber": "091781094158963",
        "dob": "2022-03-19",
        "address": "Lagos",
        "city": "Lagos",
        "state": "Lagos",
        "country": "Nigeria",
        "image": "https://res.cloudinary.com/dtui4qk9s/image/upload/v1702467276/uploads/neykb8zhrhokgkqgr0x3.png",
        "customData": {
            "bvn": "https://res.cloudinary.com/dtui4qk9s/raw/upload/v1702467276/documents/erobqftlpmdicuexedmn",
            "ID Type": "https://res.cloudinary.com/dtui4qk9s/image/upload/v1702467275/uploads/lowhyx7j7ycfz58qzovt.png"
        },
        "status": "active",
        "id": "a50847bb-0c87-4098-bfe1-07b5ad15fb6d",
        "created_at": "2023-12-13T11:34:37.192Z",
        "updated_at": "2023-12-13T11:34:37.192Z"
    }
}

{
    "organizationId": "a5f38f16-6c44-408f-b7ff-6775f02b83ac",
    "firstName": "Lamidi",
    "lastName": "AdeDola",
    "middleName": "Aduke",
    "dob": "2022-03-19",
    "image": "https://www.aihr.com/wp-content/uploads/organizational-design-cover.png",
    "address": "Lagos",
    "city": "Lagos",
    "state": "Lagos",
    "country": "Nigeria",
    "phoneNumber": "091781094158963",
    "customData": { "ID Type": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAApgAAAKYB3X3/OAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAANCSURBVEiJtZZPbBtFFMZ/M7ubXdtdb1xSFyeilBapySVU8h8OoFaooFSqiihIVIpQBKci6KEg9Q6H9kovIHoCIVQJJCKE1ENFjnAgcaSGC6rEnxBwA04Tx43t2FnvDAfjkNibxgHxnWb2e/u992bee7tCa00YFsffekFY+nUzFtjW0LrvjRXrCDIAaPLlW0nHL0SsZtVoaF98mLrx3pdhOqLtYPHChahZcYYO7KvPFxvRl5XPp1sN3adWiD1ZAqD6XYK1b/dvE5IWryTt2udLFedwc1+9kLp+vbbpoDh+6TklxBeAi9TL0taeWpdmZzQDry0AcO+jQ12RyohqqoYoo8RDwJrU+qXkjWtfi8Xxt58BdQuwQs9qC/afLwCw8tnQbqYAPsgxE1S6F3EAIXux2oQFKm0ihMsOF71dHYx+f3NND68ghCu1YIoePPQN1pGRABkJ6Bus96CutRZMydTl+TvuiRW1m3n0eDl0vRPcEysqdXn+jsQPsrHMquGeXEaY4Yk4wxWcY5V/9scqOMOVUFthatyTy8QyqwZ+kDURKoMWxNKr2EeqVKcTNOajqKoBgOE28U4tdQl5p5bwCw7BWquaZSzAPlwjlithJtp3pTImSqQRrb2Z8PHGigD4RZuNX6JYj6wj7O4TFLbCO/Mn/m8R+h6rYSUb3ekokRY6f/YukArN979jcW+V/S8g0eT/N3VN3kTqWbQ428m9/8k0P/1aIhF36PccEl6EhOcAUCrXKZXXWS3XKd2vc/TRBG9O5ELC17MmWubD2nKhUKZa26Ba2+D3P+4/MNCFwg59oWVeYhkzgN/JDR8deKBoD7Y+ljEjGZ0sosXVTvbc6RHirr2reNy1OXd6pJsQ+gqjk8VWFYmHrwBzW/n+uMPFiRwHB2I7ih8ciHFxIkd/3Omk5tCDV1t+2nNu5sxxpDFNx+huNhVT3/zMDz8usXC3ddaHBj1GHj/As08fwTS7Kt1HBTmyN29vdwAw+/wbwLVOJ3uAD1wi/dUH7Qei66PfyuRj4Ik9is+hglfbkbfR3cnZm7chlUWLdwmprtCohX4HUtlOcQjLYCu+fzGJH2QRKvP3UNz8bWk1qMxjGTOMThZ3kvgLI5AzFfo379UAAAAASUVORK5CYII=", "bvn": "data:application/pdf;base64,JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DQovVHlwZSAvQ2F0YWxvZw0KL091dGxpbmVzIDIgMCBSDQovUGFnZXMgMyAwIFINCj4+DQplbmRvYmoNCg0KMiAwIG9iag0KPDwNCi9UeXBlIC9PdXRsaW5lcw0KL0NvdW50IDANCj4+DQplbmRvYmoNCg0KMyAwIG9iag0KPDwNCi9UeXBlIC9QYWdlcw0KL0NvdW50IDINCi9LaWRzIFsgNCAwIFIgNiAwIFIgXSANCj4+DQplbmRvYmoNCg0KNCAwIG9iag0KPDwNCi9UeXBlIC9QYWdlDQovUGFyZW50IDMgMCBSDQovUmVzb3VyY2VzIDw8DQovRm9udCA8PA0KL0YxIDkgMCBSIA0KPj4NCi9Qcm9jU2V0IDggMCBSDQo+Pg0KL01lZGlhQm94IFswIDAgNjEyLjAwMDAgNzkyLjAwMDBdDQovQ29udGVudHMgNSAwIFINCj4+DQplbmRvYmoNCg0KNSAwIG9iag0KPDwgL0xlbmd0aCAxMDc0ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBBIFNpbXBsZSBQREYgRmlsZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIFRoaXMgaXMgYSBzbWFsbCBkZW1vbnN0cmF0aW9uIC5wZGYgZmlsZSAtICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjY0LjcwNDAgVGQNCigganVzdCBmb3IgdXNlIGluIHRoZSBWaXJ0dWFsIE1lY2hhbmljcyB0dXRvcmlhbHMuIE1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NTIuNzUyMCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDYyOC44NDgwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjE2Ljg5NjAgVGQNCiggdGV4dC4gQW5kIG1vcmUgdGV4dC4gQm9yaW5nLCB6enp6ei4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjA0Ljk0NDAgVGQNCiggbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDU5Mi45OTIwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNTY5LjA4ODAgVGQNCiggQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA1NTcuMTM2MCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBFdmVuIG1vcmUuIENvbnRpbnVlZCBvbiBwYWdlIDIgLi4uKSBUag0KRVQNCmVuZHN0cmVhbQ0KZW5kb2JqDQoNCjYgMCBvYmoNCjw8DQovVHlwZSAvUGFnZQ0KL1BhcmVudCAzIDAgUg0KL1Jlc291cmNlcyA8PA0KL0ZvbnQgPDwNCi9GMSA5IDAgUiANCj4+DQovUHJvY1NldCA4IDAgUg0KPj4NCi9NZWRpYUJveCBbMCAwIDYxMi4wMDAwIDc5Mi4wMDAwXQ0KL0NvbnRlbnRzIDcgMCBSDQo+Pg0KZW5kb2JqDQoNCjcgMCBvYmoNCjw8IC9MZW5ndGggNjc2ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBTaW1wbGUgUERGIEZpbGUgMiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIC4uLmNvbnRpbnVlZCBmcm9tIHBhZ2UgMS4gWWV0IG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NzYuNjU2MCBUZA0KKCBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY2NC43MDQwIFRkDQooIHRleHQuIE9oLCBob3cgYm9yaW5nIHR5cGluZyB0aGlzIHN0dWZmLiBCdXQgbm90IGFzIGJvcmluZyBhcyB3YXRjaGluZyApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY1Mi43NTIwIFRkDQooIHBhaW50IGRyeS4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NDAuODAwMCBUZA0KKCBCb3JpbmcuICBNb3JlLCBhIGxpdHRsZSBtb3JlIHRleHQuIFRoZSBlbmQsIGFuZCBqdXN0IGFzIHdlbGwuICkgVGoNCkVUDQplbmRzdHJlYW0NCmVuZG9iag0KDQo4IDAgb2JqDQpbL1BERiAvVGV4dF0NCmVuZG9iag0KDQo5IDAgb2JqDQo8PA0KL1R5cGUgL0ZvbnQNCi9TdWJ0eXBlIC9UeXBlMQ0KL05hbWUgL0YxDQovQmFzZUZvbnQgL0hlbHZldGljYQ0KL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcNCj4+DQplbmRvYmoNCg0KMTAgMCBvYmoNCjw8DQovQ3JlYXRvciAoUmF2ZSBcKGh0dHA6Ly93d3cubmV2cm9uYS5jb20vcmF2ZVwpKQ0KL1Byb2R1Y2VyIChOZXZyb25hIERlc2lnbnMpDQovQ3JlYXRpb25EYXRlIChEOjIwMDYwMzAxMDcyODI2KQ0KPj4NCmVuZG9iag0KDQp4cmVmDQowIDExDQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAwMDAwMTkgMDAwMDAgbg0KMDAwMDAwMDA5MyAwMDAwMCBuDQowMDAwMDAwMTQ3IDAwMDAwIG4NCjAwMDAwMDAyMjIgMDAwMDAgbg0KMDAwMDAwMDM5MCAwMDAwMCBuDQowMDAwMDAxNTIyIDAwMDAwIG4NCjAwMDAwMDE2OTAgMDAwMDAgbg0KMDAwMDAwMjQyMyAwMDAwMCBuDQowMDAwMDAyNDU2IDAwMDAwIG4NCjAwMDAwMDI1NzQgMDAwMDAgbg0KDQp0cmFpbGVyDQo8PA0KL1NpemUgMTENCi9Sb290IDEgMCBSDQovSW5mbyAxMCAwIFINCj4+DQoNCnN0YXJ0eHJlZg0KMjcxNA0KJSVFT0YNCg=="},
    "email": ""
}

Last updated