Companies

Create company

Create company

POST {base url}/v1/companies

Create company

Headers

Name	Type	Description
Authorization*	Bearer token	The bearer token is the API users Secret Key

Request Body

Name	Type	Description
registrationNumber	string	company registration number
name	string	company name
logo	string	company logo
address*	string	company address
city	string	company city
state*	string	company state
country*	string	company country
email*	string	company email
phoneNumber	string	company phone number
customData	object	company custom data

403: Forbidden Unauthorised

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

200: OK company created successfully

409: Conflict Conflict

sample request

 {
            "organizationId": "ab3b150e-6a5d-429f-b499-f2d6ea99f668",
            "registrationNumber": "q3OnXwij90",
            "name": "test company",
            "logo": "https://res.cloudinary.com/dtui4qk9s/image/upload/v1695744841/uploads/mqfewgnixecehepqqdz6.jpg",
            "address": "Adnra crescent housing",
            "city": "Jimeta",
            "state": "Adamawa",
            "country": "Nigeria",
            "email": "[e-mail]",
            "phoneNumber": "09018031556",
            "customData": {
                "c": "17288735",
                "fr": "17288735",
                "frr": "17288735",
            }
}

sample response

Get companies

Get companies

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

Returns paginated data of all companies

Query Parameters

Name	Type	Description
page	number	page to return
perPage	number	number of items per page

Headers

Name	Type	Description
Authorization*	Bearer token	The bearer token is the API users Secret Key

403: Forbidden Unauthorised

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

200: OK Companies fetched succesfuly

sample response

{
    "responseCode": "00",
    "message": "Companies fetch successful",
    "data": [
        {
            "id": "ae80b11b-2e06-4bcd-84ac-f8398202b2d6",
            "organizationId": "a5f38f16-6c44-408f-b7ff-6775f02b83ac",
            "registrationNumber": "2367890654",
            "name": "member",
            "logo": null,
            "address": "lagos",
            "city": "Mubi",
            "state": "Adamawa",
            "country": "Nigeria",
            "email": "[e-mail]",
            "phoneNumber": "09013128631",
            "status": "inactive",
            "customData": {
                "CAC": "test",
                "new feature test": "testing"
            },
            "created_at": "2023-09-29T10:19:31.001Z",
            "updated_at": "2023-11-03T12:32:12.725Z"
        }
    ]
}

Get companies by id

Get companies by Id

GET {base url}/v1/companies? companyId={companyId}

Return single company by Id

Query Parameters

Name	Type	Description
companyId*	string	Company’s Id

Headers

Name	Type	Description
Authorization*	Bearer token	The bearer token is the API users Secret Key

403: Forbidden Unauthorised

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

200: OK company fetched successfully

sample response

{
    "responseCode": "00",
    "data": {
        "id": "ae80b11b-2e06-4bcd-84ac-f8398202b2d6",
        "organizationId": "a5f38f16-6c44-408f-b7ff-6775f02b83ac",
        "registrationNumber": "000876542345678",
        "name": "member",
        "logo": null,
        "address": "lagos",
        "city": "Mubi",
        "state": "Adamawa",
        "country": "Nigeria",
        "email": "[e-mail]",
        "phoneNumber": "09013128631",
        "status": "inactive",
        "customData": {
            "CAC": "test",
            "new feature test": "testing"
        },
        "created_at": "2023-09-29T10:19:31.001Z",
        "updated_at": "2023-11-03T12:32:12.725Z",
        "documentCount": 0,
        "depositCount": 0,
        "loanCount": 0
    }
}

Get company loans

Get company loans

GET {base url}/v1/companies/{companyId}/loans?page={page}&perPage={perPage}

Get company loans

Query Parameters

Name	Type	Description
companyId*	string	Company’s Id
page	number	page to return
perPage	number	number of items per page

Headers

Name	Type	Description
Authorization*	Bearer token	The bearer token is the API users Secret Key

403: Forbidden Unauthorised

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

200: OK Company fetched successfully

sample response

