SignDocumentInit: Initialize electronic signature of a document

Version

Description

1.0

How it works

This functionality allows you to initialize an electronic signature. For now, only SDD mandates can be signed

Prequisites:

This functionality will then require 3 integration points:

  • A call to SignDocumentInit 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

Request

<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>

  
    "wlLogin":"string",
    "wlPass":"string",
    "language":"string",
    "version":"string",
    "walletIp":"string",
    "walletUa":"string",
    "wallet":"string",
    "mobileNumber":"string",
    "documentId":"string",
    "documentType":"string",
    "returnUrl":"string",
    "errorUrl":"string"
}

Item

Description

Mandatory

Format

Example

wallet

Id of the wallet

Yes

[0 : 256] char

taxi67

mobileNumber

Required if no mobile number is already assigned to the payment account (using RegisterWallet or UpdateWalletDetails)
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 try to use the token, the Yousign service might reject it and forward the end-user to the errorUrl.

Depends

[6 : 30] char

33612345678

documentId

ID of SDD mandate to sign: obtained after a call to RegisterSddMandate

Yes

int

46

documentType

Use "21" for SDD mandate.

Yes

int

21

returnUrl

WHITE BRAND return URL, called by WEBKIT to terminate the operation

Yes

[1 : 2000] char

https://www.yoursite.com/signature_return.php

errorUrl

WHITE BRAND return URL, called by WEBKIT in case of an error

Yes

[1 : 2000] char

https://www.yoursite.com/signature_error.php

Answer

<?xml version="1.0" encoding="utf-8"?>
<SIGNDOCUMENT>
	<TOKEN>string</TOKEN>
</SIGNDOCUMENT>
{  
    "SIGNDOCUMENT":{  
        "TOKEN":"string"
    }
}

Item

Description

Example

TOKEN

Payment token to use as GET parameter when redirecting your user to the WEBKIT.

Note: the token can be used as long as the mandate is not successfully signed, so even if the user comes back to your error page (if the user cancelled for example), you can still submit the same token to the WEBKIT.

63458771evCKM8Wn6GPt44HgcRt56gRerAp

Once you've got the token, use the Webkit to sign your document: WEBKITURL?signingtoken=token