Sertifi | eSignature and Payment API
Build a better experience for collecting electronic signatures and customer payments with Sertifi via XML, SOAP over HTTPS, and REST. Get your complimentary developer's sandbox and start making API calls today.
electronic signature API, esignature API, PCI payment solutions, PCI compliance, flexible esignature API, robust esignature API, API esignature integrations
9420
page-template-default,page,page-id-9420,page-child,parent-pageid-7457,ajax_fade,page_not_loaded,,qode-theme-ver-3.1.1,elision,wpb-js-composer js-comp-ver-5.0.1,vc_responsive

Developer Center

Leading API that’s scalable, reliable, and configurable. 

Welcome to the developer center. Here, you can find details on how to quickly integrate our solution into the apps you already use and love. Use with your existing apps to send requests to customers via email, or provide an in-session experience directly on your website or portal. Use our API to reduce your integration time and start building robust enterprise applications today.

Overview

Sertifi’s Gateway API is a web service that enables you to quickly, easily, and securely integrate into existing applications via XML, SOAP over HTTPS, and REST (available soon). Transactions are defined on the host application, allowing the workflow to be defined by the developer. This lets you rapidly integrate the service to send, manage, track and retrieve completed transactions. Our web portal solution provides administrative interfaces that allow you to configure settings, manage users, and view and track transactions. For transaction status, we provide real-time web service push or pull methods.

Creation
  • CreateSignatureRequest
  • AddDocumentToRequest
  • AddPrepopulatedPdfToRequest
  • AddReferenceDocumentFromLibrary
  • AddReferenceDocumentToRequest
  • AddInstructionalDocumentToRequest
  • AddSignerToRequest
  • AddCCToRequest
  • AddLocation
  • ApplyTemplate
  • InviteSigners
  • InviteSigner
  • SetDocumentParameters
  • SetSignatureRequestParameters
  • CreatePayment
Management
  • GetLink
  • RemoveSignatureRequest
  • RemoveDocument
  • RemoveUser
  • EditUser
  • ApplySignature
  • VerifyFolderPassword
  • SetRedirectURL
  • SendSignedDocumentEmail
  • RemovePayment
Retrieval
  • GetDocumentSummary
  • DownloadSignedDocument
  • DownloadFileContents
  • GetDocumentHash
  • SendSignedDocumentEmail
  • Web service push over HTTPS*

*Requires setup of web service on client side

Reporting
  • GetFileSigners
  • GetFilesStatus
  • GetMinimalFileStatus
  • GetFileStatus
  • GetDocumentsStatus
  • GetUserInfo
  • GetStatusOnChangedFiles
  • FileQuery
  • GetPaymentsStatus
Getting Started

We make it easy to get started by supplying you with a Welcome Kit and an optional Sandbox site to run test transactions. The Welcome Kit includes an html file containing your connection information to our Gateway, as well as an API code for authentication. If you don’t have an API access code, please open a support ticket with our support team. This API access code is required for every web service request. Access the web service WSDL here.

 

Once you have the connection information, you can generate the necessary code from our WSDL. There are many tools publicly available for this. These tools will be specific to the development environment you are using. At that point, you can begin a simple test implementation by creating a new eSignature request. This new request will include data on the eSignature requested, including the name of the file and the person that needs to sign the document. Our system will send a link to the person requested to sign the document, which will link back to our system where the person will sign the document. This single call is all you need to send for a basic eSignature request. Please see the API Documentation for more information on how to get started.

Common Workflows
1. How to Send & Collect eSignature Requests via Email

Here is a sample of the methods to call required to set up eSignature requests and invite signers via email:

1. CreateSignatureRequest

Creates a folder in the Sertifi application & associates signer(s) to the folder

2. AddDocumentToRequest - or - AddPrepopulatedPdfToRequest

Attaches documents for eSignature to folder – or – Passes ID for a template stored in document library & passes data to populate template

3. InviteSigner - or - InviteSigners

Alerts the Sertifi application to send eSignature request(s) via email

2. Integrate eSignatures into Existing Portal or Use for In-Session Signing

In-session signing allows you to embed or display eSignature-ready documents directly into existing websites. The solution supports interactive forms, static, and dynamic document presentation. Here is a sample of methods to call for setting up eSignature requests and retrieving the link to present to signers:

1. CreateSignatureRequest

Creates a folder in the Sertifi application & associates signer(s) to the folder

2. AddDocumentToRequest - or - AddPrepopulatedPdfToRequest

Attaches documents for eSignature to folder – or – Passes ID for a template stored in document library & passes data to populate template

3. GetLink (passing the Link Type Parameter FileSigningPageLink or SigningPageLink)

Provides a link to the eSignature-ready document for in-session signing

Documentation
Web Service Push

We have the ability to proactively call a web service or web page on your server whenever a notification event occurs. This will give your system real‐time information as to the status of your transactions including meta data or any data collected by signer(s).

Samples & Libraries

To access Sertifi samples and libraries for items like Sertifi php, Sertifi C# Code, Sertifi Web Service Push, and Salesforce – please visit our source site today. Here, you can also access the Java samples.

Integrate our flexible API solution into your existing apps.