Skip to main content

​
Endpoint

GET /clients/business

​
Headers

​
Authorization
string
required
Bearer YOUR_ACCESS_TOKEN
​
SECRET_KEY
string
required
Your API secret key.
​
businessId
string
required
Your business ID.

​
Query parameters

​
page
integer
Page number. Defaults to 1.
​
limit
integer
Records per page. Defaults to 10.
See Pagination for full usage.

​
Response

​
status
boolean
true on success.
​
message
string
Human-readable outcome.
​
data
array
Array of business objects.
​
data[].id
string
Unique business ID.
​
data[].businessName
string
The business’s registered name.
​
data[].bvn
string
Bank Verification Number associated with the business.
​
data[].photoIdUrl
string
URL to the uploaded photo ID document.
​
data[].businessDocumentsUrls
array
Array of URLs to uploaded business documents.
​
data[].isApproved
boolean
true if the business has been approved by Interstellas.
​
data[].residentialAddress
string
The registered residential address.
​
data[].stateId
string
ID of the state where the business is located.
​
data[].state
object
State object containing id and name.
​
data[].clientId
string
The client account this business belongs to.
​
pagination
object
Standard pagination envelope. See Pagination.

​
Code examples

curl -X GET "https://sandbox.stellasbank.com/api/v1/clients/business?page=1&limit=10" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "SECRET_KEY: YOUR_SECRET_KEY" \
  -H "businessId: YOUR_BUSINESS_ID"

​
Example response

{
  "status": true,
  "message": "Businesses retrieved successfully",
  "data": [
    {
      "id": "biz_xyz789",
      "businessName": "Acme Ltd",
      "bvn": "12345678901",
      "photoIdUrl": "https://storage.example.com/photo-id.jpg",
      "businessDocumentsUrls": ["https://storage.example.com/doc1.pdf"],
      "isApproved": true,
      "residentialAddress": "12 Marina Street, Lagos",
      "stateId": "state_01",
      "state": { "id": "state_01", "name": "Lagos" },
      "clientId": "client_001"
    }
  ],
  "pagination": {
    "totalCount": 3,
    "hasNextPage": false,
    "hasPreviousPage": false,
    "nextPage": 0,
    "previousPage": 0,
    "limit": 10,
    "lastPage": 1
  }
}