SignWell · Schema

ErrorResponse

Standard error response

E-SignatureElectronic SignatureDocumentsPDFSigningTemplatesWorkflowsHIPAASOC2

Properties

Name	Type	Description
message	string	Human-readable error message
meta	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/signwell/main/json-schema/ErrorResponse.json",
  "title": "ErrorResponse",
  "type": "object",
  "description": "Standard error response",
  "properties": {
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "meta": {
      "type": "object",
      "properties": {
        "error": {
          "type": "string",
          "description": "Error code identifier"
        },
        "message": {
          "type": "string",
          "description": "Detailed error message"
        },
        "messages": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "List of error messages"
        }
      },
      "required": [
        "error",
        "message"
      ]
    }
  }
}