Companies
Create company
Create company
POST
{base url}/v1/companies
Create company
Headers
Authorization*
Bearer token
The bearer token is the API users Secret Key
Request Body
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
{
"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": "test.emaillj89e@6xh.com",
"phoneNumber": "09018031556",
"customData": {
"c": "17288735",
"fr": "17288735",
"frr": "17288735",
}
}
Get companies
Get companies
GET
{base url}/v1/companies?page={page}&perPage={perPage}
Returns paginated data of all companies
Query Parameters
page
number
page to return
perPage
number
number of items per page
Headers
Authorization*
Bearer token
The bearer token is the API users Secret Key
{
"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": "toheeb.rauf@oobla.io",
"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
companyId*
string
Company’s Id
Headers
Authorization*
Bearer token
The bearer token is the API users Secret Key
{
"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": "toheeb.rauf@oobla.io",
"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
companyId*
string
Company’s Id
page
number
page to return
perPage
number
number of items per page
Headers
Authorization*
Bearer token
The bearer token is the API users Secret Key
{
"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": "toheeb.rauf@oobla.io",
"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
companyId*
string
company Id
page
number
page to return
perPage
number
number of items per page
Headers
Authorization*
Bearer token
The bearer token is the API users Secret Key
Request Body
companyId*
string
companys Id
{
"responseCode": "00",
"message": "deposits fetch successful",
"data": []
}
Update company
Update company
PATCH
{base url}/v1/companies?companyId={companyId}
Update company
Query Parameters
companyId*
string
company Id
Headers
Authorization*
Bearer token
The bearer token is the API users Secret Key
Request Body
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
{
"message": "unauthorized",
"code": 92
}
{
"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": "test.emaillje@6xh.com",
"phoneNumber": "09018031556",
"status": "active",
"customData": {
"c": "17288735",
"fr": "17288735",
"frr": "17288735"
}
}
Delete company
Delete company
DELETE
{base url}/v1/companies?companyId={companyId}
Delete a single company
Query Parameters
companyId*
string
company Id
Headers
Authorization*
Bearer token
The bearer token is the API users Secret Key
{
"message": "Company deleted successfully",
"code": 00
}
Search companies
Search company
GET
{base url}/v1/companies?search={search}
Search company
Query Parameters
search*
string
search term
Headers
Authorization
Bearer token
The bearer token is the API users Secret Key
{
"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": "toheeb.rauf@oobla.io",
"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"
}
]
}
Last updated
Was this helpful?