Error message enhancements (May 18, 2023)

Our error responses now support the ability to include debugging information as defined in FDX 5.1 (RFC 01870). This enhancement adds a new element, debugMessage, to the error entity. What does this mean for you? In the coming months, we'll be rolling out debug messages where they are supported from providers. This debug information will be included to help you troubleshoot any issues you may experience.

When debugMessage is available, the error entity will be returned as in the following example:

{
  "code": 602,
  "message": "Customer not authorized",
  "debugMessage": "Not entitled to get Customer Information"
}

element	type	description
code	integer	Required. Akoya returns the error code as an integer rather than a string (as specified by FDX). The code is a long term persistent identifier which can be used to trace error conditions back to log information.
message	string	Required. This message is end-user displayable information which may aid in diagnosis and error reporting.
debugMessage	string	Not required. Message used to debug the root cause of the error. Contents should not be used in business logic. These messages may change at any time and should only be used for troubleshooting an issue.

For more, refer to our error code guide.