In the Sovos Signer API, a transaction occurs when you create an envelope or sign a document.

A transaction occurs in two scenarios:

• Envelope creation: The issuer creates an envelope and the API immediately returns the envelope details, confirming the transaction.

• Document signing: Each time a participant signs a document within an envelope, the API records an additional transaction.

The Signer API supports PDF documents encoded in Base64 format (application/pdf).

The Signer API requires documents to be Base64-encoded. Base64 encoding converts binary data into a text format represented as ASCII characters. This encoding enables the API to handle document data within JSON payloads, which don't natively support binary content.

Sovos returns standard HTTP response codes to indicate the outcome. Use these codes to troubleshoot integration issues.

The API uses these HTTP response codes categories:

200 range: Success

These codes indicate your request succeeded.

400 range: Client error

These codes indicate an error in the data you sent

500 range: Server error

These codes indicate a Sovos server or network issue.

Each API response includes the HTTP status code. Errors include additional details in the JSON response body.

{
  "error": "invalid_request",
  "error_description": "Missing required parameter: client_id"
}