Profile

Tenant profile operations

Get tenant profile

get

/api/v1

/tenant/profile

Retrieve tenant profile information

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Responses

200

Successfully retrieved tenant profile with currency and metadata

application/json

idstringOptional

Unique identifier for the tenant

Example: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d

namestringOptional

Tenant name

Example: Minit Money South Africa

currencyNamestringOptional

Currency name

Example: South African Rand

currencyCodestringOptional

ISO 4217 currency code

Example: ZAR

createdAtstring · date-timeOptional

Timestamp when tenant was created

updatedAtstring · date-timeOptional

Timestamp when tenant was last updated

404

Tenant not found

get

/tenant/profile

HTTPcURLJavaScriptPython

GET /api/v1/tenant/profile HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "uid": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "name": "Minit Money South Africa",
  "currencyName": "South African Rand",
  "currencyCode": "ZAR",
  "createdAt": "2025-01-15T08:00:00.000Z",
  "updatedAt": "2025-11-17T10:30:00.000Z"
}