Ajouter un document

Vous pouvez ajouter jusqu’à 20 documents à votre transaction. Nous acceptons les formats PDF, Word et images, avec une taille maximale de 25 Mo par document (50 Mo si la fonctionnalité Fichiers volumineux est activée sur votre espace de travail). Le document final (le document signé) est toujours au format PDF.

L’ajout d’un document à une transaction se fait en deux étapes.

Importer votre fichier sur les serveurs Universign

Avant de pouvoir ajouter le document à votre transaction, vous devez le télécharger sur nos serveurs. Pour ce faire, envoyez une requête multipart/form-data à POST /v1/files et transmettez le document (au format PDF, Word ou image) dans l’argument file :

curl
https://api.universign.com/v1/files \
-F [email protected]

l’API renvoie un file ID :

{
  "object" : "file",
  "id" : "file_d0bDo8LgEkEA",
}

Notez que nous conservons le fichier pendant 24 heures afin que vous puissiez réutiliser l’identifiant du fichier pendant cette période.

Ajouter l’identifiant du fichier à votre demande de transaction

Pour ajouter l’identifiant du fichier à votre transaction, envoyez une demande à POST /v1/transactions/{transaction_id}/documents et transmettez l’identifiant du fichier dans l’argument document.

Remaque: Vous devez envoyer une requête par document.

curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/documents \
-d document=file_d0bDo8LgEkEA \
-d name=DocName

Vous pouvez transmettre d’autres arguments optionnels :

• archiving_configuration_id : l’identifiant de la configuration d’archivage des documents signés. À récupérer depuis votre espace de travail. Pour plus de détails sur la configuration d’archivage, consultez Archiver les documents signés.

• compliance_policy : à définir sur pdfa pour forcer l’opération de scellement/signature à respecter la norme PDF/A. Si non défini, l’import d’un document PDF/A entraînera son scellement/signature sans garantie de conformité PDF/A.

PDF/A est un format normalisé ISO (ISO 19005) avec des règles strictes visant à éliminer tout ce qui pourrait se dégrader avec le temps.

PDF/A est couramment requis lorsque des documents doivent être archivés, échangés ou conservés à des fins légales.

Vous pourriez avoir besoin de sceller/signer un document PDF/A tout en garantissant le même niveau de conformité une fois scellé/signé.

L’API renvoie un identifiant de document. Le nom du document correspond par défaut au nom du fichier :

{
    "id": "doc_wWz6",
    "name": "myDocument.pdf",
    "updatable": true,
    "deletable": true,
    "fields": []
}

Importer un document à partir d’une URL (demande de transaction complète uniquement)

Si vous envoyez une Full transaction request, vous pouvez importer un document directement à partir d’une URL. Cette fonctionnalité vous permet de contourner les contraintes liées au téléchargement de documents.

Notez que cette fonctionnalité doit être activée sur votre espace de travail. Si vous souhaitez l’activer, vous devez contacter votre gestionnaire de compte chez Universign.

Vous devez d’abord autoriser l’URL dans votre espace de travail. Pour plus d’information, consultez URL des documents.

Ensuite, dans votre Full transaction request, transmettez l’URL dans l’argument URL. Notez que l’argument URL ne doit pas être transmis si le document content ou file_id est défini.

Important : Assurez-vous que l’URL mène au document lui-même et non à son emplacement.

"documents" : [{
    "url" : "https://getsamplefiles.com/download/pdf/sample-1.pdf",
    "name" : "MyDoc", 
    "fields" : [
        {
      "id" : "field_id_1",
      "name" : "signature field",
      "page" : 1,
      "x" : 150,
      "y" : 275,
      "type" : "signature",
      "consents" : [ "I hereby accept the terms and conditions stated in this document!" ],
      "optional_consents" : [ "I accept to fill a satisfaction form once the signature process is completed!" ] 
    },{
      "id" : "field_id_2",
      "name" : "signature field 2",
      "page" : 1,
      "x" : 175,
      "y" : 200,
      "type" : "signature"
    }]
  }],

---

Gérer les options d'affichage

← Précédent

Supprimer un document

Suivant →