eID Easy signing service allows your customers to fill in the blanks in document template and sign the document right after that.
Example form signing: Demo Contract
To get started go HERE and create your first contract template. Then just copy-paste piece of code (iFrame) to your webpage and that’s it.
Examples and API doc
Full API documentation in Postman is available at https://documenter.getpostman.com/view/3869493/Szf6WoG1. There is also sample app that you can take as a reference https://demo.eideasy.com/
Custom PDF document signing
In some cases the document template still does not give you enough flexibility. In this case it is possible to sign your own prepared PDF. Process contains 2 steps like enhanced contract templates.
Firstly document will be sent via HTTP POST with 3 mandatory URL parameters: client_id, secret and filename. client_id and secret are taken from eID Easy admin and filename can be whatever you like it to be in the signed doc. Call is sent to POST https://id.eideasy.com//api/signatures/prepare-files-for-signing.
POST body is JSON with following fields: client_id, secret, filename, file_content. file_content here is in base64 format. For example:
{“client_id”:”j9FXBpH0SMfipcDoArwxbq8ipF7xqiex”, “secret”:”j9FXBpH0SMfipcDoArwxbq8ipF7xqiex”, “filename”:”my_doc_to_be_digned.pdf”, “file_content”:”UEsDBBQAAAgAAHI6z06KIflFHwAA”}
Response to above call is JSON. If successful then the status will be OK and doc_id value is string like {“status”:”OK”,”doc_id”:”rawaQxqrlYrsaGvslt7JFFCcMYztXHHwedFMPbze”} . If there is error then status is error with message like {“status”:”error”,”message”:”Missing filename for the document”} .
Second step is redirecting the customer to the signing page. Page can also be embedded in the iFrame for smoother experience. URL for the signing page needs to have 2 GET parameters: client_id and doc_id. Example of the signing page URL is this https://id.eideasy.com/sign_contract_external?client_id=j9FXBpH0SMfipcDoArwxbq8ipF7xqiex&doc_id=rawaQxqrlYrsaGvslt7JFFCcMYztXHHwedFMPbze
Adding signature to existing signed file
If you need to sign file by multiple people and you have the signed bdoc or asice container and need to add signature there then follow these steps
Prepare the bdoc or asice file for adding the signature. Send HTTP POST with 4 params client_id, secret, filename and container. Container is base64 encoded container value. For example {“client_id”:”j9FXBpH0SMfipcDoArwxbq8ipF7xqiex”, “secret”:”j9FXBpH0SMfipcDoArwxbq8ipF7xqiex”, “filename”:”my_signed_doc.asice”,”container”:”UEsDBBQAAAgAAHI6z06KIflFHwAA”}.
Call is sent to https://id.eideasy.com/api/signatures/prepare-add-signature
Response to above call is JSON. If successful then the status will be OK and doc_id value is string like {“status”:”OK”,”doc_id”:”rawaQxqrlYrsaGvslt7JFFCcMYztXHHwedFMPbze”} . If there is error then status is error with message like {“status”:”error”,”message”:”Missing filename for the document”} .
Second step is redirecting the customer to the signing page. Page can also be embedded in the iFrame for smoother experience. URL for the signing page needs to have 2 GET parameters: client_id and doc_id. Example of the signing page URL is this https://id.eideasy.com/add-signature?client_id=j9FXBpH0SMfipcDoArwxbq8ipF7xqiex&doc_id=rawaQxqrlYrsaGvslt7JFFCcMYztXHHwedFMPbze
Enhanced contract templates
It is also possible to personalize the contract before showing it to the customer and asking him to sign it. It is useful if you want to pre-fill the contract with products or services that customer wants to buy. Pre-filling fields can be done over API query https://id.eideasy.com/api/signatures/prefill-form-fields
This call must have client_id and secret values that you got when you registered your website with eID Easy. In post boby are also 2 important fields
tag_values – fill the form field so that the user is not able to change the value
tag_defaults – set default values for the form so that user can change these values
Example:
"tag_values": {
"Firstname": "Toomas",
"Lastname": "Ilves"
},
"tag_defaults": {
"Phone": "+37255529332"
}Field values are remembered up to 24h, after this time passes the API call must be done again to get new code.
Returned value is also JSON object with status either “OK” or “error”. If status is “OK” then there is another field “code” which value is needed in next step where you redirect the customer to sign the contract page. If the status is “error” then it includes “message” which contains details of what exactly went wrong.
Final step is to customize the signing page iframe url parameters and add the code value from the first step. Example sign page url with some blanks prefilled by the API call is https://id.eideasy.com/sign_contract?client_id=j9FXBpH0SMfipcDoArwxbq8ipF7xqiex&contract_id=5&code=K3kCchQxer97IGX8W1NcCQ2OITHc0XCtcPP4wccy
Downloading signed file after signature
Signed file can be downloaded over the API after signature has been created and user redirected back to your site.
API call POST https://id.eideasy.com/api/signatures/download-signed-asice needs to have parameters client_id, secret and doc_id.
Successful response will be JSON {“status”:”OK”,”signed_file_contents”:”base64 encoded file content”,”signer_id”:”signer personal ID code”,”filename”:”signed_doc.ascide”}
Optional url parameters
- enabled_methods – comma separated list of methods that are allowed for signing at this moment. Possible options are &enabled_methods=id-signature,mid-signature,smart-id-signature
- signature_redirect – tells where to redirect the user after signature is completed. You can customize it to your own needs and set the state needed after signing is finished, add items to add to shopping cart etc. signature_redirect=https://shop.com/add_to_cart.php?item=123
- nodownload – by default after the signing the signed container will be downloaded to user computer. If this is not needed and you want to display signed file only in your own systems then set &nodownload=true
- noemails – dy default the notification e-mail is sent after every signature. If you are dealing with automated system and do not need to get e-mail every time then turn the e-mails off with &noemails=true
- email_extra – if you prefer to get e-mail notifications and know who or what is the signature about then send any values here that you wish to add to the e-mail subject. Example &email_extra=Kersti+Kaljulaud+drone+flight+permission+application+drooniluba
- country – when using Smart-ID signatures then allows you to preselect country value. Default “EE” and options EE, LT, LV. Make sure these are uppercased
- idcode – when using Smart-ID signatures then allows you to prefill idcode value
- mobileno – when using Mobil ID signatures then allows to prefill mobile number field