UAE PASS
  • UAE PASS
  • Overview
  • Getting Onboarded with UAE PASS
    • Onboarding Process for UAE PASS Service Providers
      • Initiation Phase
      • Development Phase
      • Assessment Phase
      • Go live Phase
  • Quick Start Guide - UAE PASS Staging Environment
    • User Account Types
    • Create Staging UAE PASS Account
    • Upgrade Staging UAE PASS Account
    • Testing Credentials for POC
    • Conduct a POC with UAE PASS Authentication
  • Feature Guides
    • Authentication
      • Web Integration
        • Introduction
        • Pre-Requisites
        • Endpoints
        • 1. Authorization Code
        • 2. Access Token
        • 3. User Information
        • 4. Logout
        • Login Button
        • Authentication Postman Walkthrough
      • Mobile Integration
        • Introduction
        • Pre-Requisites
        • Requirements
        • Guide
          • SDK
          • API
        • SDK Integration
      • Token Validation API
        • Introduction
        • Pre-Requistes
        • Endpoints
        • Integration Steps
          • 1. Verify access token API using Basic Authentication
          • 2. Obtaining Authenticated User Information from the Access Token
        • Validation Decisions
      • User Linking
        • Automatic Linking
        • Manual Linking
        • Corporate Account
    • Digital Signature
      • Digital Signature (Single Document)
        • Signing Guide
          • Endpoints
          • Document Signing Steps
            • 1. Token
            • 2. Create Signer Process
            • 3. Sign Document
            • 4. Obtaining Document
            • 5. LTV Configuration
              • Integration Web Services
              • Postman Collection for LTV
            • 6. Deleting Document
          • Document Signature verification Process
          • Postman Collection for Digital Signature
            • Digital Signature Postman Walkthrough
        • Verification API Integration
          • Web Service Details
          • Postman Collection for Signature Verification API
      • Digital Signature (Multiple Document)
        • Signing Guide
          • Endpoints
          • Document Signing Steps
            • 1. Token
            • 2.Create Documents
            • 3. Create Signer Process
            • 4. Sign Document
            • 5. Obtaining Document
            • 6. LTV Configuration
              • Integration Web Services
              • Postman Collection for LTV
            • 7. Deleting Document
          • Document Signature verification Process
          • Postman Collection for Multiple Document Signing.
    • e-Seal
      • Introduction
      • DESC Process for Dubai Entities
        • Process overview
        • Detailed DESC process description
      • ICA Process for Non-Dubai Entities
        • Onboarding Process
        • Obtaining Credentials and Certificates
      • Integration Web Service
        • PAdES eSeal Signing
        • CAdES eSeal Signing
        • eSeal verification
        • eSeal error codes
      • Postman Collection
    • Hash Signing
      • Introduction
      • Hash Signing (Single Document)
        • Hash Signing (Java SDK Set Up)
          • Quick Setup
          • Hash Signing Process
            • 1. Start the Process
            • 2. Initiate Signing Process
            • 3. Sign PDF Document
          • Endpoints
          • Postman Collection
          • Utility Files
      • Bulk Hash Signing (Multiple Documents)
        • Quick Setup
        • Hash Signing Process
          • 1. Start Signing Process
          • 2. Initiate Signing Process
          • 3. Sign PDF Document
        • Endpoints
        • Postman Collection
  • Web Registration
    • Introduction
    • Steps to create account
    • Endpoints
      • 1. Access Code
      • 2. Access Token
      • 3. User Information
  • Facial Biometric Transactions Confirmation
    • Web Integration
      • Endpoints
      • Integration Steps
        • Obtain Authorization Code
        • Obtain Access Token
        • Obtain User Info
        • Log out User
    • Mobile Integration
      • Mobile Integration Guidelines
  • Guidelines
    • Use-Case Guidelines
      • Standard Authentication Scenarios for Service Provider Use Cases
      • Standard Digital Signature Scenarios for Service Provider Use Cases
      • Standard Implementation Guidelines
    • Design Guidelines
      • UAEPASS Button Guideline
      • Text Message Guidelines
  • Resources
    • Attributes List
    • Sample Apps
    • Staging Apps
    • Assets
  • FAQ
    • Common Integration Issues
  • Versioning
Powered by GitBook
On this page

Was this helpful?

  1. Feature Guides
  2. Digital Signature
  3. Digital Signature (Single Document)
  4. Signing Guide
  5. Document Signing Steps

2. Create Signer Process

Creating the Document Signature Process

Previous1. TokenNext3. Sign Document

Last updated 7 months ago

Was this helpful?

After obtaining the access token in , the portal/application requests the creation of the PDF document signature process by sending the following message to UAEPASS using the signature services API.

API call will create a signing process at UAEPASS end

POST stg-id.uaepass.ae/trustedx-resources/esignsp/v2/signer_processes

HTTP/1.1

Headers

Name
Type
Description

Authorization*

string

Bearer <token>

Cache-Control*

string

no-cache

Postman-Token*

string

0cb4e517-8db9-473c-7b14-0ca2555bc199

Content-Type*

string

multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

