Il peut être nécessaire que votre participant s’authentifie avant de pouvoir signer les documents d’une transaction. Nous supportons actuellement 3 cas d’usage :
- authentification par SMS OTP,
- authentification par email,
- signature sans authentification.
Authentification par SMS OTP
Si vous autorisez l’authentification par SMS OTP, définissez le numéro de téléphone du participant lors de la configuration de votre transaction.
Pour vous assurer que votre participant reçoive bien l’OTP par SMS, vérifiez d’abord que le numéro de téléphone provient d’un pays inclus dans cette liste.
Vous devez transmettre deux paramètres pour spécifier le numéro de téléphone d’un participant dans une transaction :
-
phone_number: permet de définir le numéro de téléphone du participant. Le format attendu est E.164 ([+][indicatif pays][numéro incluant l’indicatif régional]). -
phone_numer_type: permet de définir le type de numéro de téléphone du participant, parmi :-
suggestion: vous autorisez Universign ou le signataire à utiliser un autre numéro de téléphone qui pourrait être plus approprié. -
flex_prerequisite: vous autorisez Universign ou le signataire à utiliser un autre numéro de téléphone uniquement pour les signatures avancées (nous utiliserons toujours le numéro défini de votre côté si la signature est de niveaulevel1). -
prerequisite: vous n’autorisez pas Universign ni le signataire à utiliser un autre numéro de téléphone.
-
En d’autres termes, Universign utilisera toujours le numéro que vous avez défini si vous avez passé flex_prerequisite comme phone_number_type et que :
- vous avez demandé une signature
level1, - vous avez demandé une signature avancée et le participant dispose déjà d’un certificat lié au numéro que vous avez défini,
- vous avez demandé une signature avancée et le participant ne dispose pas encore de certificat mais accepte d’utiliser le numéro que vous avez suggéré.
Universign utilisera également toujours le numéro que vous avez défini si vous avez passé prerequisite comme phone_number_type, quel que soit le niveau de signature.
Cependant, un autre numéro de téléphone peut être utilisé pour authentifier le signataire si :
- vous avez passé
flex_prerequisitecommephone_number_typeet :- vous avez demandé une signature avancée et le participant possède déjà un certificat lié à un numéro de téléphone différent de celui que vous avez fourni,
- vous avez demandé une signature avancée et le participant ne dispose pas encore de certificat mais préfère utiliser un numéro différent de celui que vous avez suggéré,
- vous avez passé
suggestioncommephone_number_type.
Définir le numéro de téléphone comme une suggestion
Envoyez une requête à POST /v1/transactions/{transaction_id}/participants et transmettez l’email du participant, le numéro de téléphone dans le paramètre phone_number ainsi que suggestion dans le paramètre phone_number_type :
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/participants \
-d [email protected] \
-d phone_number=+33623456789 \
-d phone_number_type=suggestion
Définir le numéro de téléphone comme un prérequis flexible
Envoyez une requête à POST /v1/transactions/{transaction_id}/participants et transmettez l’email du participant, le numéro de téléphone dans le paramètre phone_number ainsi que flex_prerequisite dans le paramètre phone_number_type :
curl
https://api.universign.com/v1/transactions/{transaction_id}/participants \
-d [email protected] \
-d phone_number=+33623456789 \
-d phone_number_type=flex_prerequisite
Définir le numéro de téléphone comme un prérequis
Envoyez une requête à POST /v1/transactions/{transaction_id}/participants et transmettez l’email du participant, le numéro de téléphone dans le paramètre phone_number ainsi que prerequisite dans le paramètre phone_number_type :
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/participants \
-d [email protected] \
-d phone_number=+33623456789 \
-d phone_number_type=prerequisite
Notez que si vous ne transmettez pas le paramètre phone_number_type, la valeur par défaut est suggestion.
Authentification par email
Avant de demander une authentification par email OTP, assurez-vous que la fonctionnalité Email authentication est activée sur votre espace de travail.
Notez que l’authentification par email est disponible uniquement pour les signatures simples.
Pour autoriser votre participant à signer avec une authentification par email, envoyez une requête à POST /v1/transactions/{transaction_id}/participants, transmettez l’email du participant et définissez level1_auth_means à email, comme dans l’exemple ci-dessous.
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/participants \
-d [email protected] \
-d level1_auth_means=email
Avant de pouvoir demander une authentification par email, assurez-vous que la fonctionnalité est activée sur votre compte.
Signature sans authentification
Avant de demander à un participant de signer sans authentification, assurez-vous que la fonctionnalité Signature without authentication est activée sur votre espace de travail.
Notez que la signature sans authentification est disponible uniquement pour les signatures simples.
Pour autoriser votre participant à signer sans authentification, vous devez définir min_signature_level à level0.
Pour plus d’informations, consultez Définir le niveau de signature.
