SignDocumentInit
How it works
This functionality allows you to generate an electronic signature. Currently, only SDD mandates can be signed with this method.
Requirements:
- A Mandate needs to be registered with Register an SDD Mandate
Three steps to follow for this method :
- A call to SignDocumentInit: Generate an electronic signature of a document of DirectKit to initialize the signature request and get a token
- A redirection from your website to the WebKit, with the token in GET parameter, see Finalize Document Signature
- A return page where your user will be redirected after the signature
XML
<SignDocumentInit xmlns="Service_mb">
<wlLogin>string</wlLogin>
<wlPass>string</wlPass>
<language>string</language>
<version>string</version>
<walletIp>string</walletIp>
<walletUa>string</walletUa>
<wallet>string</wallet>
<mobileNumber>string</mobileNumber>
<documentId>string</documentId>
<documentType>string</documentType>
<returnUrl>string</returnUrl>
<errorUrl>string</errorUrl>
</SignDocumentInit>
<?xml version="1.0" encoding="utf-8"?>
<SIGNDOCUMENT>
<TOKEN>string</TOKEN>
</SIGNDOCUMENT>
JSON
{
"wlLogin":"string",
"wlPass":"string",
"language":"string",
"version":"string",
"walletIp":"string",
"walletUa":"string",
"wallet":"string",
"mobileNumber":"string",
"documentId":"string",
"documentType":"string",
"returnUrl":"string",
"errorUrl":"string"
}
{
"SIGNDOCUMENT":{
"TOKEN":"string"
}
}
Request Input Description
| Item | Description | Mandatory | Format | Example |
|---|---|---|---|---|
| wallet | Payment account ID | Yes | [0: 256] char | taxi67 |
| mobileNumber | Required if no mobile number is already assigned to the payment account (using RegisterWallet or UpdateWalletDetails) | Depends | [6: 30] char | 33612345678 |
| The format must be MSISDN: international number with country code, without "+" and "00". | ||||
| Even in test mode, please use a mobile number that belongs to you, as a code will be sent by SMS during the signature process. | ||||
| If you use the wrong format number, LemonWay will still create the token for you, but later, when the end-user tries to use the token, the Yousign service might reject it and forward the end-user to the errorUrl. | ||||
| documentId | Mandate ID to sign: output of the call RegisterSddMandate | Yes | int | 46 |
| documentType | Use "21" for SDD Mandate | Yes | int | 21 |
| returnUrl | You return the URL, called by WebKit to terminate the operation | Yes | [1: 2000] char | https://www.yoursite.com/signature_return.php |
| errorUrl | You return the URL, called by WebKit in case of an error | Yes | [1: 2000] char | https://www.yoursite.com/signature_error.php |
Response Output Description
| Item | Description | Example |
|---|---|---|
| TOKEN | Payment token to use as GET parameter when redirecting your user to the WebKit. | 63458771evCKM8Wn6GPt44HgcRt56gRerAp |
| The token can be re-used. | ||
Once you've got the token,
Use the Webkit to sign your document: WEBKITURL?signingtoken=token
The link is not re-useable.
Once you open it, the end-user has to go to the end of the signing process, or else you will have to re-generate another token for him.