Skip to content
On this page

REST Endpoints

The AlphaTrust e-Sign™ Web Service APIs are the recommended interface for all integration and development activity.

SaaS service REST endpoints:

United States:
Customer sandbox/test environment: https://uat.alphatrust.com/REST
Customer production environment: https://esign.alphatrust.com/REST

United Kingdom:
Customer sandbox/test environment: https://alphatrustext.ipipeline.uk.com/REST
Customer production environment: https://alphatrust.ipipeline.uk.com/REST

On-Premise Service Address (REST):

Assuming a web server address of esign.yourdomain.com, the rest service endpoint addresses would be as follows:

REST address: https://esign.yourdomain.com/rest

REST docs address: https://esign.yourdomain.com/rest/swagger/docs/v5

Creating a Proxy

If you want to create a proxy via automation for any common programming language, you can use the AlphaTrust Swagger Docs with the free Swagger Editor.

  • AlphaTrust Swagger Docs

  • Copy the contents of the URL display (it should look something like the below)

    json
    {
    "swagger": "2.0",
    "info": {
        "version": "v5",
        "title": "API Version: 5.0",
        "description": ""
    },
    "host": "esign.alphatrust.com",
    "basePath": "/rest",
    "schemes": [
        "https"
    ],
    "paths": {
        "/api/v5/auditreports": {
        "post": {
            "tags": [
            "AuditReports"
            ],
            "summary": "Get Audit Report.",
            "operationId": "GetAuditReports",
            "consumes": [
            "application/json",
            "text/json",
            "application/xml",
            "text/xml",
            "application/x-www-form-urlencoded"
            ],
            "produces": [
            "application/json",
            "text/json",
            "application/xml",
            "text/xml"
            ],
    
            ...
  • Open up the Swagger Editor IO and follow the instructions in the image below Swagger Editor

  • Unzip the contents and you should see a project/solution with your proxy code.

  • Open the ReadMe.md file and follow the instructions for setup.

WARNING

It is HIGHLY recommended that you use Strings for all enumerations instead of integers since Swagger sets its own values for enums and most likely will not line up with the AlphaTrust values. This also makes your code more readable. AlphaTrust will never change the String names for any enumerations.

json
{
    "ProntoID": "string",
    "StatusType": "Completed", // use string enum name, not integer value here
    "SearchDateType": "ClosedDate", // use string enum name, not integer value here
    "SearchDateFrom": "2022-01-01",
    "SearchDateTo": "2022-02-01"
}