Skip to main content

​
Endpoint

GET /clients/business/details

​
Headers

​
Authorization
string
required
Bearer YOUR_ACCESS_TOKEN
​
SECRET_KEY
string
required
Your API secret key.
​
businessId
string
required
The ID of the business whose details you want to retrieve.

​
Response

​
status
boolean
true on success.
​
message
string
Human-readable outcome.
​
data
object
Business details object.
​
data.id
string
Unique business ID.
​
data.businessName
string
Registered business name.
​
data.bvn
string
Bank Verification Number.
​
data.photoIdUrl
string
URL to the uploaded photo ID.
​
data.businessDocumentsUrls
array
URLs of uploaded business documents.
​
data.isApproved
boolean
true if the business has been approved.
​
data.residentialAddress
string
Registered residential address.
​
data.stateId
string
State ID.
​
data.state
object
State object with id and name.
​
data.clientId
string
The client account this business belongs to.

​
Code examples

curl -X GET https://sandbox.stellasbank.com/api/v1/clients/business/details \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "SECRET_KEY: YOUR_SECRET_KEY" \
  -H "businessId: YOUR_BUSINESS_ID"

​
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"
  }
}