The following sections describe various aspects of OneSpan Sign's REST API:
This guide’s REST API chapter provides an overview of certain basic API calls. If you want to view all existing calls, see the REST API Object Model. Additional information about the calls can be found on the Developer Community website. That site’s Feature Guides may be especially helpful when you’re building your solution.
The following sections list the bases that apply to all REST API URLs referenced in the documentation.
US Customers on OneSpan Sign 11.x
This table applies to US customers who use OneSpan Sign 11.x.
|US OneSpan Sign Production||https://apps.esignlive.com/api|
US Customers on OneSpan Sign 10.x
This table applies to US customers who use OneSpan Sign 10.x.
|US OneSpan Sign Production||https://apps.e-signlive.com/api|
US Government Customers
This table applies to US government customers.
|OneSpan Sign Production for Government||https://signer-gov.esignlive.com/api|
|OneSpan Sign Sandbox for Government||https://signer-sandbox-gov.esignlive.com/api|
This table applies to Canadian customers.
|PRDC Canada Production||https://apps.e-signlive.ca/api|
|SBXC Canada Sandbox||https://sandbox.e-signlive.ca/api|
This table applies to Australian customers.
This table applies to European customers.
Version 10.6 of the REST API added Extended Form Fields.
Version 10.7 of the REST API added the Use Your Own Device option.
To use those or any other new features, your API requests must contain your API version number, as illustrated here: Accept: application/json; esl-api-version=10.7
The following sections describe additional aspects of the REST API:
- Account Custom Fields
- Account Overview
- Authentication Tokens
- File Attachments
- Notary e-Journal
- Package Settings for Mortgages
- Package Settings for Digital Lending
- Signature Image Extraction
- Signing Ceremony Settings
- Signing URL
- Text Anchors
- User Custom Fields