Définir l'entité émettrice

La fonctionnalité Entités émettrices vous permet, pour un seul espace de travail, d’envoyer une demande de transaction au nom de l’une de vos nombreuses :

  • marques,
  • unités commerciales,
  • filiales,
  • services,
  • départements.

Elle vous permet ainsi de personnaliser le parcours de signature de vos participants.

Notez que vous pouvez avoir un maximum de 20 entités émettrices par espace de travail (à l’exclusion de l’espace de travail lui-même).

Créer une entité émettrice

Pour créer une entité émettrice, envoyez une requête à POST /v1/issuing-entities et transmettez les arguments name (obligatoire) et logo :

curl
https://api.alpha.universign.com/v1/issuing-entities \
-d name=MyEntityName
-F logo=@entity_logo
-d sms_short_name=MysmsShortName

Le nom de l’entité émettrice est limité à 200 caractères et ne peut être modifié une fois l’entité émettrice créée.

Le logo doit être au format PNG ou JPEG et est limité à une taille de 2 Mo et une résolution de 150x48. Si le logo a une résolution supérieure, il sera redimensionné pour s’adapter à la résolution 150x48. Si vous ne définissez pas de logo, l’entité émettrice héritera du logo de l’espace de travail.

Remarque : pour garantir une résolution de haute qualité, les dimensions de votre logo doivent être de 300px x 72px.

Vous pouvez passer des paramètres facultatifs :

  • is_default : vous permet d’utiliser l’entité émettrice par défaut pour envoyer des demandes de transaction.
  • sender_name_display : vous permet de définir au nom de qui la transaction est envoyée. Pour plus d’informations, consultez Gérer les options d’affichage.
  • lock_sender_name_display : vous permet de verrouiller le paramètre sender_name_display pour une entité émettrice donnée. Pour plus d’informations, consultez Gérer les options d’affichage.
  • sealer_logo_display : vous permet de choisir le logo qui s’affichera sur votre document scellé. Les valeurs acceptées sont certificate (logo par défaut d’Universign ou logo personnalisé du certificat de la personne morale), issuing_entity (logo de l’entité émettrice), none (aucun logo à afficher). La valeur par défaut est certificate.

Vous pouvez personnaliser la mise en page de la page de signature afin qu’elle corresponde à chaque entité émettrice que vous créez. Pour ce faire, définissez les arguments suivants :

  • header_background_color : couleur d’arrière-plan de l’en-tête à afficher sur la page de signature.
  • header_text_color : couleur du texte de l’en-tête à afficher sur la page de signature.
  • header_steps_color : couleur des étapes qui s’affichera sur la page de signature.
  • body_background_color : couleur d’arrière-plan du corps qui s’affichera sur la page de signature.
  • body_text_color : couleur du texte du corps qui s’affichera sur la page de signature.
  • body_button_background_color : couleur du bouton qui s’affichera sur la page de signature.
  • body_button_text_color : couleur du texte du bouton à afficher sur la page de signature.
  • body_button_border_radius : rayon de la bordure du bouton à afficher sur la page de signature.
  • body_links_color : couleur des liens à afficher sur la page de signature.
  • body_underlined_links : définissez cette option sur true si vous souhaitez que les liens de la page de signature soient soulignés.

Si vous ne définissez aucun des paramètres suivants liés à la mise en page, la mise en page par défaut d’Universign sera utilisée pour la page de signature.

Vous pouvez également personnaliser le SMS qui sera envoyé au nom de l’entité émettrice. Pour ce faire, définissez les arguments suivants :

  • sms_short_name : vous permet de définir le nom (version courte) de l’entité que vous souhaitez afficher dans le SMS personnalisé (20 caractères maximum). La valeur ne doit pas être vide.
  • delete_sms_short_name : vous permet de supprimer le nom (version courte) personnalisé du SMS.

Éditer une entité émettrice

Pour éditer une entité émettrice, envoyez une requête à POST /v1/issuing-entities/{id} :

curl
https://api.alpha.universign.com/v1/issuing-entities/iss_3z" \
-d is_default=true \ 
-d sender_name_display=name_issuing_entity \
-d lock_sender_name_display=true \
-F logo=@new_entity_logo \
-d delete_sms_short_name=true

Notez que vous pouvez éditer tous les arguments à l’exception du name de l’entité émettrice.

Activer/désactiver l’entité par défaut de l’espace de travail

Vous pouvez activer/désactiver uniquement l’entité par défaut de l’espace de travail (c’est-à-dire l’espace de travail lui-même qui était initialement utilisé pour envoyer des demandes de transaction avant que vous ne créiez d’autres entités émettrices).

Si l’entité par défault de l’espace de travail est active, vous pouvez l’utiliser pour créer des demandes de transaction. Si ce n’est pas le cas, vous devrez utiliser une autre entité émettrice de votre choix à la place.

