Demander des pièces justificatives

Vous pouvez demander des pièces justificatives à un participant dans le cadre du processus de signature. Une fois ces documents saisis, ils sont hachés, horodatés et ajoutés à la transaction. Vous pouvez spécifier les documents requis parmi les suivants :

  • Documents d’identité :
    • Carte d’identité
    • Permis de conduire
    • Passeport
    • Carte de séjour
  • Justificatif de domicile
  • Relevé d’Identité Bancaire (RIB)
  • Relevé bancaire
  • Relevé d’imposition
  • Fiche de paie
  • Kbis
  • Autre

Si vous demandez le même document_type plusieurs fois pour le même actor, vous devez fournir un tag de votre choix afin de distinguer chaque demande. Sinon, votre demande écrasera la précédente.

Au-delà de la simple collecte des pièces justificatives, vous pouvez également avoir besoin d’un contrôle des documents. La fonction contrôle des documents reconnaît et classe automatiquement les documents collectés, éliminant ainsi la nécessité d’une indexation manuelle et réduisant le risque d’erreur de saisie.

Avant de demander le contrôle des documents capturés, assurez-vous que la fonction contrôle des documents est activée sur votre espace de travail.

Selon le type de document, vous devrez peut-être prendre en compte les paramètres freshness_limit ou covered_period.

  • La freshness_limit d’un document est la durée après sa date d’émission pendant laquelle son contenu est considéré comme valide, exact et à jour.

  • La covered_period d’un document est la période à laquelle le contenu du document s’applique.

L’utilisation de ces paramètres de contrôle dépend de l’activation ou non de la fonctionnalité contrôle des documents dans votre espace de travail :

  • Si la fonctionnalité n’est pas activée, vous devez inclure manuellement ces contrôles dans vos demandes.

  • Si la fonctionnalité est activée, vous devez contacter votre gestionnaire de compte pour configurer ces contrôles comme paramètres par défaut pour votre espace de travail.

Notez que vous pouvez également ajouter des instructions pour mieux guider le participant (uniquement si la fonctionnalité contrôle des documents n’est pas activée sur votre espace de travail).

Demander des pièces d’identité

Pour demander une ou plusieurs pièces d’identité, envoyez une requête à POST/v1/transactions/{transaction_id}/captures/identity_document. Vous devez spécifier le nombre de documents requis parmi ceux qui sont acceptés. Par exemple, vous pouvez préciser si le participant doit fournir une carte d’identité ou un passeport, ou si les deux sont requis.

Dans l’exemple de requête suivant, le participant doit fournir une carte d’identité et un passeport (le nombre de accepted_identity_documents est égal au nombre de total_items_required).

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/identity_document \
-d [email protected] \
-d accepted_identity_documents=identity_card \
-d accepted_identity_documents=passport \
-d total_items_required=2 \
-d guideline=Le document doit être en couleur.

Demander un justificatif de domicile

Pour demander un justificatif de domicile, envoyez une requête à POST/v1/transactions/{tx_id}/captures/address_proof.

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/address_proof \
-d [email protected] \
-d guideline=Veuillez joindre un justificatif de domicile datant de moins de 6 mois.

Si la fonctionnalité contrôle des documents n’est pas activée, vous devez ajouter l’argument freshness_limit à votre requête, comme dans l’exemple ci-dessous. Les valeurs possibles sont :

  • 3 : la date de publication du document doit remonter à moins de 3 mois (valeur par défaut).
  • 6 : la date de publication du document doit être inférieure à 6 mois.
  • 12 : la date de publication du document doit être inférieure à 12 mois.
curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/address_proof \
-d [email protected] \
-d guideline=Veuillez joindre un justificatif de domicile datant de moins de 6 mois.
-d freshness_limit=6

Demander les coordonnées bancaires (IBAN)

Pour demander les coordonnées bancaires (IBAN), envoyez une requête à POST/v1/transactions/{tx_id}/captures/iban. Dans l’exemple suivant, nous demandons deux IBAN : nous devons donc transmettre un identifiant pour différencier les requêtes :

