Search docs

API Response Standard

External APIs return a predictable envelope for successful and failed requests.

Success

json

{
  "status": "success",
  "data": {},
  "error": null
}

Service Success

json

{
  "statusCode": 200,
  "success": true,
  "message": "Successfully retrieved company data by RC number.",
  "data": {}
}

Standard Error

json

{
  "statusCode": 403,
  "success": false,
  "code": "TBH_SERVICE_ACCESS_DISABLED",
  "message": "API key does not have access to this service.",
  "requestId": "0HN..."
}