Notez que vous ne pouvez pas désactiver l’entité par défault de l’espace de travail si elle est utilisée par défaut ou si aucune autre entité émettrice n’est disponible dans votre espace de travail.

Activer l’entité par défault de l’espace de travail

Pour activer l’entité par défault de l’espace de travail, envoyez une requête à POST /v1/issuing-entities/{id}/activate.

curl
https://api.alpha.universign.com/v1/issuing-entities/iss_5X/activate"

L’API renvoie un objet issuing-entity :

{
  "object" : "issuing_entity",
  "id" : "iss_5X",
  "workspace_entity" : true,
  "name" : "workspace_issuer",
  "sender_name_display" : "name_email_issuing_entity",
  "lock_sender_name_display" : true,
  "default" : false,
  "active" : true,
  "pds_configuration" : {
    "header_background_color" : "#FFFFFF",
    "header_text_color" : "#3B4F63",
    "header_steps_color" : "#0072AF",
    "body_background_color" : "#FFFFFF",
    "body_text_color" : "#3B4F63",
    "body_button_background_color" : "#0072AF",
    "body_button_text_color" : "#FFFFFF",
    "body_button_border_radius" : 24,
    "body_links_color" : "#0072AF",
    "body_underlined_links" : false
  }
}

Désactiver l’entité par défault de l’espace de travail

Pour activer l’entité par défault de l’espace de travail, envoyez une requête à POST /v1/issuing-entities/{id}/deactivate.

curl
https://api.alpha.universign.com/v1/issuing-entities/iss_5X/deactivate" \

L’API renvoie un objet issuing-entity :

{
  "object" : "issuing_entity",
  "id" : "iss_3z",
  "workspace_entity" : true,
  "name" : "workspace_issuer",
  "sender_name_display" : "name_email_issuing_entity",
  "lock_sender_name_display" : true,
  "default" : false,
  "active" : false,
  "pds_configuration" : {
    "header_background_color" : "#FFFFFF",
    "header_text_color" : "#3B4F63",
    "header_steps_color" : "#0072AF",
    "body_background_color" : "#FFFFFF",
    "body_text_color" : "#3B4F63",
    "body_button_background_color" : "#0072AF",
    "body_button_text_color" : "#FFFFFF",
    "body_button_border_radius" : 24,
    "body_links_color" : "#0072AF",
    "body_underlined_links" : false
  }
}

Retirer une entité émettrice

Vous pouvez retirer une entité émettrice de votre espace de travail. Pour ce faire, envoyez une requête à POST /v1/issuing-entities/{id}/retire.

curl
https://api.alpha.universign.com/v1/issuing-entities/iss_3z/retire" \

Notez que vous ne pouvez pas retirer l’entité émettrice de l’espace de travail ni aucune autre entité émettrice utilisée par défaut.

L’API renvoie une réponse 200 vide.

Lister les entités émettrices

Vous pouvez lister les entités émettrices disponibles dans votre espace de travail. Pour ce faire, envoyez une requête à GET /v1/issuing-entities.

Vous pouvez définir des paramètres facultatifs pour filtrer les entités émettrices :

  • name : vous permet de filtrer les entités émettrices par nom
  • size : vous permet de définir le nombre d’entités émettrices que vous souhaitez récupérer, à partir de l’entité émettrice de l’espace de travail. La valeur maximale est 20.
  • ending_before : la valeur attendue est un identifiant d’entité émettrice. À utiliser pour la pagination afin de renvoyer les entités émettrices répertoriées avant celle spécifiée. Ne pas transmettre si vous définissez le paramètre starting_after.
  • starting_after : la valeur attendue est un identifiant d’entité émettrice. À utiliser pour la pagination afin de renvoyer les entités émettrices répertoriées après celle spécifiée. Ne pas transmettre si vous avez défini le paramètre ending_before.
  • only_active : vous permet de répertorier uniquement les entités émettrices actives.
  • retired : vous permet de répertorier uniquement les entités émettrices supprimées.
curl https://api.universign.com/v1/issuing-entities?starting_after=iss_5X&size=5

L’API renvoie la liste des entités émettrices demandées.

Créer une transaction avec une entité émettrice

Pour créer une transaction avec une entité émettrice, envoyez une requête à POST /v1/transactions et transmettez l’argument issuing_entity_id :

curl
https://api.alpha.universign.com/v1/transactions \
-d issuing_entity_id=iss_3z

Notez que si vous ne définissez pas l’argument issuing_entity_id, la transaction sera envoyée au nom de l’entité émettrice par défaut de votre espace de travail.

Rendre une transaction privée
← Précédent
Gérer les options d'affichage
Suivant →
Espace Développeur
Guides
Services
Référence API