Response Format
All API responses use a unified JSON wrapper format.
Unified Response Structure
{
"Response": {
"RequestId": "abc123",
"Error": null,
"Data": { ... }
}
}Response Fields
RequestIdstring
Unique request identifier for troubleshooting. Returned with every request
Errorobject | null
Error information. Null on success
Codestring
Error code, e.g. INVALID_REQUEST
Messagestring
Error description
Dataobject | null
Business data. Null on error
Success Response Example
{
"Response": {
"RequestId": "req-abc123",
"Error": null,
"Data": {
"EnvelopeId": "SGEVa1b2c3d4e5f6",
"Status": "sent"
}
}
}Error Response Example
{
"Response": {
"RequestId": "req-abc123",
"Error": {
"Code": "INVALID_REQUEST",
"Message": "Title is required"
},
"Data": null
}
}