Sign in

v1

latestOpenAPI 3.0.02026-07-2691259477.2 KB
Accounts | Admin

Generate an Electronic Signature of a Document

This call lets you to generate an electronic signature.

Note: Only SDD mandates can be signed with this method.

Prerequisite: A Mandate needs to be registered with RegisterSddMandate

  1. A call to SignDocumentInit of DirectKit to make the signature request and get a token.
  2. A redirection from your website to the WebKit, with the token in GET parameter (see Finalize document signature).
  3. A return page where your user will be redirected after the signature.
post/v2/accounts/{accountid}/documents/{documentid}/signinit

Path parameters

accountidstring required

Account Id

documentidinteger required

Headers

Authorizationstring required

Authorization bearer (OAuth 2)

PSU-Accept-Languagestring

Response language accepted by final client (PSU). English by default

PSU-IP-Addressstring required

IP address of the final client (PSU).

PSU-User-Agentstring

User-agent of the final client (PSU).

Request body

mobileNumberstring

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

typeinteger

Use 21 for SDD mandate

returnUrlstring

Your website will the return URL, called by WEBKIT to terminate the operation.

errorUrlstring

You site will return the URL, called by WEBKIT in case of an error.

Example request

{
  "mobileNumber": "33612345878",
  "type": 21,
  "returnUrl": "https://www.yoursite.com/signature_return.php",
  "errorUrl": "https://www.yoursite.com/signature_return.php"
}

Response

OK

signDocumentstring

Payment token to use as GET parameter when redirecting your user to the WEBKIT. 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.