/sign

POST

Crée une demande de signature.

Lance une demande de signature. La personne signe exactement le texte que vous envoyez dans userVisibleData. Utilisez la méthode /collect pour connaître l’état de la demande.

Corps de la requête

application/json

/sign prend les mêmes paramètres que /auth, avec ces différences :

userVisibleData chaîne Obligatoire

Le texte à signer, affiché à l’utilisateur. Il doit être encodé en UTF-8 puis en Base64. 40 000 caractères au plus (texte décodé).

Ce qui n’est pas dans ce texte n’est pas signé : écrivez le montant, le bénéficiaire, l’objet.

userVisibleDataFormat chaîne

plaintext ou simpleMarkdownV1. Voir Mise en forme du texte.

userNonVisibleData chaîne

Données de votre choix en Base64, non montrées à la personne. Elles vous sont renvoyées dans completionData. Elles ne font pas partie du texte signé.

Les paramètres endUserIp (obligatoire), returnUrl, returnRisk, app, web et requirement sont identiques à ceux de /auth.

Exemples

Signature d’un virement, adressée à une personne

{
  "endUserIp": "196.28.245.10",
  "userVisibleData": "VmlyZW1lbnQgZGUgNDUwIDAwMCBGQ0ZBIHZlcnMgUi4gS2Fib3LDqQ==",
  "requirement": { "personalNumber": "B1234567" }
}

Signature d’un contrat avec texte mis en forme

{
  "endUserIp": "196.28.245.10",
  "userVisibleDataFormat": "simpleMarkdownV1",
  "userVisibleData": "IyBDb250cmF0IGRlIHByw6p0Ck1vbnRhbnQgOiAqKjEgMjAwIDAwMCBGQ0ZBKio=",
  "userNonVisibleData": "eyJjb250cmF0IjoiMjAyNi0wNDEyIn0="
}

Réponses

200 · Requête réussie

La réponse est identique à celle de /auth : orderRef, autoStartToken, qrStartToken, qrStartSecret.

{
  "orderRef": "6b0e2c34-8f9a-4a47-b0b1-3c1d5a7e2f10",
  "autoStartToken": "3f1c0d6e-9a24-4b8e-8f43-6c1f2f7a90aa",
  "qrStartToken": "a41d8e0b-52c7-4d39-9e66-0b7c2f1a8d54",
  "qrStartSecret": "0c9b7a1e-6d58-4f0b-a2b3-9d41e6c8f7a5"
}

Les erreurs sont décrites dans Erreurs. Une signature sans userVisibleData renvoie 400 invalidParameters.