{
    "responseCode": "00",
    "message": "Loan fetch successful",
    "data": [{
        "id": "ae80b11b-2e06-4bcd-84ac-f8398202b2d6",
        "organizationId": "a5f38f16-6c44-408f-b7ff-6775f02b83ac",
        "registrationNumber": "000876542345678",
        "name": "member",
        "logo": null,
        "address": "lagos",
        "city": "Mubi",
        "state": "Adamawa",
        "country": "Nigeria",
        "email": "[e-mail]",
        "phoneNumber": "09013128631",
        "status": "inactive",
        "customData": {
            "CAC": "test",
            "new feature test": "testing"
        },
        "created_at": "2023-09-29T10:19:31.001Z",
        "updated_at": "2023-11-03T12:32:12.725Z",
        "documentCount": 0,
        "depositCount": 0,
        "loanCount": 0
    }]
}

Get company deposits

Get company deposits

GET {base url}/v1/companies/{companyId}/deposits?page={page}&perPage={perPage}

Returns paginated list of company deposits

Query Parameters

Name	Type	Description
companyId*	string	company Id
page	number	page to return
perPage	number	number of items per page

Headers

Name	Type	Description
Authorization*	Bearer token	The bearer token is the API users Secret Key

Request Body

Name	Type	Description
companyId*	string	companys Id

403: Forbidden Unauthorised

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

200: OK company deposits fetched successfully

sample response

{
    "responseCode": "00",
    "message": "deposits fetch successful",
    "data": []
}

Update company

Update company

PATCH {base url}/v1/companies?companyId={companyId}

Update company

Query Parameters

Name	Type	Description
companyId*	string	company Id

Headers

Name	Type	Description
Authorization*	Bearer token	The bearer token is the API users Secret Key

Request Body

Name	Type	Description
registrationNumber	string	company registration number
name*	string	company name
address*	string	company address
city*	string	company city
state*	string	company state
country*	string	company country
email*	string	company email
phoneNumber	string	company phone number
status*	string	company status
customData	object	company custom data

403: Forbidden Unuathorized

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

200: OK company updated successfully

406: Not Acceptable Inactive

sample request

{
          
            "registrationNumber": "q3OnXwij",
            "name": "Opay",
            "logo": "https://res.cloudinary.com/dtui4qk9s/image/upload/v1701792271/uploads/fe3kg0frlrft4ve1np7t.jpg",
            "address": "Adnra crescent housing",
            "city": "Jimeta",
            "state": "Adamawa",
            "country": "Nigeria",
            "email": "[e-mail]",
            "phoneNumber": "09018031556",
            "status": "active",
            "customData": {
                "c": "17288735",
                "fr": "17288735",
                "frr": "17288735"
            }
}

sample response

Delete company

Delete company

DELETE {base url}/v1/companies?companyId={companyId}

Delete a single company

Query Parameters

Name	Type	Description
companyId*	string	company Id

Headers

Name	Type	Description
Authorization*	Bearer token	The bearer token is the API users Secret Key

403: Forbidden Unauthorised

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

200: OK company successfully deleted

sample response

{
    "message": "Company deleted successfully",
    "code": 00
}

Search companies

Search company

GET {base url}/v1/companies?search={search}

Search company

Query Parameters

Name	Type	Description
search*	string	search term

Headers

Name	Type	Description
Authorization	Bearer token	The bearer token is the API users Secret Key

403: Forbidden Unauthorised

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

200: OK Clients fetched successfully

sample response

{
    "responseCode": "00",
    "message": "Companies fetch successful",
    "data": [
        {
            "id": "ae80b11b-2e06-4bcd-84ac-f8398202b2d6",
            "organizationId": "a5f38f16-6c44-408f-b7ff-6775f02b83ac",
            "registrationNumber": "2367890654",
            "name": "member",
            "logo": null,
            "address": "lagos",
            "city": "Mubi",
            "state": "Adamawa",
            "country": "Nigeria",
            "email": "[e-mail]",
            "phoneNumber": "09013128631",
            "status": "inactive",
            "customData": {
                "CAC": "test",
                "new feature test": "testing"
            },
            "created_at": "2023-09-29T10:19:31.001Z",
            "updated_at": "2023-11-03T12:32:12.725Z"
        }
    ]
}