Get business details

Endpoint

GET /clients/business/details

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

The ID of the business whose details you want to retrieve.

Response

boolean

true on success.

string

Human-readable outcome.

object

Business details object.

string

Unique business ID.

string

Registered business name.

string

Bank Verification Number.

string

URL to the uploaded photo ID.

array

URLs of uploaded business documents.

boolean

true if the business has been approved.

string

Registered residential address.

string

State ID.

object

State object with id and name.

string

The client account this business belongs to.

Code examples

curl -X GET https://sandbox.stellasbank.com/api/v1/clients/business/details \
  -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/details",
  {
    headers: {
      "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
      "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
      businessId: "YOUR_BUSINESS_ID",
    },
  }
);
const { data } = await res.json();

import requests

res = requests.get(
    "https://sandbox.stellasbank.com/api/v1/clients/business/details",
    headers={
        "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
        "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
        "businessId": "YOUR_BUSINESS_ID",
    },
)
print(res.json()["data"])

Example response

{
  "status": true,
  "message": "Business details 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"
  }
}

Overview

Members

Business

Virtual accounts

Funds

Bulk transfers

Disputes

Subscriptions

Payouts

Audit logs

Settings

Endpoint

Headers

Response

Code examples

Example response

​Endpoint

​Headers

​Response

​Code examples

​Example response

Endpoint

Headers

Response

Code examples

Example response