List businesses

Endpoint

GET /clients/business

Headers

string

required

Your public API key.

string

required

Your API secret. Use a stl_test_... value in sandbox, stl_live_... in production.

string

required

Your business ID.

Query parameters

integer

Page number. Defaults to 1.

integer

Records per page. Defaults to 20.

See Pagination for full usage.

Response

boolean

true on success.

string

Human-readable outcome.

array

Array of business objects.

string

Unique business ID.

string

The business’s registered name.

string

Bank Verification Number associated with the business.

string

URL to the uploaded photo ID document.

array

Array of URLs to uploaded business documents.

boolean

true if the business has been approved by Interstellas.

string

The registered residential address.

string

ID of the state where the business is located.

object

State object containing id and name.

string

The client account this business belongs to.

integer

The current page number.

integer

The page size used for this response.

integer

Total number of records matching the current query, across all pages.

integer

The final page number, derived from total ÷ limit. See Pagination — this endpoint uses Shape B.

Code examples

curl -X GET "https://sandbox.stellasbank.com/api/v1/clients/business?page=1&limit=10" \
  -H "x-api-key: stl_c8e286ca55b0123e0b05da047494f585" \
  -H "x-api-secret: stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0" \
  -H "businessId: YOUR_BUSINESS_ID"

const res = await fetch(
  "https://sandbox.stellasbank.com/api/v1/clients/business?page=1&limit=10",
  {
    headers: {
      "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
      "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
      businessId: "YOUR_BUSINESS_ID",
    },
  }
);
const { data, pagination } = await res.json();

import requests

res = requests.get(
    "https://sandbox.stellasbank.com/api/v1/clients/business",
    headers={
        "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
        "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
        "businessId": "YOUR_BUSINESS_ID",
    },
    params={"page": 1, "limit": 10},
)
print(res.json())

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": {
    "page": 1,
    "limit": 20,
    "total": 3,
    "totalPages": 1
  }
}

Overview

Members

Business

Virtual accounts

Funds

Bulk transfers

Disputes

Subscriptions

Payouts

Audit logs

Settings

Endpoint

Headers

Query parameters

Response

Code examples

Example response

​Endpoint

​Headers

​Query parameters

​Response

​Code examples

​Example response

Endpoint

Headers

Query parameters

Response

Code examples

Example response