eSign.AIeSign.AI
Centre de développement

Ajouter un document à signer

POST /esignglobal/v1/envelope/files/addSignFiles

Description de l'interface

Lorsque l'enveloppe n'est pas ouverte, il est possible d'ajouter des documents à signer à l'enveloppe. Une fois l'enveloppe ouverte, il n'est plus possible d'ajouter des documents à signer.

Paramètres de requête

Nom du paramètre

Type

Obligatoire

Description

envelopeId

string

true

ID de l'enveloppe

signFiles

array

true

Ensemble des informations sur les documents à signer, affichés dans l'ordre d'ajout des fichiers.

 

fileKey

string

true

fileKey du document à signer, uniquement au format PDF

 documentFieldsarrayfalseListe des contrôles dimensionnels du fichier. Utilisés pour ajouter des contrôles dimensionnels du fichier non liés à un signataire spécifique sur le fichier indiqué.
  

fieldType

string

false

Type de contrôle. La valeur eMeterai indique le contrôle relatif aux droits de timbre indonésiens.

  

pageNo

string

false

Numéro de page où se trouve le contrôle. Le contrôle relatif aux droits de timbre indonésiens ne prend en charge qu'une seule page spécifiée ; vous devez transmettre un numéro de page unique. Les formats de pages multiples continues ou non continues tels que 1-3 ou 1,3 ne sont pas pris en charge.

  posXfloatfalseDécalage selon l'axe x, avec l'origine des coordonnées située en bas à gauche de la page. La plage de coordonnées est identique à celle des autres contrôles.
  posYfloatfalseDécalage selon l'axe y, avec l'origine des coordonnées située en bas à gauche de la page. La plage de coordonnées est identique à celle des autres contrôles.

Exemple de requête

{   
  "envelopeId": "9fbe6c8190824227bde29136b0145c81",
  "signFiles": [
  {
    "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
  }
]
}

Paramètres de réponse

Nom du paramètre

Type

Description

code

int

Code métier, 0 indique le succès, une valeur non nulle indique une erreur.

message

string

Information métier

[Remarque] Veuillez déterminer les erreurs en fonction du code. Ne vous fiez pas à la correspondance avec le message, car celui-ci peut être modifié.

data

object

Données métier

Exemple de réponse

{
    "code": "0",
    "message": "success",
    "data": null
}