Get sign order info

The set of "Get" messages available:

• GetDocuments
• GetFormData
• GetNotificationLog
• GetOrder
• GetOrderDetails
• GetOrders
• GetOrderStatus
• GetSignature
• GetSigningProcesses

GetDocuments

The GetDocuments message will return either a single or all documents in a specified sign order and/or the SDO's or partial SDO's. A partial SDO is a SDO including only one document and all signers that have have signed the document at the requested time. A partial SDO is generated after each completed sign process.  If all signers have signed a given document then the SDO (which is generated per document) is sealed. The document status is then set to Complete.

GetDocuments response

DocumentResult

Back to top

GetFormData

This request can be used to retrieve data that the signer enters when filling out a PDF form. The PDF form data can be retrieved after the first signer in the order has fulfilled the PDF form and continued to document signing. It is not required that the document has been signed before form data can be returned. Read more about the PDF form functionality.

GetFormDataResponse

The result from the GetFormData request.

Back to top

GetNotificationLog

The GetNotificationLog message returns information about all notifications that have been sent to the customer itself and to signers involved in the specified sign order.

GetNotificationLog response

NotificationRecord

Back to top

GetOrder

The GetOrder message returns the entire sign order as it was when the customer inserted it. The only difference may be that the values for deadlines for steps and sign processes has the same values as the deadline of the sign order. This is the case if the step and sign process deadlines was not defined when inserting the sign order.

GetOrder response

The information returned in the GetOrderResponse is the same as the values used when inserting the sign order. See the InsertOrder message for information about the different elements.

Back to top

GetOrderDetails

The GetOrderDetails message is used to retrive sign order details. It returns a subset of the sign order as it was inserted. The response to this message is not as comprehensive as the GetOrder message, but it gives an overview of the sign order and the current statuses.

GetOrderDetails response

ExecutionDetails

SigningProcessDetails

Back to top

GetOrders

The GetOrders message is a search message that can filter on sign order status, signers, meta data and/or time. Note: Using the different filtering options may be time consuming and the response time may be significant higher than other E-Signing messages.

Back to top

GetOrders response

The first part of the response returns the filtering criterias set in the GetOrders message and they are described there. The table below describes the result.

OrderResult

Back to top

GetOrderStatus

The GetOrderStatus message is a message used to request the complete status of a sign order. The message returns the status of the sign order, the documents, the signers, the steps and the sign processes.

Read more about all statuses in the service.

Sample code for checking the sign order status is given below.

 ESigningFacade facade = ESigningFactory.INSTANCE.getESigningFacade("Demo Merchant");
 
 GetOrderStatusRequest req = new GetOrderStatusRequest();
 req.setMessageID("esigndemoapp-msgid-3");
 req.setTime(new Date());
 req.setMerchantID(1587);
 req.setOrderID("1587-demo-742819356");

 GetOrderStatusResponse response = facade.getOrderStatus(req);
 String orderStatus = response.getOrderStatus();

GetOrderStatus response

ExecutionDetails

Back to top

GetSignature

The GetSignature message is used to retrieve a signature from a sign order along with the OCSP and SSN of the signer if available.

GetSignature response

Back to top

GetSigningProcesses

The GetSigningProcesses message is used to fetch all sign processes for a given sign order and given signer based on the sign process status if stated. The sign URL (if not signed), the sign process status and the sign time (if signed) is returned. This message is the most commonly used message to retrieve a signer's sign URL. Other ways to retrieve the sign URL is to use either e-mail notification sent directly to the signer or XML notification sent to the customer's application so the application can make it available for the signer. Read more about XML notification call back.

This message is also used to check the status of a sign process. The status of a sign process is set to complete immediately after the signing has been performed. As a comparison, the status of a sign order is set to complete after all signatures has been set to complete and all post-processing of the sign order has been done. Post-processing includes creating and sealing the SDO, send notifications and archival.

Note: It is highly recommended to implement this message to retrieve the sign URL.

Back to top

GetSigningProcesses response

SigningProcessResults

Back to top