Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

Below will be detailed the SOAP request for verify signatures, certificates and timestamps

All the methods described are on interface:

Code Block
https://<IP-APPLIANCE>:8080/SignEngineWeb/verify-services?wsdl

The SOAP request examples are generated using SoapUI, you can use this guide to configure SoapUI on your pc.

In this guide will be described the example of Soap Requests.


Verify Signatures

For verify the signatures, you can use the method "verifyWithPreferences", like in this example:

Code Block
languagexml
titleREQUEST-verifyWithPreferences
linenumberstrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.ws.nam/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:verifyWithPreferences>
         <!--Optional:-->
         <signedContent>BASE_64_ASSOCIATED_TO_SIGNED_FILE</signedContent>
         <!--Optional:-->
         <preferences>
         	<language>COUNTRY_CODE_2_DIGIT</language>
         </preferences>
      </ser:verifyWithPreferences>
   </soapenv:Body>
</soapenv:Envelope>


For all input of verify preferences, you can see this link


The output of this SOAP request will be a complex object SignedDocumentReportBean described at this link


Verify Timestamp

SWS offer two differents methods for verify TSD (TimestampData) and TSR (TimestampResponse):

  • verifyTimeStampData
  • verifyTimeStampResponse


Below will be described how make the SOAP request

Verify TSD


Below an example of SOAP request:

Code Block
languagexml
titleREQUEST-verifyTimeStampData
linenumberstrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.ws.nam/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:verifyTimeStampData>
         <tsd>BASE_64_OF_TSD</tsd>
      </ser:verifyTimeStampData>
   </soapenv:Body>
</soapenv:Envelope>


The response will be a list of complex objects: "TimestampReportBean" described in this section

Verify TSR


Below an example of SOAP request:

Code Block
languagexml
titleREQUEST-verifyTimeStampResponse
linenumberstrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.ws.nam/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:verifyTimeStampResponse>
         <tsr>BASE_64_OF_TSR</tsr>
         <!--Optional:-->
         <content>BASE_64_OF_ORIGINAL_FILE</content>
      </ser:verifyTimeStampResponse>
   </soapenv:Body>
</soapenv:Envelope>


The response will be a list of complex objects: "TimestampReportBean" described in this section


Verify TSD or TSR with preferences


Below SOAP request of verify TSD:

Code Block
languagexml
titleREQUEST-verifyTimeStampWithPreferences
linenumberstrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.ws.nam/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:verifyTimeStampWithPreferences>
         <timestampedContent>BASE_64_ASSOCIATED_TO_TSD_FILE</timestampedContent>
         <preferences>
            <language>COUNTRY_CODE_2_DIGIT</language>
            <responseWithoutContent>boolean</responseWithoutContent>
         </preferences>
      </ser:verifyTimeStampWithPreferences>
   </soapenv:Body>
</soapenv:Envelope>

NOTE: If you are verifying the TSD not require the detached content (original file)


The response will be a list of complex objects: "TimestampReportBeanSummary" described in this section



While if you are verifying a TSR, the SOAP request will be:

Code Block
languagexml
titleREQUEST-verifyTimeStampWithPreferences
linenumberstrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.ws.nam/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:verifyTimeStampWithPreferences>
         <timestampedContent>BASE_64_ASSOCIATED_TO_TSR_FILE</timestampedContent>
         <preferences>
            <language>COUNTRY_CODE_2_DIGIT</language>
			<detachedContent>BASE_64_ASSOCIATED_TO_ORIGINAL_FILES<detachedContent>
            <responseWithoutContent>boolean</responseWithoutContent>
         </preferences>
      </ser:verifyTimeStampWithPreferences>
   </soapenv:Body>
</soapenv:Envelope>

NOTE: If you are verifying the TSR, require the detached content (original file)

The response will be a list of complex objects: "TimestampReportBeanSummary" described in this section


Verify Certificate

For verify the certificate, you can use the method "verifyCertificate", like in this example:


Below an example of SOAP request:

Code Block
languagexml
titleREQUEST-verifyCertificate
linenumberstrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.ws.nam/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:verifyCertificate>
         <certificate>BASE_64_OF_CERTIFICATE</certificate>
      </ser:verifyCertificate>
   </soapenv:Body>
</soapenv:Envelope>


In output will obtain a complex object "CertificateReportBean" described in this section

Below an example of SOAP response:

Code Block
languagexml
titleRESPONSE-verifyCertificate
linenumberstrue
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:verifyCertificateResponse xmlns:ns2="http://service.ws.nam/">
         <return>
            <issuerRevoked>BOOLEAN</issuerRevoked>
            <issuerValid>BOOLEAN</issuerValid>
			<issuerRevocationDate>DATE</issuerRevocationDate>
            <subjectRevoked>BOOLEAN</subjectRevoked>
            <subjectValid>BOOLEAN</subjectValid>
			<subjectRevocationDate>DATE</subjectRevocationDate>
			<trusted>BOOLEAN</trusted>
         </return>
      </ns2:verifyCertificateResponse>
   </soap:Body>
</soap:Envelope>