Préremplissage des données d'un document

POST/document/prebuildclé privéeprk_

Ce service permet de créer un processus de signature à partir d'un document personnalisé en ne préremplissant qu'une partie des informations et en l'envoyant à un destinataire qui complétera les données restantes. Contrairement à la création de document, où toutes les valeurs nécessaires à la génération du document sont envoyées en une seule fois, le processus est ici créé à l'état en cours avec les champs préremplis et attend que le destinataire renseigne les informations en attente.

C'est utile lorsqu'une partie (par exemple, votre organisation) connaît déjà certaines données du document et souhaite les laisser renseignées, tandis que l'autre partie (le destinataire) doit fournir le reste avant de signer.

info

Les champs pouvant être préremplis sont définis dans la configuration du document personnalisé. Avant d'intégrer cet endpoint, vous devrez peut-être consulter les variables du document et, le cas échéant, comment définir les positions de signature et les configurations de validation d'identité.

Étapes pour préremplir un document :

1. Consulter le document personnalisé : identifiez le document personnalisé que vous souhaitez utiliser et obtenez son _id.
2. Identifier les variables préremplissables : consultez les variables du document pour savoir lesquelles vous pouvez préremplir.
3. Construire le tableau preBuild : assemblez la liste des paires key / value avec les données que vous souhaitez laisser renseignées.
4. Envoyer la requête : effectuez la requête (POST) en indiquant le destinataire (emailTo) qui complétera les informations restantes.

Vous trouverez ci-dessous les paramètres nécessaires à ce service, ainsi que des exemples et les réponses possibles du système.

---

Authentification

Incluez votre clé privée dans l'en-tête Authorization.

Authorization: prk_xxx...

---

Paramètres de préremplissage

Nom	Type	Description
email	String obligatoire	E-mail du créateur du processus.
name	String obligatoire	Nom du processus du document.
document	String obligatoire	ID du document personnalisé à partir duquel le processus est créé.
preBuild	Array obligatoire	Liste d'objets contenant les données préremplies dans le document. Seules les variables activées pour le préremplissage dans la configuration du document sont acceptées.
preBuild[x].key	String obligatoire	Nom de la variable enregistrée dans le document.
preBuild[x].value	String obligatoire	Valeur attribuée à la variable.
sign	Boolean obligatoire	Définit si le processus se déroulera par signature. Si false, le document sera envoyé par e-mail pour impression.
notification	Boolean obligatoire	Définit si le destinataire (emailTo) est notifié une fois le processus créé afin qu'il puisse compléter les informations.
emailTo	String obligatoire	E-mail du destinataire qui doit compléter les données restantes du document.
folder	String conditionnel	Chemin du dossier où le processus sera enregistré. Le dossier doit exister et appartenir au créateur du processus.
camera	Boolean facultatif	Indique si la validation par photo est obligatoire, par défaut false.
otpCode	Boolean facultatif	Indique si la validation par code OTP est obligatoire, par défaut false.
options	Object facultatif	Spécifications de la validation d'identité. En savoir plus
expiredDate	Date facultatif	Date d'expiration du document. Elle doit être supérieure à 3 jours à compter de la date de création et est envoyée au format Date JSON.

---

🧪 Exemples d'utilisation

astuce

Vous pouvez copier n'importe lequel des exemples selon votre langage préféré.

• Dans preBuild, n'envoyez que les variables que vous souhaitez préremplir ; le destinataire complétera le reste.
• Les numéros de téléphone doivent inclure l'indicatif du pays, par exemple : +57, +1, +52...

Préremplissage des données

curl

curl --location 'https://api.auco.ai/v1.5/ext/document/prebuild' \
--header 'Authorization: prk_private_key_company' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "example@auco.ai",
    "name": "Employment contract - Juan Pérez",
    "document": "64823dc5ce28a265e02d68f3",
    "sign": true,
    "notification": true,
    "emailTo": "juan.perez@example.com",
    "preBuild": [
        {
            "key": "company_name",
            "value": "Auco SAS"
        },
        {
            "key": "position",
            "value": "Backend Developer"
        }
    ]
}'

Python

import requests
import json

url = "https://api.auco.ai/v1.5/ext/document/prebuild"

payload = json.dumps({
  "email": "example@auco.ai",
  "name": "Employment contract - Juan Pérez",
  "document": "64823dc5ce28a265e02d68f3",
  "sign": True,
  "notification": True,
  "emailTo": "juan.perez@example.com",
  "preBuild": [
    {
      "key": "company_name",
      "value": "Auco SAS"
    },
    {
      "key": "position",
      "value": "Backend Developer"
    }
  ]
})
headers = {
  'Authorization': 'prk_private_key_company',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Node.js

const axios = require('axios');
let data = JSON.stringify({
  email: 'example@auco.ai',
  name: 'Employment contract - Juan Pérez',
  document: '64823dc5ce28a265e02d68f3',
  sign: true,
  notification: true,
  emailTo: 'juan.perez@example.com',
  preBuild: [
    {
      key: 'company_name',
      value: 'Auco SAS',
    },
    {
      key: 'position',
      value: 'Backend Developer',
    },
  ],
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.auco.ai/v1.5/ext/document/prebuild',
  headers: {
    Authorization: 'prk_private_key_company',
    'Content-Type': 'application/json',
  },
  data: data,
};

axios
  .request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

---

📥 Exemples de réponses

Création du processus

{
  "document": "DOCUMENTCODE"
}

---

⚠️ Réponses d'erreur

Code	Description
400	Paramètres manquants, le document n'existe pas ou une variable ne correspond pas à la configuration du document
401	Authentification invalide ou manquante