Integration Guide
Retrieve CAC information and shareholder details.
Overview
Our CAC Lookup Integration Guide provides developers with step-by-step instructions on how to integrate the CAC (Corporate Affairs Commission) lookup service into their applications. This guide covers two main functionalities:
- Looking up business/company information and,
- Retrieving shareholder details.
By following this guide, developers can seamlessly integrate these features and access relevant data for business verification and analysis purposes.
Prerequisites
To get started, please ensure to:
Step 1: Look up a Business
To retrieve CAC information pertaining to a business or company, send a GET request to the following endpoint:
GET https://api.withmono.com/v1/cac/lookup?name={company_name_or_rc_number}
Request Query Parameter
name
(required): Specify the name or RC number of the company you want to look up.
Include this parameter in the query string to indicate the name or RC number of the company you wish to retrieve information.
Request Headers
Include the following header in your request for authentication:
mono-sec-key
(required): Your Mono secret key.
cURL Sample Request
curl -X GET \
-H "mono-sec-key: YOUR_MONO_SECRET_KEY" \
"https://api.withmono.com/v1/cac/lookup?name=company_name_or_rc_number"
Successful Response
If the lookup request is successful, you will receive the following response:
{
"status": "successful",
"message": "Cac lookup successful",
"data": [
{
"state": null,
"id": 1234567,
"address": "No 987, Adam Estate",
"status": "ACTIVE",
"code": "101",
"branchAddress": null,
"classificationId": 2,
"email": "[email protected]",
"companyStatus": "INACTIVE",
"lga": null,
"rcNumber": "7654321",
"city": null,
"approvedName": "ADAMU AND ADAM LIMITED",
"registrationDate": "2019-09-06T11:10:41.063+00:00"
}
]
}
The response contains the message "Cac lookup successful" along with an array of objects representing the CAC information for the company.
Step 2: Shareholder Details
To retrieve shareholder information associated with a business or company, send a GET request to the following endpoint:
GET https://api.withmono.com/v1/cac/company/{id}
Request Path Parameter
id
(required): Provide the ID returned from the business lookup response.
Include this parameter in the URL path to specify the ID of the business or company for which you want to retrieve shareholder details.
Request Headers
Include the following header in your request for authentication:
mono-sec-key
(required): Your Mono secret key.
cURL Sample Request
curl -X GET \
-H "mono-sec-key: YOUR_MONO_SECRET_KEY" \
"https://api.withmono.com/v1/cac/company/{id}"
Successful Response
If the shareholder details request is successful, you will receive the following response:
{
"shareholder": [
{
"entityType": "individual",
"name": "ADAMU ZUBAIR",
"role": "SHAREHOLDER",
"details": {
"id": 12356,
"address": "23 SHITTU ANIMASHAUN",
"city": "LAGOS",
"residence": "NIGERIA",
"gender": "male",
"nationality": "Nigerian",
"occupation": "",
"shares": 100000,
"status": "ACTIVE",
"email": "",
"phone": "",
"dob": "1992-05-11",
"identityType": "Driver's license",
"identityNumber": "000000000"
}
},
{
"entityType": "individual",
"name": "BUHARI MAJEED",
"role": "SHAREHOLDER",
"details": {
"id": 12356,
"address": "23 SHITTU ANIMASHAUN",
"city": "LAGOS",
"residence": "INDIA",
"gender": "male",
"nationality": "Indian",
"occupation": "",
"shares": 100000,
"status": "ACTIVE",
"email": "",
"phone": "",
"dob": "1992-05-11",
"identityType": "Passport",
"identityNumber": "000000000"
}
}
]
}
The response contains an array of objects representing the shareholder details associated with the business or company.
Updated 2 months ago