Tasks

Remote Task Signing

Apply signatures and complete tasks programmatically without the AlphaTrust e-Sign workflow interface.

Quick Reference

Required Parameters

  • ID - Task identifier
  • IpAddress - 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 Password property with the clear-text password
  • System validates against the participant's configured password

Registered User Authentication

For registered user authentication:

  • Set both Username and Password properties
  • 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 ApplicationType is set to Registered
  • 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