Status Codes

Error Response Body

The error response is returned whenever a request to the bizAPIs API cannot be completed successfully.
It provides information about what went wrong, where the error originated, and a human-readable explanation. This structure is designed to be machine-readable for automated handling and human-readable for troubleshooting.

🔔 Migration Guide: New Enhanced Error Response Structure

What's Changing

We're introducing a new structured error response format across all bizAPIs endpoints to improve debugging, monitoring, and support experiences.

Before (Old Format)

{
  "message": "Document not found"
}

After (New Format)

{
  "requestId": "9e12f4b8-7d4f-4a9f-b832-5c614e86d5aa",
  "errorCode": 4099,
  "errorName": "DOCUMENT_NOT_FOUND",
  "fullStatusCode": "4099.0008.0002",
  "timestamp": "2025-08-13T16:37:53.037939200Z",
  "message": "Document not found"
}

Why This Matters

✅ Faster Support - Share the requestId with our team to instantly locate your request in our logs
✅ Better Debugging - The fullStatusCode tells you exactly what failed, in which service, and from where
✅ Programmatic Handling - Use errorCode or errorName for consistent error handling across your application
✅ Audit Trail - timestamp helps you correlate errors with your own logs

Breaking Changes

⚠️ Action Required:

1. Response Structure Changed - Error responses now return a structured JSON object with new fields
2. Error Message Difference - Some messages may have changed in order to standardized across all services

When contacting support, always include:

• The requestId from the error response
• The fullStatusCode if available
• Timestamp of when the error occurred
• What you were trying to accomplish

Fields

UnderstandingfullStatusCode

The fullStatusCode provides a structured way to trace errors:

[errorCode].[serviceCode].[originCode]

• errorCode → Maps to the main error type (see Error Codes Table below).
• serviceCode → Identifies which internal bizAPIs service was involved (see Service Codes Table below).
• originCode → Identifies the origin of the request or error trigger (see Origin Codes Table below).

Example:

4099.0008.0002

• 4099 → DOCUMENT_NOT_FOUND
• 0008 → cpp-service
• 0002 → Originated from PORTAL

Error Codes

1. Authentication & Login Failures (0–2048)

2. Data Extraction & Processing Failures (2049–4096)

3. Resource Not Found or Unavailable (4097–6144)

4. Timeout & Page Load Issues (6145–8192)

5. Input Validation & Formatting Errors (8193–10240)

Service Codes

Origin Codes