Téléversement de documents pour signature
La fonctionnalité Téléversement de documents pour signature vous permet d'intégrer, via le SDK, le téléversement sécurisé de documents devant être signés électroniquement.
Exemples d'intégration
Pour l'intégration, il est nécessaire de disposer d'un élément <iframe id='iframeId'> dans lequel le SDK sera affiché, et la fonction AucoSDK doit recevoir l'identifiant de cet élément.
Suivez le lien pour consulter la référence des événements nécessaires à l'intégration du SDK : 👉🏻 Événements
Intégration de base
import { AucoSDK } from 'auco-sdk-integration';
const unsubscribe = AucoSDK({
iframeId: 'iframeId',
sdkType: 'upload',
language: 'es', // Langues acceptées 'es' | 'en'
keyPublic: 'prk_xxxxx', // Clé privée de l'entreprise nécessaire pour créer le processus
events: {
onSDKReady,
onSDKClose,
onSDKToken,
},
sdkData: {
userAttributes: {
email: 'admin@company.com', // E-mail de l'utilisateur enregistré dans Auco, il est recommandé d'utiliser l'e-mail de l'administrateur de l'entreprise
},
uxOptions: {
primaryColor: '#021c30',
alternateColor: '#a557f2',
},
},
env: process.env.PUBLIC_ENVIRONMENT == 'dev' ? 'DEV' : 'PROD',
});
Intégration avec données personnalisées
L'attribut custom vous permet d'envoyer, dans sdkData, un objet contenant des informations personnalisées supplémentaires. Cet objet est stocké en base de données, associé au processus, et inclus dans la charge utile du webhook s'il est configuré.
import { AucoSDK } from 'auco-sdk-integration';
const unsubscribe = AucoSDK({
iframeId: 'iframeId',
sdkType: 'upload',
language: 'es', // Langues acceptées 'es' | 'en'
keyPublic: 'prk_xxxxx', // Clé privée de l'entreprise nécessaire pour créer le processus
events: {
onSDKReady,
onSDKClose,
onSDKToken,
},
sdkData: {
userAttributes: {
email: 'admin@company.com', // E-mail de l'utilisateur enregistré dans Auco, il est recommandé d'utiliser l'e-mail de l'administrateur de l'entreprise
},
custom: {
// (facultatif) Objet avec des données personnalisées, enregistré en base de données et envoyé via webhook
internalId: 'ORD-12345',
department: 'legal',
priority: 'high',
},
uxOptions: {
primaryColor: '#021c30',
alternateColor: '#a557f2',
},
},
env: process.env.PUBLIC_ENVIRONMENT == 'dev' ? 'DEV' : 'PROD',
});
Intégration avec signataires préchargés (STABLE)
Cette méthode sera dépréciée à l'avenir ; il est recommandé d'utiliser la méthode détaillée dans la section suivante.
Suivez le lien pour consulter la référence des pays et types de documents acceptés 👉🏻 Documents et pays
import { AucoSDK } from 'auco-sdk-integration';
const unsubscribe = AucoSDK({
iframeId: 'iframeId',
sdkType: 'upload',
language: 'es', // Langues acceptées 'es' | 'en'
keyPublic: 'prk_xxxxx', // Clé privée de l'entreprise nécessaire à la création du processus
events: {
onSDKReady,
onSDKClose,
onSDKToken,
},
sdkData: {
userAttributes: {
email: 'admin@company.com', // E-mail de l'utilisateur enregistré dans Auco, il est recommandé d'utiliser l'e-mail de l'administrateur de l'entreprise
},
users: [
{
name: 'Signer';
email: 'signer@auco.ai';
phone: '+573151234567';
country: 'CO';
id: '1234567890';
idType: 'CC';
}
],
uxOptions: {
primaryColor: '#021c30',
alternateColor: '#a557f2',
},
},
env: process.env.PUBLIC_ENVIRONMENT == 'dev' ? 'DEV' : 'PROD',
});
Intégration avec signataires préchargés
Cette fonctionnalité n'est disponible qu'à partir de la version v1.0.0.
Suivez le lien pour consulter la référence des pays et types de documents acceptés 👉🏻 Documents et pays
import { AucoSDK } from 'auco-sdk-integration';
const unsubscribe = AucoSDK({
iframeId: 'iframeId',
sdkType: 'upload',
language: 'es', // Langues acceptées 'es' | 'en'
keyPublic: 'prk_xxxxx', // Clé privée de l'entreprise nécessaire pour créer le processus
events: {
onSDKReady,
onSDKClose,
onSDKToken,
},
sdkData: {
userAttributes: {
email: 'admin@company.com', // E-mail de l'utilisateur enregistré dans Auco, il est recommandé d'utiliser l'e-mail de l'administrateur de l'entreprise
},
flowData: {
type: 'participants',
participants: [
{
id: 'id1',
type: 'signer',
name: 'Signer',
email: 'signer@auco.ai',
phone: '+573161979572',
country: 'CO',
identification: '123',
identificationType: 'CC',
locked: true, // Ce participant ne peut être ni modifié ni supprimé.
disableAutoSign: true, // (facultatif) Désactive la signature automatique pour ce participant
},
{
id: 'id2',
type: 'approver',
name: 'Approver',
email: 'approver@auco.ai',
phone: '+573161979572',
country: 'CO',
identification: '1234',
identificationType: 'CC',
},
{
id: 'id3',
type: 'reader',
name: 'Reader',
email: 'reader@auco.ai',
locked: true, // Ce participant ne peut être ni modifié ni supprimé.
},
],
},
uxOptions: {
primaryColor: '#021c30',
alternateColor: '#a557f2',
},
},
env: 'DEV',
});
Intégration avec flux prérempli
Dans ce type d'intégration, à l'ouverture du SDK, l'utilisateur n'a plus qu'à placer les signatures.
Cette fonctionnalité n'est disponible qu'à partir de la version v1.0.0.
Suivez le lien pour consulter la référence des pays et types de documents acceptés 👉🏻 Documents et pays
import { AucoSDK } from 'auco-sdk-integration';
const unsubscribe = AucoSDK({
iframeId: 'iframeId',
sdkType: 'upload',
language: 'es', // Langues acceptées 'es' | 'en'
keyPublic: 'prk_xxxxx', // Clé privée de l'entreprise nécessaire à la création du processus
events: {
onSDKReady,
onSDKClose,
onSDKToken,
},
sdkData: {
userAttributes: {
email: 'admin@company.com', // E-mail de l'utilisateur enregistré dans Auco, il est recommandé d'utiliser l'e-mail de l'administrateur de l'entreprise
},
flowData: {
type: 'complete',
files: [file1, file2], // Tableau de documents à téléverser (type File), Auco les fusionnera en un seul PDF
emailData: {
name: 'Flujo precargado',
message: 'Mensaje',
subject: 'Sujeto',
expire: new Date(), // (facultatif) Date d'expiration du flux
remember: '48', // (facultatif) Toutes les combien d'heures un rappel sera envoyé
notificationOff: true, // Auco n'enverra pas d'e-mails aux participants.
},
platform: 'whatsapp', // Plateforme sur laquelle les processus de signature seront réalisés ('auco' | 'whatsapp')
validations: {
otpCode: 'phone', // (facultatif) Canal par lequel l'OTP sera envoyé ('phone' | 'email')
identification: true, // Validation de la pièce d'identité
identificationCardBack: true, // Validation du verso de la pièce d'identité
selfie: true, // Validation par photo du visage
},
participants: [
{
id: 'id_1',
type: 'signer',
name: 'Signer',
email: 'signer@auco.ai',
phone: '+573151234567',
country: 'CO',
identificationType: 'CC',
identification: '1234',
disableAutoSign: true, // (facultatif) Désactive la signature automatique pour ce participant
},
{
id: 'id_2',
type: 'approver',
name: 'Approver',
email: 'approver@auco.ai',
phone: '+573151234567',
country: 'CO',
identificationType: 'CC',
identification: '1234',
},
{
id: 'id_3',
type: 'reader',
email: 'reader@auco.ai',
name: 'Reader',
},
],
},
uxOptions: {
primaryColor: '#021c30',
alternateColor: '#a557f2',
},
},
env: 'DEV',
});
Intégration d'édition de base
Dans ce type d'intégration, vous pouvez modifier un document qui n'a pas encore été signé ; les informations du document d'origine seront préremplies automatiquement.
Cette fonctionnalité n'est disponible qu'à partir de la version v1.0.3.
import { AucoSDK } from 'auco-sdk-integration';
const unsubscribe = AucoSDK({
iframeId: 'iframeId',
sdkType: 'upload',
language: 'es', // Langues acceptées : 'es' | 'en'
keyPublic: 'prk_xxxxx', // Clé privée de l'entreprise nécessaire à la création du processus
events: {
onSDKReady,
onSDKClose,
onSDKToken,
},
sdkData: {
userAttributes: {
email: 'admin@company.com', // E-mail de l'utilisateur enregistré dans Auco. Il est recommandé d'utiliser l'e-mail de l'administrateur de l'entreprise
},
flowData: {
type: 'edit',
code: 'CODEDOCUM',
keepPositions: true, // Facultatif - Conserve les positions des signatures du document d'origine
},
uxOptions: {
primaryColor: '#021c30',
alternateColor: '#a557f2',
},
},
env: 'DEV',
});
Intégration d'édition avec écrasement
Dans ce type d'intégration, vous pouvez modifier un document qui n'a pas encore été signé et écraser, dans l'intégration, les informations du document d'origine.
Cette fonctionnalité n'est disponible qu'à partir de la version v1.0.3.
Si l'intégration écrase toutes les informations du document d'origine (files, emailData, platform, validations et participants), à l'ouverture du SDK l'utilisateur n'aura plus qu'à placer les signatures.
import { AucoSDK } from 'auco-sdk-integration';
const unsubscribe = AucoSDK({
iframeId: 'iframeId',
sdkType: 'upload',
language: 'es', // Langues acceptées 'es' | 'en'
keyPublic: 'prk_xxxxx', // Clé privée de l'entreprise nécessaire à la création du processus
events: {
onSDKReady,
onSDKClose,
onSDKToken,
},
sdkData: {
userAttributes: {
email: 'admin@company.com', // E-mail de l'utilisateur enregistré dans Auco. Il est recommandé d'utiliser l'e-mail de l'administrateur de l'entreprise
},
flowData: {
type: 'edit',
code: 'CODEDOCUM',
files: [file1], // Facultatif - Tableau de documents (type File) à téléverser
emailData: {...}, // Facultatif - Configuration des e-mails et/ou des rappels
platform: 'whatsapp', // Facultatif - Plateforme sur laquelle la signature sera effectuée ('auco' | 'whatsapp')
validations: {...}, // Facultatif - Validations
participants: [...], // Facultatif - Liste de participants pour écraser ceux d'origine
keepPositions: true, // Facultatif - Conserve les positions des signatures du document d'origine
},
uxOptions: {
primaryColor: '#021c30',
alternateColor: '#a557f2',
},
},
env: 'DEV',
});