Errors

All Alida APIs return a common error object if the request fails.

Error response format

{
   "status": <integer>,
   "message": <string>,
   "developerMessage": <string>,
   "errorId": <GUID>
}

In the example above:

Property Description
status The HTTP response code.
message A user-friendly message that could potentially be displayed in the UI.
developerMessage A developer-friendly message that displays more information useful for debugging purposes. This value may be null.
errorId A unique identifier that can be useful in tracking down issues with Technical Support.