Response Format

The documented successful response pattern and how to read its fields.

The pattern

Documented successful responses follow a consistent envelope:

JSON

{
  "success": true,
  "request_id": "...",
  "timestamp": "...",
  "data": {}
}

Fields

Field	Description
success	Whether the request succeeded.
request_id	API request / correlation identifier. Log it and include it when contacting support.
timestamp	API response timestamp.
data	The endpoint-specific payload.

The data payload

data is endpoint-specific and may be an object or an array. For example:

Create Signature Request returns a data object with package_id, package_guid and more.
List Templates and List Categories return a data array of records.

See each endpoint page for its exact data fields.

The failure envelope

Failed responses use the same envelope with success: false and an error object instead of data:

JSON

{
  "success": false,
  "request_id": "...",
  "timestamp": "...",
  "error": {
    "code": "TEMPLATE_NOT_FOUND",
    "message": "Template not found",
    "details": []
  }
}

Always check error.code, not just the HTTP status, to determine what went wrong. See Error Handling for the full code reference.

Error Handling

Handle failures appropriately.

Request Headers

Headers used by documented requests.