{ 
    "id" : "sp_c4eed0a1f478f72454803695d53c4c52", 
    "self" : "Location: https://stg-id.uaepass.ae/trustedx-resources/esignsp/v2/signer_processes/sp_c4eed0a1f478f72454803695d53c4c52", 
    "process_type" : "urn:safelayer:eidas:processes:document:sign:esigp", 
    "tasks" : { 
        "pending" : [ 
            { 
                "type" : "UserBrowserTask", 
                "id" : "tk_fde244b585cd2feb54c3039b1498e4a4",
                "url" : "https://stg-id.uaepass.ae/trustedx-resources/esignsp/v2/ui?signerProcessId=sp_c4eed0a1f478f72454803695d53c4c5"
            }
        ]
    }, 
    "documents" : [ 
        { 
            "url" : "https://stg-id.uaepass.ae/trustedx-resources/esignsp/v2/documents/dc_9ee0990055818516249f28558e1b256b" 
            } 
        ] 
    }
------WebKitFormBoundary7MA4YWxkTrZu0gW 
Content-Disposition: form-data; name="process"
{
  "process_type": "urn:safelayer:eidas:processes:document:sign:esigp",
  "labels": [
    [
      "digitalid",
      "server",
      "qualified"
    ]
  ],
  "signer": {
    "signature_policy_id": "urn:safelayer:eidas:policies:sign:document:pdf",
    "parameters": {
      "type": "pades-baseline",
      "signature_field": {
        "name": "Sign1",
        "location": {
          "page": {
            "number": "last"
          },
          "rectangle": {
            "x": 100,
            "y": 110,
            "height": 150,
            "width": 400
          }
        },
        "appearance": {
          "signature_details": {
            "details": [
              {
                "type": "subject",
                "title": "Signer Name: "
              },
              {
                "type": "date",
                "title": "Signature Date: "
              }
            ]
          }
        }
      }
    }
  },
  "ui_locales": [
    "en_US"
  ],
  "finish_callback_url": "http://localhost:8080/test",
  "views": {
    "document_agreement": {
      "skip_server_id": "true"
    }
  },
  "timestamp": {
    "provider_id": "urn:uae:tws:generation:policy:digitalid"
  }
}
                        
------WebKitFormBoundary7MA4YWxkTrZu0gW 
Content-Disposition: form-data; name="document"; filename="{pdf to be signed}"
Content-Type: application/pdf 
------WebKitFormBoundary7MA4YWxkTrZu0gW--                   

List of Attributes for POST Body.

Multiple signatures in a document

signature_field

Mandatory

If there is an use case to put multiple signature by multiple user , then Value of the “name” has to be changed in the above request body. In the above example, it’s now as follows for first user who sign the document. For 2nd user , it should be with different name. such as “Sign2” or any.

View the document before signing

skip_server_id

Mandatory

If there is an use case of viewing or downloading the PDF document, then Change the value of attributes “skip_server_id” to “false” in stead of “true” what it is mentioned in the above example.

Getting signature appeared on Emirate ID and put it in Digital Signature.

background_image

Optional

To get the signature from emirate Id card and put it in the Digital Signature. Attributes “background_image” to be used as follows under appearance attributes.

Value of Attribute “cardHolderSignatureImage” from user profile information to be used as value of “background_image” for the signature. "appearance": {

"background_image": {

"binary": "<<base64 image>>"

},

Putting fore ground image in digital Signature

foreground_image

Optional

"appearance": {

"foreground_image": {

"binary": "{base64 image}"

},

Digital Signature with both foreground and back ground image

background_image foreground_image

Optional

"appearance" : {

"background_image" : {

"binary" : {base64}

},

"foreground_image" : {

"binary" : {base64}

},

Which page to put the Signature

Page

Mandatory

By default, Signature can be put in last page as mentioned in above request body "page" : { "number" : "last" … },

To display the signature image or to hide the signature image on the document

appearance

Optional

If SP needs to display the signature image on the document, they can use the below.

"appearance": {

"signature_details": {

"details": [{

"type": "subject",

"title": "Signer Name: "

},

{

"type": "date",

"title": "Signature Date: "

}]

}

If SP needs to hide the signature image, they can use the below as passing the appearance parameter as blank:

"appearance": {

}

If SP needs to hide the EID from the signature image, they can use the following.

"appearance":

{ "signature_details":

{ "details":

[ {

"type": "date",

"title": "Signature Date: "

}]

}

}

If signing the same document twice, make sure that unique value is passed for the name parameter in process type of request body as below:

"name": "Sign1" for the first signature

"name": "Sign2" for the second signature

"cardHolderSignatureImage"- Retrieval of this attribute from UAE PASS is subject to approvals from ICP team.

UAEPASS communicates with the signature portal, that successfully creates the signature process and that must redirects the user's browser to (tasks.pending.url) for this process to continue.

It also communicates to the signature portal that obtain the signed document it must access (i.e., the URL resulting from concatenating /content to the URL specified in documents[0].

previous step
https://stg-id.uaepass.ae/trustedx-resources/esignsp/v2/ui?signerProcessId=sp_c4eed0a1f478f72454803695d53c4c5
https://stg-id.uaepass.ae/trustedx-resources/esignsp/v2/documents/dc_9ee0990055818516249f28558e1b256b/content