Generate Aadhaar Esign URL

5 min

Generate the Aadhaar Esign URL to sign the Contract.

Endpoint

/api/onboardings/execute

Headers

Property	Value
Content-type	application/json
Authorization	…access token… (alphanumeric string of length 64)

Input

{
    "merchantId":".. merchant ID ..",
    "inputData":{
        "service": "esign",
        "type": "",
        "task": "createEsignUrl",
        "data": {
            "inputFile": ".. Unsigned PDF contract URL ..",
            "signatureType": "aadhaaresign",
            "redirectUrl": ".. redirect URL ..",
            "redirectTime": ".. redirect time in seconds ..",
            "eventCallbackUrl": ".. event Callback Url ..",
            "eventCallbackHeaders": { 
                " ..key.. ":".. value .."
            }
        }
    }
}

Property	Data Type	Example Values
merchantId	String (Required) alphanumeric string of length 24	userId from the investor login response field
inputData	Object (Required)	payload
–service	Enum String (Required)	“esign”
–task	Enum String (Required)	“createEsignUrl”
–data	Object (Required)	payload
—-inputFile	URL String (Required)	Unsigned PDF contract URL (response from Create Contract PDF URL)
—-signatureType	ENUM Sting (Required)	“aadhaaresign”
—-redirectUrl	ENUM Sting (optional)	“redirect URL”
—-redirectTime	number Integer (optional)	“redirect time in seconds”
—-eventCallbackUrl	URL String (Optional)	Callback on events of success and failure
—-eventCallbackHeaders	Object (Optional)	In case of any headers needs to be passed for the eventCallbackUrl

Expected Output

{
    "object": {
        "task": "url",
        "id": "....",
        "customerId": "....",
        "inputFile": "..inputUrl..",
        "signatureType": "aadhaaresign",
        "multiPages": "true",
        "name": "..name..",
        "showSignatureConsent": "...",
        "email": "...emailId...",
        "redirectUrl": "... redirect Url ...",
        "createSignatureOptions": [],
        "result": {
            "token": "..token..",
            "isUsed": 1,
            "url": "..Aadhaar Esign Url...",
            "uid": "",
            "inputFile": "..inputUrl..",
            "email": "...emailId...",
            "redirectUrl": "... redirect Url ...",
            "createSignatureOptions": [],
            "signatureType": "aadhaaresign",
            "name": "..name..",
            "showSignatureConsent": "...",
            "scaleSignature": "...",
            "selectPage": 1,
            "signaturePosition": "Bottom-Right",
            "pageNo": 1
        }
    }
}

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].