emSigner Support Center
  • Introduction
    • emSigner Support
  • Plans & Pricing
    • User Plans
      • Essential
      • Advanced
      • Professional
  • Subscription
    • Renewal
    • Upgrades
  • User Management and Settings
    • Internal User
      • Create an Internal User
      • Edit Details of Internal User
      • Delete an Internal User
    • External / Ad-hoc User
    • My Profile
      • OTP Login
  • Initiate and Sign Envelopes
    • emSigner Basics
    • Adhoc Envelope
      • In Person Signing
      • Hybrid Signing
    • Creation of an Envelope - New UI Flow
    • Fixed Form Template
    • Flexi Form Template
      • Dynamic Signing
      • Web Form
    • Offline Bulk Sign
      • Bulk Signing - Folder based
      • Sign and Send
    • Adhoc User Signing
    • eStamp
      • eStamping Offline
      • eStamping Online
    • Selfie Capture & Liveness Check
      • Liveness Check with Face Match
    • For Seal
  • User Dashboard and Docstore
    • Dashboard
      • Pending
        • My Signatures
        • Waiting for Others
      • Bulk Signing in Dashboard
    • DocStore
      • List of Documents
        • Drafts
        • Completed
        • Declined
        • Recalled
      • Scan Documents
      • Upload Documents
  • Reports
    • Reports Dashboard
    • Workflow Reports
    • User Reports
    • Favourite Filters
    • Scheduling Reports
  • Types of eSignatures
    • Global
      • eSignature
      • Remote Signing
      • Digital Signature Certificate (DSC)
      • Azure Key Vault(AKV Signing)
    • India
      • eSignV2
      • eSignV3
    • The Kingdom of Saudi Arabia(KSA)
      • emdha
    • Indonesia
      • VIDA
      • Peruri
      • xignature
    • Malaysia
  • Administrator Settings
    • Settings
      • Company Profile
      • Change Password
      • emSigner Utility Port Settings
      • Auto Delegate
      • Encrypt
      • Decrypt
      • Validate Signed File
      • Offline Templates
      • Manage Auth Token
      • Offline Non Judicial and Revenue Stamps
    • Expiry and Reminder
    • Admin Settings
      • Manage Departments
      • Manage Templates
      • Template Access
      • Co-branding
      • Email Templates
      • Activity Log
      • Custom Status
      • FTP Settings
      • Certificate Settings
        • AKV Certificate Upload and Enrollment
      • Time Stamp Settings
      • Signer Attachment
      • Webhook
        • Multiple Webhooks
      • Roles & Permissions
        • How do I assign the Maker role to an Internal User?
        • How do I assign the Checker role to an Internal User?
      • SMTP Settings
      • Password Settings
      • Storage Connectors
      • Geofencing
      • Identity Provider
        • Steps to configure the App in Okta
      • Trusted Logins
      • Demographic Verification
    • Advanced Settings
    • API Settings
      • Manage Apps
  • Legal Evidence
    • Verifying Digital Signed Documents
    • Verifying Electronically Signed Documents
      • Completion Certificate
      • Document Log
      • Activity Log
  • Environments
    • Environments
  • Releases
    • Release Notes
      • V 2.8.9.6
      • V 2.8.9.5
      • V 2.8.9.4
      • V 2.8.9.3
      • V 2.8.9.2
      • V 2.8.9.1
      • V 2.8.9
      • V 2.8.8
      • V 2.8.7
      • V 2.8.6
      • V 2.8.5
  • Security and Quality
    • Data Security
  • Deployment Architecture
    • Architecture Diagram
  • Apps and Integrations
    • emSigner Integration with Salesforce to automatically initiate Contracts
    • emSigner Integration with Microsoft Dynamics 365 Saleshub to automatically initiate Quotes
    • emSigner Integration with Microsoft Teams
      • First time Setup & Configuration
      • Initiate, Sign & Send - Uploading the document to Teams
      • Initiate, Sign & Send - Existing Document under files
    • emSigner Integration with Microsoft Outlook
      • First time Setup & Configuration
      • Initiate, Sign & Send (Web)
      • Initiate, Sign & Send (Desktop)
      • Demo Video - Microsoft Outlook
    • emSigner Integration with Microsoft Word
      • First time Setup & Configuration
      • Initiate, Sign & Send (Web)
      • Initiate, Sign & Send (Desktop)
    • emSigner Integration with Microsoft SharePoint
      • Demo Video - Microsoft SharePoint
    • emSigner Integration with SAP S/4HANA
      • E Signing
      • Embedded Signing
      • Demo Video - SAP S/4 HANA Integration
    • emSigner Integration with SAP SuccessFactors
      • Demo Video - SAP SuccessFactors Integration
    • emSigner Integration with Google
      • Gmail
        • Demo Video - Gmail Integration
      • Google Drive
        • Demo Video - Google Drive Integration
    • emSigner Integration with Salesforce
      • Demo Video - Salesforce
  • Industry Specifics
    • CFR 21 Part 11
  • Resources
    • Videos
    • Uptime Status
  • APIs
    • eSignature REST API
      • Getting Started
        • Key Concepts
        • Subscription
        • Setting up your brand and colors
        • Making your first API Call
        • Sandbox and Going LIVE
      • How To's
        • Getting Documents Signed
        • Using pre-defined templates
        • Using Webhooks
        • Retrieving Signed Documents
      • API Documentation
      • Sample App - Contracts
    • Signer Gateway
      • Getting Started
        • Key Concepts
        • Subscription
        • Setting It Up
        • Sandbox and Going LIVE
      • Gateway Documentation
        • Signing Documents
        • Retrieving Signed Documents
      • Sample App - Lending
    • Embedded Signing
      • Getting Started
        • Key Concepts
        • Subscription
        • Setting up your brand and colors
        • Making your first API Call
        • Sandbox and Going LIVE
      • How To's
        • Adhoc Documents
        • Using pre-defined templates
        • Application Features
      • API Documentation
      • Sample App - Loan Origination
  • Samples
