Remote Task Signing
Apply signatures and complete tasks programmatically without the AlphaTrust e-Sign workflow interface.
Quick Reference
Required Parameters
ID- Task identifierIpAddress- Client IP address for audit trail
Authentication Parameters (when required)
- Password Auth:
Password(clear text) - Registered User Auth:
Username+Password
Supported Task Types
Signature • Initial • Acknowledgement • Delivery • NoActionRequired
Overview
Remote signing allows you to complete any task type programmatically, bypassing the standard AlphaTrust e-Sign user interface. This is ideal for:
- Automated workflows where user interaction isn't needed
- Backend processing of pre-approved documents
- Bulk operations on multiple tasks
- Custom signing experiences within your application
Basic Implementation
var req = new TaskRemoteSignRequestModel()
{
Tasks = new List<object>
{
new TaskRemoteSignModel()
{
ID = 1234567890, // Required: Task ID
IpAddress = "123.45.67.890", // Required: Client IP
//Password = "p@ssword123", // Optional: For password auth
//Username = "johnsmith" // Optional: For registered user auth
}
}
};
var api = new TasksApi(myRestEndpointUrl);
var results = api.RemoteSign(req, apiKey, apiSecret, apiUsername, apiPassword);
if (results.IsSuccessful.Value)
{
// Task completed successfully
// Check results for completion details
}
else
{
// Handle authentication or validation errors
var error = results.Message;
}
Authentication Details
No Authentication Required
Most tasks can be completed without additional authentication if the workflow doesn't require it.
Password Authentication
When a task requires password authentication:
- Set the
Passwordproperty with the clear-text password - System validates against the participant's configured password
Registered User Authentication
For registered user authentication:
- Set both
UsernameandPasswordproperties - User must exist in the AlphaTrust system
- Credentials are validated against the user database
Authentication Support: Only Password, PasswordHashed, and RegisteredUser authentication types are supported for remote signing.
Visual Signatures
When using registered user authentication, visual signature behavior depends on the participant configuration:
- If the registered user has a signature image stored in their profile
- AND the Participant Signature's
ApplicationTypeis set toRegistered - THEN their stored signature image will be applied to the document
Pro Tip: Use registered users for consistent signature appearances across documents, especially for frequent signers or executive signatures.
Error Handling
Handle errors by checking the response status and examining error details:
if (!results.IsSuccessful.Value)
{
// Check the error message for details
var errorMessage = results.Message;
// Log the error for debugging
Console.WriteLine($"Remote signing failed: {errorMessage}");
// Common scenarios to handle:
// - Invalid or missing authentication credentials
// - Task ID doesn't exist or isn't accessible
// - Task was already completed
// - Network or API connectivity issues
// - Insufficient permissions
}
Best Practices
- Always validate task status before attempting remote signing
- Log IP addresses for comprehensive audit trails
- Handle authentication errors gracefully with clear user feedback
- Batch multiple tasks in a single request when possible for better performance
- Limit batched tasks to a single transaction to make sure you don't experience request timeouts
- Verify completion by checking the response status and any returned data
Managing Tasks
When you create a new Transaction, you are required to include at least one Document, one Participant, and one Task per Document/Participant. However, after the Transaction is created, you can add new Tasks or update existing Tasks via the API at any point as long as the transaction is still in the Pending status.
Workflows Overview
A Workflow is a flexible set of steps that orchestrate the completion of paperwork. Within a Workflow you define a set of documents, participants who need to work with those documents, and tasks they need to perform on the documents (i.e. fill a form, approve, sign, etc.). A Workflow has many options to meet a wide variety of needs, and those options may be applied differently for different documents, participants, or tasks. The output of a launched Workflow is called a Transaction. A completed Transaction is a document, or set of documents, finalized in accordance with your compliance and security needs. You can create a Workflow in the AlphaTrust Control Panel (yourdomain.com/cp/) and the access it, inject data into it, and launch it via the API.