The RequestEnterpriseSignature enables signature and e-Seal functionality by means of enterprise certificates on hosted or cloud enabled Hardware Security Modules (HSM).
Web service endpoint
This function is a part of the Posting Service.
Web service description endpoint in the testing environment T3: https://test3.signant.no/WS/V1/EnterpriseSignature.svc?wsdl
The RequestEnterpriseSignature sequence work flow
RequestEnterpriseSignature steps:
1.Sign document request. Business system initiate the Signant eSeal service authenticating and authorizing the request.
2.Merchant Business System uploads document to be signed and sealed.
3.Signant Webservice request the underlying HSM for an electronic signature.
4.Signant add an electronic time stamp by means of an underlying QTSA.
5.The Merchant business system download the signed and sealed document.
The steps are consolidated into a single webservice call to RequestEnterpriseSignature with the following input and result values:
Input
Name |
Type |
Description |
Required |
---|---|---|---|
DistributorID |
String |
Provided by Signant. For external system authorization |
Yes |
AccessCode |
String |
Provided by Signant. For external system authorization |
Yes |
File |
Binary |
PDF document file to be signed or sealed (1) |
Yes |
FileName |
String |
The PDF document file name |
Yes |
SignatureMode |
Enum |
Seal, Signature (2) |
Yes |
WorkflowMode |
Enum |
Synchronous (3) , Asynchronous (4) |
Yes |
CertificateSubject |
String |
Enterprise certificate subject name |
Yes |
CertificateName |
String |
Display name in the signature widget |
No |
ExternalRef |
String |
Reference provided by the external system |
No |
1) Must be a valid PDF file
2) Not implemented
3) For immediate signature and return of document file
4) For asynchronous signature and later download of the document file (not implemented)
Output
Name |
Type |
Description |
---|---|---|
Success |
Bool |
Method call result |
Message |
String |
Error/Validation message when Success is false |
ErrorCode |
Int |
Error/Validation code when Success is false |
File |
Binary |
Signed file (1) |
FileName |
String |
The PDF document File name |
TransactionID |
Guid |
Transaction identifier of the operation |
ExternalRef |
String |
Reference provided by the external system |
1) Empty when WorkflowMode = Asynchronous
Error codes
See Posting service error codes.