curl 
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/iban \
-d [email protected] \
-d tag=personnel \
-d guideline=Veuillez joindre votre IBAN personnel. 
curl 
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/iban \
-d [email protected] \
-d tag=professionnel \
-d guideline=Veuillez joindre votre IBAN professionnel. 

Demander un relevé bancaire

Pour demander un relevé bancaire, envoyez une requête à POST/v1/transactions/{tx_id}/captures/bank_statement.

curl 
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/bank_statement \
-d [email protected] \
-d guideline=Veuillez joindre votre relevé bancaire couvrant les 4 derniers mois.

Si la fonctionnalité contrôle des documents n’est pas activée, vous devez spécifier la période souhaitée via l’argument covered_period. Pour les relevés bancaires, la covered_period est exprimée en mois et les valeurs possibles vont de 1 pour le mois écoulé à 6 pour les 6 derniers mois (la valeur par défaut est 3). Dans l’exemple ci-dessous, nous demandons un relevé bancaire couvrant les 4 derniers mois.

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/bank_statement \
-d [email protected] \
-d guideline=Please attach your bank statement covering the past 4 months. \
-d covered_period=4

Demander des avis d’imposition

Pour demander un avis d’imposition, envoyez une requête à POST/v1/transactions/{tx_id}/captures/tax_statement.

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/tax_statement \
-d [email protected] \
-d guideline=Veuillez joindre vos avis d'imposition des 3 dernières années.

Si la fonctionnalité contrôle des documents n’est pas activée, vous devez spécifier la période souhaitée via l’argument covered_period. Pour les avis d’imposition, la covered_period est exprimée en années et les valeurs possibles vont de 1 pour l’année écoulée à 5 pour les 5 dernières années (la valeur par défaut est 2). Dans l’exemple ci-dessous, nous demandons les déclarations fiscales couvrant les 3 dernières années.

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/tax_statement \
-d [email protected] \
-d guideline=.Veuillez joindre vos avis d'imposition des trois dernières années. \
-d covered_period=3

Demander une fiche de paie

Pour demander une fiche de paie, envoyez une requête à POST/v1/transactions/{tx_id}/captures/pay_slip.

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/pay_slip \
-d [email protected] 

Si la fonctionnalité contrôle des documents n’est pas activée, vous devez spécifier la période souhaitée via l’argument covered_period. Pour les fiches de paie, la covered_period est exprimée en mois et les valeurs possibles vont de 1 (mois précédent) à 6 (six derniers mois) (la valeur par défaut est 3). Dans l’exemple ci-dessous, nous demandons une ficher de paie couvrant les quatre derniers mois.

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/pay_slip \
-d [email protected] \
-d guideline=Veuillez joindre vos fiches de paie des quatre derniers mois.
-d covered_period=4

Demander un kbis

Pour demander un kbis, envoyez une requête à POST/v1/transactions/{tx_id}/captures/kbis.

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/kbis \
-d [email protected]
-d guideline=Veuillez joindre votre kbis datant de moins de six mois.

Si la fonctionnalité contrôle des documents n’est pas activée, vous devez ajouter l’argument freshness_limit à votre requête, comme dans l’exemple ci-dessous. Les valeurs possibles sont :

  • 3 : la date de publication du document doit remonter à moins de 3 mois (valeur par défaut).
  • 6 : la date de publication du document doit être inférieure à 6 mois.
  • 12 : la date de publication du document doit être inférieure à 12 mois.
curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/kbis \
-d [email protected] \
-d freshness_limit=6

Demander d’autres types de documents

Lorsque vous demandez un type de document other, vous devez indiquer un name pour ce document afin que le participant sache ce qui est attendu.

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/other \
-d [email protected] \
-d guideline=Veuillez joindre votre carte vitale. \
-d tag=vitale \
-d name=vitale

Supprimer une demande de pièces justificatives

Pour supprimer une demande de pièce justificatives, envoyez une requête à POST /v1/transactions/{transaction_id}/captures/, transmettez le paramètre booléen delete et définissez-le à true :

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/identity_document \
-d [email protected] \
-d document_type=identity_document \
-d delete=true

Gérer une alerte pour un participant inactif
Discuter avec un participant
Espace Développeur
Guides
Services
Référence API