Skip to main content
GET
Get the business

Authorizations

Authorization
string
header
required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

X-Request-Id
string

Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always our own req_… id. We log your value with the request as client_request_id, so support can find a request by either id. A longer value is refused with 400 parameter_invalid.

Maximum string length: 128

Response

OK.

The business the caller acts for (/v1/businesses/me).

id
string
required

Business id.

Pattern: ^biz_[0-9A-HJKMNP-TV-Z]{26}$
object
string
required

Always business.

Allowed value: "business"
created_at
string<date-time>
required

When it was created.

Example:

"2026-10-27T08:41:00Z"

updated_at
string<date-time>
required

When it was created.

Example:

"2026-10-27T08:41:00Z"

status
enum<string>
required

onboarding: application not approved yet; sandbox only ("in review" dashboard).

Available options:
onboarding,
active,
frozen,
declined,
closed

Legal name from the CAC record. Null until the registration is confirmed.

registration
object | null
required

"From the CAC record · Locked". Null until confirmed in onboarding.

reporting_currency
enum<string>
required

Currency the total balance is shown in. Naira while it is the only currency.

Available options:
NGN,
USD,
GBP,
EUR,
GHS,
KES
application_id
string
required

The onboarding application (app_…).

Pattern: ^app_[0-9A-HJKMNP-TV-Z]{26}$
trading_name
string | null

Trading name shown to customers.

Maximum string length: 100
industry
enum<string> | null

Industry from onboarding.

Available options:
logistics,
software,
retail,
manufacturing,
real_estate,
hospitality,
construction,
legal,
accounting,
non_profit,
other
operating_address
string | null

Where the business operates, if different from the registered address.

Maximum string length: 300
website
string | null

Website or social page, without scheme allowed ("adaezelogistics.ng").

Maximum string length: 200
support_email
string<email> | null

Support email shown to the business's customers on invoices, receipts and payment links.

Maximum string length: 254
logo_document_id
string | null

Logo (doc_…, purpose business_logo) shown on invoices, receipts and payment links.

Pattern: ^doc_[0-9A-HJKMNP-TV-Z]{26}$
tin
string | null

Tax identification number. Collected after approval.

Maximum string length: 20
approved_at
string<date-time> | null

When the business was approved.