Retrieve a Client

GET /v1/api/clients/:clientId

This endpoint retrieves a client belonging to a business

Headers

Name	Value
Content-Type	application/json
x-api-key	Business Secret Key

Parameter

Name	Type	Description
clientId	String	Fumiwo client ID or the business client reference ID

Response

200

{
"success": true,
"statusCode": 200,
"message": "Client retrieved successfully!",
"data": {
    "loans": [
        {
            "tenure": {
                "value": 12,
                "interval": "months"
            },
            "dateLoanIsSettled": null,
            "_id": "669baf94ff3c2f8f82666716",
            "loanReferenceId": "loan_123456",
            "applicationDate": "2023-01-01T00:00:00.000Z",
            "dateLoanWasGranted": "2023-01-15T00:00:00.000Z",
            "applicationStatus": "approved",
            "amount": 10000,
            "currency": "NGN",
            "totalInstallments": 12,
            "installmentRepayments": [
                {
                    "amountPaid": {
                        "_id": "669baf94ff3c2f8f82666719",
                        "amount": 833.33,
                        "currency": "NGN"
                    },
                    "_id": "669baf94ff3c2f8f82666717",
                    "dueDate": "2023-02-01T00:00:00.000Z",
                    "datePaid": "2023-02-01T00:00:00.000Z",
                    "amountDue": {
                        "_id": "669baf94ff3c2f8f82666718",
                        "amount": 833.33,
                        "currency": "NGN"
                    },
                    "status": "fully_paid",
                    "dateAdded": "2024-07-20T12:37:40.213Z",
                    "lastModifiedAt": "2024-07-20T12:37:40.213Z"
                },
                {
                    "amountPaid": {
                        "_id": "669baf94ff3c2f8f8266671c",
                        "amount": 833.33,
                        "currency": "NGN"
                    },
                    "_id": "669baf94ff3c2f8f8266671a",
                    "dueDate": "2023-03-01T00:00:00.000Z",
                    "datePaid": "2023-03-01T00:00:00.000Z",
                    "amountDue": {
                        "_id": "669baf94ff3c2f8f8266671b",
                        "amount": 833.33,
                        "currency": "NGN"
                    },
                    "status": "fully_paid",
                    "dateAdded": "2024-07-20T12:37:40.213Z",
                    "lastModifiedAt": "2024-07-20T12:37:40.213Z"
                },
                {
                    "amountPaid": {
                        "_id": "669baf94ff3c2f8f8266671f",
                        "amount": 833.33,
                        "currency": "NGN"
                    },
                    "_id": "669baf94ff3c2f8f8266671d",
                    "dueDate": "2023-04-01T00:00:00.000Z",
                    "datePaid": "2023-04-01T00:00:00.000Z",
                    "amountDue": {
                        "_id": "669baf94ff3c2f8f8266671e",
                        "amount": 833.33,
                        "currency": "NGN"
                    },
                    "status": "fully_paid",
                    "dateAdded": "2024-07-20T12:37:40.213Z",
                    "lastModifiedAt": "2024-07-20T12:37:40.213Z"
                },
                {
                    "amountPaid": null,
                    "_id": "669baf94ff3c2f8f82666720",
                    "dueDate": "2023-05-01T00:00:00.000Z",
                    "datePaid": null,
                    "amountDue": {
                        "_id": "669baf94ff3c2f8f82666721",
                        "amount": 833.33,
                        "currency": "NGN"
                    },
                    "status": "not_paid",
                    "dateAdded": "2024-07-20T12:37:40.213Z",
                    "lastModifiedAt": "2024-07-20T12:37:40.213Z"
                }
            ],
            "loanRepaymentStatus": "in_progress",
            "dateLastInstallmentIsDue": "2024-01-01T00:00:00.000Z",
            "client": "669baedbff3c2f8f8266670c",
            "businessId": "667d38938450ddf0f7ea2468",
            "createdAt": "2024-07-20T12:37:40.214Z",
            "lastModifiedAt": "2024-07-20T12:37:40.214Z",
            "__v": 0,
            "_createdAt": "2024-07-20T13:37:4040+01:00",
            "_lastModifiedAt": "2024-07-20T13:37:4040+01:00",
            "id": "669baf94ff3c2f8f82666716"
        }
    ],
    "latestDigitalCreditInfo": null,
    "digitalCreditInfoHistory": [],
    "externalReferenceId": "1234567890",
    "businessId": "667d38938450ddf0f7ea2468",
    "createdAt": "2024-07-20T12:34:35.459Z",
    "lastModifiedAt": "2024-07-20T12:37:40.506Z",
    "_createdAt": "2024-07-20T13:34:3535+01:00",
    "_lastModifiedAt": "2024-07-20T13:37:4040+01:00",
    "clientId": "669baedbff3c2f8f8266670c",
    "id": "669baedbff3c2f8f8266670c"
},
"links": []
}

400

{
  "error": "Invalid request"
}