Get eTIMS Business Info

GET/api/v1/etims-info

Returns eTIMS configuration for your organisation, taxpayer PIN, branch ID, device serial, environment, and readiness (isReady requires device initialization via POST /api/v1/initialize).

Requires x-api-key

http://localhost:8100/api/v1/etims-info

Response Fields

Field	Type	Required	Description
tin	string	Optional	Taxpayer PIN (TAXPAYER_PIN env var).
branchId	string	Optional	Branch ID (BRANCH_ID env var, default 00).
deviceSerial	string	Optional	Device serial number (DEVICE_SERIAL env var) or null if not set.
environment	string	Optional	Current Kenya Revenue Authority environment: 'sandbox' or 'production'.
kraEndpoint	string	Optional	Base URL for Kenya Revenue Authority eTIMS API calls.
sdcId	string	Optional	SDC identifier (SDC_ID env var) or null.
mrcNo	string	Optional	MRC number (MRC_NO env var) or null.
dvcId	string	Optional	Device ID (DVC_ID env var) or null.
adapter	string	Optional	Storage adapter in use: 'env' (Vercel) or 'file' (local).
isReady	boolean	Optional	Whether the service has valid credentials and is ready to submit to Kenya Revenue Authority.

Response

{
  "success": true,
  "data": {
    "tin": "A000000000Z",
    "branchId": "00",
    "deviceSerial": "SN12345678",
    "environment": "sandbox",
    "kraEndpoint": "https://etims-api-sbx.kra.go.ke/etims-api",
    "sdcId": null,
    "mrcNo": null,
    "dvcId": null,
    "adapter": "env",
    "isReady": true
  }
}

curl http://localhost:8100/api/v1/etims-info \\
  -H "x-api-key: YOUR_API_KEY"