Integration Web Services

SOAP Gateway Endpoint

Transport Headers to invoke SOAP Service

POST https://stg-id.uaepass.ae/trusted-gw/SoapGateway

Headers

Name
Type
Description

TwsAuthN

string

urn:safelayer:tws:policies:authentication:oauth:clients

SOAPAction

string

Update

Content-Type

string

text/xml

Request

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss- wssecurity-secext-1.0.xsd" soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next" soapenv:mustUnderstand="1">
<wsse:UsernameToken>
<wsse:Username>XXXX</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss- username-token-profile-1.0#PasswordText">XXXXX</wsse:Password><!-- 9QWtRunFT3-->
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<VerifyRequest Profile="urn:safelayer:tws:dss:1.0:profiles:nonrep:1.0" RequestID="b22c97c6117fc3386f81" xmlns="http://www.docs.oasis- open.org/dss/2004/06/oasis-dss-1.0-core-schema-wd-27.xsd">
<OptionalInputs>
<ReturnUpdatedSignature Type="urn:oasis:names:tc:dss:1.0:profiles:XAdES: forms:ES-A"/>
<css:PdfFieldLabel>SFLY Signature 0</css:PdfFieldLabel>
</OptionalInputs>
<InputDocuments>
<Document>
<Base64Data MimeType="application/pdf">XXX</Base64Data
</Document>
</InputDocuments>
</VerifyRequest>
</soapenv:Body>
</soapenv:Envelope>

Request Parameters

Username

client_id of the SP. To be shared by the respective onboarding team.

Mandatory

PasswordText

Client_secret of the SP. To be shared by the respective onboarding team.

Mandatory

RequestID

SP can pass the unique ID for tracking the request for one particular transaction.

Optional

Base64Data

Base64 encoded data of the document which is to be LTV signed.

Mandatory

Sample Request/Response (with sample data):

The integration team can try below request in any SOAP service testing tool (e.g. SOAPUI, PostMan etc.) by replacing the username password as provided by UAEPASS onboarding team.

POST stg-id.uaepass.ae/trusted-gw/SoapGateway

HTTP/1.1

Headers

Name
Type
Description

TwsAuthN

string

urn:safelayer:tws:policies:authentication:oauth: clientsSOAP

Action

string

Verify

Content-Type

string

text/xml

Request Sample

Response Sample

Error Codes

Code

Description

urn:oasis:names:tc:dss:1.0: resultminor:NotAuthorized

The requester or the requested party is not authorized to perform this operation.

urn:oasis:names:tc:dss:1.0: resultminor:NotSupported

The server does not recognize or support some aspect of the request.

urn:safelayer:dss:1.0: resultminor:PolicyViolation

The server cannot process the request owing to a service policy violation.

urn:safelayer:dss:1.0:resultminor:SignerCertificateNotFound

Signer's certificate not found in the signature or in the verification request.

urn:oasis:names:tc: dss:1.0:resultminor:NotSupported

The server cannot process the content of a valid element in the request owing to an unexpected error. The dss:ResultMessage element can include lower level information on the reasons for the error.

urn:safelayer:dss:1.0: resultminor:SigningError

The input data and parameters are correct, but the server cannot generate the signature requested owing to an unexpected error. The dss:ResultMessage element can include lower level information on the reasons for the error.

urn:oasis:names:tc:dss:1.0:resultminor: ValidSignature_OnAllDocuments

The signature or timestamp is valid and includes all the input documents indicated in the request.

urn:oasis:names:tc:dss:1.0:resultminor: ValidSignature_NotAllDocuments

There are multiple signatures or timestamps but not all are valid.

urn:oasis:names:tc:dss:1.0:resultminor: IncorrectSignature

The signature cannot be verified (the

that comes with this result indicates the causes of the error)

urn:safelayer:dss:1.0: resultminor: IncorrectKeySelected

Signature not generated owing to the selection of an invalid key.

urn:safelayer:dss:1.0: resultminor: IncorrectAlgorithmIdentifier

The selected signature algorithm is not supported.

urn:safelayer:dss:1.0: resultminor: IncorrectFormatInData

Incorrect input data.

urn:safelayer:tws:dss:1.0: profiles:resultminor: UntrustedKey:CA

The signed message has not been modified but the signature key is not trusted (because the certification chain could not be built or because the CA certificate is not trusted).

urn:safelayer:tws:dss:1.0: profiles:resultminor: UntrustedKey:Validity

The signed message has not been modified and the certification chain is trusted. However, the signature key is not trusted because the certificate has expired and it cannot be verified that the signature was generated when the certificate was valid.

urn:safelayer:tws:dss:1.0: profiles:resultminor: UntrustedKey:Status

The signed message has not been edited, the certification chain is trusted and the signature was generated with a valid certificate. However, the server could not verify that the signature key was valid. Either because the status information indicates that the signature was invalid or because the status information could not be queried. The

element of the XML message contains further information on the certificate's status.

urn:safelayer:tws:dss:1.0: profiles:resultminor: IncorrectArchiveSignature

The archive signature cannot be verified (the

element indicates the causes of the error).

urn:safelayer:tws:dss:1.0:profiles:resultminor:UntrustedKey:GoodWit hNoInfo

The signed message has not been edited, and the signature key is trusted. However, the status of all the certificates in the certification chain cannot be determined owing to a lack of revocation information in the long-term signature.

Last updated

Was this helpful?