Secure Exchanges SDK - Documentation

Welcome to the official documentation for the Secure Exchanges SDK.

What is Secure Exchanges SDK?

Secure Exchanges SDK is a comprehensive .NET library for secure message exchange, file encryption, and electronic signatures. It enables you to:

  • Send encrypted messages via email or SMS
  • Transfer files up to 2.5 GB with end-to-end encryption
  • Sign PDF documents electronically
  • Track delivery and message opening
  • Integrate secure communications into your applications

SDK Components

SecureExchangesSDK (Main)

The main SDK provides all core functionality:

Class Description
MessageHelper Send and retrieve messages
CryptoHelper Encryption/decryption operations
SignHelper Digital signature operations
LicenceHelper License management
LogsHelper Logging and audit
MessengingHelper SESAR workflows

SecureExchangesSignatureSDK

Complementary SDK for advanced PDF certification with PKI:

Class Description
PkiFileHelper PDF certification engine
CertifyPdfArgs Certification parameters
ZoneDetails Signature zone definitions

Quick Start

1. Installation

Choose the package that matches your target framework:

Target framework Main SDK Signature SDK (optional)
.NET Framework 4.7.2+ (Windows only) SecureExchanges SecureExchanges.Signature
.NET 8+ (Windows + Linux) SecureExchanges.NetCore SecureExchanges.Signature.NetCore 
# .NET Framework — main SDK
Install-Package SecureExchanges

# .NET 8+ / .NET Core — main SDK
Install-Package SecureExchanges.NetCore
Note

The .NetCore variant is required to deploy on Linux (e.g. Azure Functions Linux containers). See PDF Certification and Azure Functions Deployment.

2. Minimal Configuration

// Your API credentials (obtained via the Secure Exchanges portal)
Guid serial = new Guid("YOUR-SERIAL");
Guid apiUser = new Guid("YOUR-API-USER");
Guid apiPassword = new Guid("YOUR-API-PASSWORD");
Uri endpoint = new Uri("https://www.secure-exchanges.com/_api/0217/0217.asmx");

3. First Message

using SecureExchangesSDK.Helpers;
using SecureExchangesSDK.Models.Args;
using SecureExchangesSDK.Models.Entity;

// Create recipient list
var recipients = new List<RecipientInfo>
{
    new RecipientInfo { Email = "recipient@example.com" }
};

// Configure arguments
var args = new MutliRecipientArgs(
    endpoint, serial, apiUser, apiPassword,
    recipients,
    message: "Your secure message",
    subject: "Message subject",
    password: null,
    filesList: null,
    SendMethodEnum.onlyEmail,
    sendByMyOwnSMTPServer: false,
    showSubject: true,
    getNotify: true,
    culture: "en-CA",
    maxOpeningTime: 5,
    expirationMinutes: 1440 // 24 hours
);

// Send the message
var response = MessageHelper.MultiRecipientMessage(args);

if (response.Status == 200)
{
    Console.WriteLine("Message sent successfully!");
    Console.WriteLine($"URL: {response.RecipientsAnswer[0].Answer.URL}");
}

Prerequisites

  • .NET Framework 4.7.2+ (for SecureExchanges / SecureExchanges.Signature) or .NET 8.0+ (for SecureExchanges.NetCore / SecureExchanges.Signature.NetCore)
  • Valid Secure Exchanges license
  • API credentials (Serial, API User, API Password)

Getting Your API Credentials

  1. Log in to the Secure Exchanges portal
  2. Go to Account > Options > User Management
  3. Select a user with API license
  4. Click the "API Key" icon to generate your credentials
  5. A secure message containing your keys will be sent to the associated address
Warning

The message containing your keys expires after 15 minutes. Keep your credentials in a secure location.

Documentation Structure

Section Description
Getting Started Detailed installation and configuration
Architecture SDK concepts and architecture
Sending Messages Message sending tutorials
Encryption Encryption operations
Signatures PDF electronic signatures
SESAR Advanced messaging workflows
Status Codes Error code reference
Best Practices Security recommendations

Support