Récupérer un modèle

La récupération d’un modèle vous permet de déterminer les paramètres demandés par le créateur du modèle et qui doivent être définis lors de la création d’une transaction.

Pour récupérer un modèle, envoyez une requête à GET /v1/templates/{template_id}.

curl
https://api.universign.com/v1/templates/tpl_weVPZX7wDvm7 

L’API renvoie un objet template.

{
  "object" : "template",
  "id" : "tpl_weVPZX7wDvm7",
  "folder_id" : "fol_DGX2qbq6yGmm",
  "created_at" : "2025-02-24T13:25:33Z",
  "duration" : 20160,
  "template_name" : "Flexible template",
  "folder_name" : "Default folder",
  "language" : "fr",
  "sender_name_display" : "issuing_entity",
  "creator" : {
    "name" : "John ",
    "email" : "[email protected]",
    "workspace_name" : "DemoWS"
  },
  "state" : "published",
  "publishable" : true,
  "participants" : [ {
    "email" : "[email protected]",
    "phone_number_type" : "suggestion",
    "min_signature_level" : "level1",
    "schedule" : [ 0 ],
    "ongoing_conversation" : false,
    "has_unread_message" : false,
    "waiting_period" : 0,
    "shared_contact" : false,
    "removable" : true,
    "name_constraint" : "Optional participant",
    "fullname_prerequisite" : "Optional participant",
    "full_name" : "Optional participant",
    "full_name_type" : "prerequisite"
  }, {
    "email" : "$1740405926564",
    "designation" : "Mandatory Unknown Participant",
    "phone_number_type" : "suggestion",
    "request_phone_number" : false,
    "min_signature_level" : "level1",
    "schedule" : [ 0 ],
    "ongoing_conversation" : false,
    "has_unread_message" : false,
    "waiting_period" : 0,
    "shared_contact" : false,
    "removable" : true,
    "request_full_name" : false,
    "full_name_type" : "suggestion"
  } ],
  "sealers" : [ ],
  "documents" : [ {
    "id" : "doc_0VK8",
    "name" : "Mandatory document",
    "name_locked" : true,
    "type" : "specimen",
    "updatable" : true,
    "deletable" : false,
    "fields" : [ {
      "id" : "fld_dn0",
      "position" : {
        "page" : 2,
        "x" : 84,
        "y" : 407,
        "width" : 200,
        "height" : 50
      },
      "type" : "signature",
      "built_in" : false,
      "consents" : [ ],
      "optional_consents" : [ ],
      "updatable" : true,
      "deletable" : false
    }, {
      "id" : "fld_QPYM",
      "position" : {
        "page" : 2,
        "x" : 71,
        "y" : 194,
        "width" : 200,
        "height" : 50
      },
      "type" : "signature",
      "built_in" : false,
      "consents" : [ ],
      "optional_consents" : [ ],
      "updatable" : true,
      "deletable" : false
    } ],
    "removable" : true,
    "available" : true,
    "big_file" : false,
    "editable" : true
  } ],
  "field_groups" : [ {
    "id" : "fld_dn0",
    "type" : "field",
    "fields" : [ "fld_dn0" ]
  }, {
    "id" : "fld_QPYM",
    "type" : "field",
    "fields" : [ "fld_QPYM" ]
  } ],
  "instructions" : {
    "signatures" : [ {
      "signer" : "[email protected]",
      "field" : "fld_dn0"
    }, {
      "signer" : "$1740405926564",
      "field" : "fld_QPYM"
    } ],
    "reviews" : [ ],
    "captures" : [ ],
    "sequencing" : [ ],
    "editions" : [ ]
  },
  "actions" : [ {
    "id" : "act_lAZdkLx4V8k6d",
    "actor" : "$1740405926564",
    "tasks" : [ {
      "type" : "signature",
      "field" : "fld_QPYM"
    } ]
  }, {
    "id" : "act_J6Glr3oJVdd2g",
    "actor" : "[email protected]",
    "tasks" : [ {
      "type" : "signature",
      "field" : "fld_dn0"
    } ]
  } ],
  "action_graph" : {
    "act_lAZdkLx4V8k6d" : [ "end" ],
    "start" : [ "act_lAZdkLx4V8k6d", "act_J6Glr3oJVdd2g" ],
    "act_J6Glr3oJVdd2g" : [ "end" ]
  },
  "metadata" : { },
  "carbon_copies" : [ ],
  "allow_carbon_copy" : false,
  "last_publication_date" : "2025-02-24T16:42:24Z",
  "last_publisher" : {
    "name" : "John ",
    "email" : "[email protected]",
    "workspace_name" : "DemoWS"
  },
  "issuing_entity" : {
    "active" : true,
    "name" : "DemoWS",
    "id" : "iss_aX0wDPD86DlQ"
  }
}

Les modèles de transaction
Lister les modèles
Espace Développeur
Guides
Services
Référence API