ProSale Signing Application Programming Interface

This page is available in English only.

The ProSale Signing API makes full integration with any kind of application easy. The Web Services are based on SOAP 1.1 and the workflow engine allows for customization of each step in the signing process to accommodate for any business needs.

Overview of operations

The following diagram is an overview of the operations available in the API.

General rules for the operations are as follows:

1. A Request or Response can have identification. The identification in the Request is returned in the Response.
2. A Request must include valid credentials for using ProSale Signing and may optionally include the requesting source.
3. A Response always includes the result of the Request i.e. successful or not. If there was an error, a code and a message will inform about this.

Approve Document
The operation approves a document for signature.
Request: The request states the instance identification for approval. It may contain an identification token from an Identity Provider if “Identification” has been set in “CreateSigningInstance”.
Response: The response states if the approval was successful or not.

Create Signing Instance
The operation creates a signing instance in ProSale Signing.
Request: The request contains all relevant information for the creation of a signing instance, such as details of Signatories, Reminders, Notifications, documents and attachments to sign, etc.
Response: The response states if the instance was created successfully or not. When an instance has been created its identification is returned. Also unique URL’s for each signatory is returned.

Decline Document
The operation is used when declining to sign a document.
Request: The request states the instance identification of the decline. It may contain an identification token from an Identity Provider if “Identification” has been set in “CreateSigningInstance”.
Response: The response states if the decline was successful or not.

Get Authentication Request URL
The operation is used to get the URL to the place where the authentication should be made.
Request: The request includes an alias for the mode or level of authentication and a relay state.
Response: The response includes a URL to a place for an authentication.

Get Document Request
The operation is used to get a document with possible attachments for signature.
Request: The request includes the instance identification of the document to get or a document selection. It can contain an identification token from an Identity Provider if “Identification” has been set in “CreateSigningInstance”.
Response: The response states if the request was successful or not. If it was successful it includes corresponding documents and attachments.

Get Identification List
The operation gets the mode of identification for a signatory.
Request: The request must include identification of the instance and may optionally include the identification of a signatory.
Response: The response includes the mode of identification for the signatories in the requested instance.

Get Signatory
The operation gets the details of one or more signatories of an instance.
Request: The request must include the identification of an instance. It must also include a Signatory identification or a filter of the Signatories to get (all or current).
Response: The response includes details of one or more signatories of an instance.

Get Signing Instance Info
The operation gets information about one or more instance such as status and dates.
Request: The request includes a filter to be applied when selecting one or more instance.
Response: The response includes information about one or more instance such as status and dates.

Get Signing Instance
The operation gets all information related to an instance.
Request: The request must include the identification of an instance.
Response: The response includes all information related to an instance.

Remind Signatory
The operation reminds a Signatory to sign a document.
Request: The request must include the identification of an instance and may optionally include the identification of a specific Signatory and a reminder message.
Response: The response states if the reminder was successful or not.

Update Signing Instance
The operation updates details on a signing instance.
Request: The request must include the identification of an instance and the details of the instance that should be changed. Rules stating how the information of an instance may be changed are available.
Response: The response states if the update was successful or not.

Verify Signed Document
The operation verifies the validity of a signed document.
Request: The request must include the document to verify.
Response: The response states if the signature was valid or not.

Withdraw Signing Instance
The operation withdraws a signing instance from ProSale Signing.
Request: The request must include the identification of an instance.
Response: The response states if the withdrawal was successful or not.