Errors

Sivo returns standard HTTP standard codes to indicate if a request succeeded. When the status code of a response is 4xx, this indicates an error with the request itself. For these errors Sivo may also return additional details in the body of the response. These details are returned as a json error object that includes the following properties:

Property	Description
message	A human-readable error message explaining the problem.
param	The value from the request that caused the error.
details	Additional information that is specific to the error.

For example, confirming a document before its file was uploaded returns 400 Bad Request with:

{
  "message": "the document file has not been uploaded yet",
  "param": { "id": "doc-0001" }
}

message is meant for developers and logs — the wording may change over time, so branch on the status code (see Status Codes), not on message text.

In addition, response headers include other tracing ids. If additional help is required, please provide these identifiers to Sivo support.