Powered by GitBook

Copyright emSigner 2023

On this page
  • Step 1
  • Step 2 - Branding your signer gateway
  • Step 3 - Accessing usage reports
  1. APIs
  2. Signer Gateway
  3. Getting Started

Setting It Up

Step 1

An authentication token is a unique identifier that allows emSigner to identify the application requesting access to our service. To use the signer gateway, you will require an authentication token that is uniquely created for your account. To create an auth token and start connecting to the signer gateway, please follow the steps below

  1. Login into emSigner using the credentials set by you as part of the subscription

  2. Navigate to settings (under your name, on the top right of the dashboard).

  3. Go to Manage Auth Tokens in the User Section of the Settings page

  4. Go ahead and create an auth token by clicking on “Create Auth Token” button as shown in the screen below

At this point, you should have an App Name and Auth Token that can be used to connect to emSigner Signer Gateway.

Key Points

  1. The Authtoken is user-specific and is a permanent token.

  2. You can generate multiple Authtokens.

  3. Removing an Authtoken will inactive the token permanently and any request with the usage of the inactive token will be invalid.

  4. If you generate new Authtoken, update your program with the new token. The new token has to be replaced for all signer gateway calls.

  5. The Authtoken of a user’s account will become invalid if the user subscription is expired or deactivated.

  6. Never share your authtoken and account credential details to anyone. Sharing these details can lead to unauthorized access to emSigner signer gateway.

Step 2 - Branding your signer gateway

Brand your account by configuring themes and logo, along with your signing experience. Configuring logo helps users to identify documents coming from your organization. Branding your account is an excellent way to add the look and feel of your organization’s brand.

To brand your account, please follow the steps below:

  1. Login into emSigner using valid credentials

  2. Navigate to settings (under your name, on the top right of the dashboard).

  3. Click on Co-branding tab in the Gateway settings section (at the bottom of the page) as shown below

Clicking on “Customize Theme” will display the pop-up below using which you can modify the following elements of the signer gateway

  1. Header Background

  2. Header Text

  3. Button Colors

Step 3 - Accessing usage reports

emSigner provides two types of reports that allow you to check usage of the signer gateway

  1. Usage

  2. Transaction Information

Checking Counter Usage

Everytime you use the signer gateway, your counters get decreased. To check your counter usage, please follow the steps below:

  1. Login to your emSigner account with valid credentials

  2. Navigate to settings (under your name, on the top right of the dashboard)

  3. Click on “Graphical Charts” in the Gateway section. You will see a screen that looks like the one below

The dashboard contains all the transaction details by date which can be used as a filter. The usage details shows details including total number of counters and how many of them have been consumed

Transaction Information

emSigner tracks all the signer gateway transaction request information. To check this, please follow the steps below:

  • Login to your emSigner account with valid credentials

  • Navigate to settings (under your name, on the top right of the dashboard)

  • Click on “Transaction Log” tab, in the Gateway section

  • You will see a screen that looks like the one below

The transaction details consist of below information.

  1. Date & Time: Date and time of a transaction.

  2. Transaction Number: Unique number generated for a transaction.

  3. Reference Number: Unique number sent by the source application for a particular transaction.

  4. Error Description: Error description for failed and canceled transactions

  5. IP Address: IP Address used for a particular transaction.

  6. Actions: Actions consisting of transaction log information.

PreviousSubscriptionNextSandbox and Going LIVE

Last updated 2 months ago