Get a transaction by ID
Method: GET
Path: /api/transaction/{transactionId}
Retrieve transaction details including signers, receivers, files, and current status.
Do not use this method for active polling. Use the postback service instead.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| transactionId | path | string | Yes | The transaction ID to retrieve |
Responses
200
Transaction retrieved successfully
Content-Type: application/json
Schema: Transaction
Properties
| Name | Type | Description |
|---|---|---|
| Id | String | Unique transaction identifier |
| Seal | Boolean | Whether the transaction is sealed (no signers required) |
| Reference | String | Custom reference identifier |
| PostbackUrl | String | Webhook URL for status notifications |
| DaysToExpire | Integer | Days until the transaction expires. |
| SendEmailNotifications | Boolean | Send e-mail notifications to the sender. |
| SignRequestMode | enum:
| Sign request delivery mode
|
| Language | enum:
| Language code for the Sender email notifications, and transaction receipt. |
| Status | enum:
| Current transaction status:
|
| Context | Object | Custom JSON object for additional transaction metadata that was provided during creation. |
| CreatedDateTime | String | When the transaction was created |
| ModifiedDateTime | String | When the transaction was last modified |
| CanceledDateTime | String | When the transaction was cancelled, if applicable |
| Files | Object | Files attached to the transaction as a key-value mapping. Key is the file ID, value is the file information. |
| Signers | Array<Signer> | List of signers attached to this transaction, including their configuration, current status, verification methods, and signing progress. Each signer represents an individual who needs to sign the document or has already completed the signing process. |
| Receivers | Array<Receiver> | List of receivers who will receive copies of the completed signed documents. Receivers are notified via email once the transaction is successfully completed and all required signatures have been obtained. |
| CancelationReason | String | The reason for the cancellation of the transaction, if applicable. This is provided when the transaction is cancelled via the DELETE endpoint. |
401
Unauthorized - user not owner of transaction
Content-Type: application/json
Schema: ErrorResponse
Properties
| Name | Type | Description |
|---|---|---|
| Message | String | Required. Human-readable error message |
Example:
410
The transaction details are no longer available and as a result the returned JSON only contains partial historical data. This happens when the system cleaned the transaction for example due to reaching an end status (any status above 30) or the transaction has expired.
Content-Type: application/json
Schema: Transaction
Properties
| Name | Type | Description |
|---|---|---|
| Id | String | Unique transaction identifier |
| Seal | Boolean | Whether the transaction is sealed (no signers required) |
| Reference | String | Custom reference identifier |
| PostbackUrl | String | Webhook URL for status notifications |
| DaysToExpire | Integer | Days until the transaction expires. |
| SendEmailNotifications | Boolean | Send e-mail notifications to the sender. |
| SignRequestMode | enum:
| Sign request delivery mode
|
| Language | enum:
| Language code for the Sender email notifications, and transaction receipt. |
| Status | enum:
| Current transaction status:
|
| Context | Object | Custom JSON object for additional transaction metadata that was provided during creation. |
| CreatedDateTime | String | When the transaction was created |
| ModifiedDateTime | String | When the transaction was last modified |
| CanceledDateTime | String | When the transaction was cancelled, if applicable |
| Files | Object | Files attached to the transaction as a key-value mapping. Key is the file ID, value is the file information. |
| Signers | Array<Signer> | List of signers attached to this transaction, including their configuration, current status, verification methods, and signing progress. Each signer represents an individual who needs to sign the document or has already completed the signing process. |
| Receivers | Array<Receiver> | List of receivers who will receive copies of the completed signed documents. Receivers are notified via email once the transaction is successfully completed and all required signatures have been obtained. |
| CancelationReason | String | The reason for the cancellation of the transaction, if applicable. This is provided when the transaction is cancelled via the DELETE endpoint. |
500
Internal server error
Content-Type: application/json
Schema: ErrorResponse
Properties
| Name | Type | Description |
|---|---|---|
| Message | String | Required. Human-readable error message |