Modèle de document

Prev Next

Le modèle de document de vérification d’identité OneSpan est une section du modèle de transaction. Il définit les documents qui sont inclus dans une instance du flux de travail de vérification d’identité OneSpan. Ce flux de travail peut inclure différents types de documents :

  • Documents qui seront présentés à l’utilisateur pour examen et acceptation.

  • Documents qui seront présentés pour signature.

  • Données brutes recueillies à partir du processus de validation de l’identité (module de vérification d’identité OneSpan).

  • ...

Le modèle de document contient des informations requises pour les actions de document suivantes :

  • Document(s) électronique(s) de pré-traitement :

    • Fractionnement / assemblage

    • Extraction de l’emplacement de la signature

    • Personnalisation (formulaires, annotations)

    • Tatouage

  • Appliquez des signatures associées à l’intention de signature des utilisateurs.

  • Appliquez des scellés d’inviolabilité.

  • Affichez des documents pour les afficher.

  • Ajoutez des documents au pack de preuves uniques.

Propriétés du document

Les propriétés du document répertorient les propriétés du document dans la vérification de l’identité OneSpan.

Définition de la ressource de document : .../properties/transaction/properties/documents/items

Propriétés du document

Propriété

Type

Description

contenu

Corde

URL référençant le contenu binaire d’un document.

Schéma : .. /commun/common.schema.3.0.sfs-url.json

description

Corde

La description capture des informations pertinentes sur l’objectif d’un document, ainsi que toutes les instructions qui doivent être affichées aux signataires.

  • Longueur maximale : 1024

  • Longueur minimale : 1

document_template_id

Corde

UUID du modèle de document, qui est une référence à la configuration de l’accord dans le profil du locataire. Le cas échéant, toutes les propriétés du document seront copiées à partir de la configuration de l’accord .

  • Longueur maximale : 64

  • Longueur minimale : 36

  • Modèle:

    ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

groupe

Tableau

Liste des groupes auxquels le document est attribué.

  • Nombre maximum d’articles : 8

  • Nombre minimum d’articles : 1

Articles:

  • Le nom du groupe. Il doit être valide dans le contexte du flux de travail attribué à la transaction.

  • Type : corde

  • Longueur maximale : 32

  • Longueur minimale : 1

Pour permettre l’impression d’un document par rôle, les groupes d’un document doivent être modifiés pour inclure le rôle auquel il sera visible dans le cadre des groupes. Cela ne fonctionnera que si le flux de travail a été configuré pour utiliser cette fonctionnalité.

id

Corde

Nom unique lisible par l’homme qui identifie le document.

  • Longueur maximale : 64

  • Longueur minimale : 1

  • Motif : ^[a-zA-Z0-9_-]*$

number_of_pages

Entier

Nombre de pages du document. Cette propriété est utilisée pour indiquer le nombre de pages rendues à montrer à un utilisateur. Doit être fourni lors de la demande de création de transaction.

Signatures

Tableau

  • Nombre maximum d’articles : 64

  • Nombre minimum d’articles : 1

  • Schéma : transaction.schema.3.0.signature.json

Pour plus d’informations, reportez-vous à la Signature properties.

titre

Corde

Le titre du document.

  • Longueur maximale : 256

  • Longueur minimale : 1

Version

Entier

L’identificateur et le nom de la version. La version fait référence à l’instance correcte du document dans le flux de travail.

  • Longueur maximale : 64

  • Longueur minimale : 1

Valeur par défaut : 1

filigrane

Un filigrane sera ajouté à toutes les pages du document si l’opération de filigrane se trouve dans la liste des opérations de prétraitement.

schéma : transaction.schema.3.0.watermark.json

Pour plus d’informations, reportez-vous à la Watermark properties.

Exemples de propriétés de document

{

  "id": "ee02adab-4946-4fae-884f-d8990aaf776a",
  "version": 1,
  "title": "Agreement to sign",
  "description": "Electronic retail credit agreement.",
  "document_template_id": "babdf419-6144-4e01-b8fb-98c863c9a2f2",
  "content": "TWFuIGlzIG...VyZS4=",
"groups":["agreements"],
  "signatures": [{
    "id": "922b4d10-beb1-4120-b642-2ecb040411d2",
    "status": "signed",
    "role": "signer1",
    "...": "..."
    }, {
    "id": "922b4d10-beb1-4120-b642-2ecb040411d2",
    "status": "signed",
    "role": "signer2",
    "...": "..."
    }
},
  "watermark": [{
    "text": "COPY"
    "font-name": "Arial",
    "font-size": "12"
    }
  ],
  "number_of_pages": "3"
}

Propriétés de signature

La signature définit l’emplacement, le type et le rôle associé à la signature du document. Le rôle détermine quel signataire doit signer ou accepter le document.

Les signatures peuvent avoir un emplacement prédéfini dans le document ou être ancrées à une balise de texte particulière dans le document. L’emplacement de la signature n’est requis que pour les signatures visibles (type signature). Les signatures des types acceptation et effraction n’apparaissent pas visiblement dans le document.

Propriétés de signature répertorie les propriétés de signature dans la vérification d’identité OneSpan.

Propriétés de signature

Propriété

Type

Description

anchor_offset_x

Entier

Le décalage horizontal par rapport à l’ancrage.

Valeur par défaut : 0

anchor_offset_y

Entier

Le décalage vertical par rapport à l’ancrage.

Valeur par défaut : 0

anchor_text

Corde

Chaîne de texte pour la méthode d’ancrage de texte afin d’extraire l’emplacement de la signature. Ce champ sera utilisé si l’opération d’extraction fait partie des opérations de prétraitement.

Si les propriétés anchor_text et field_name sont fournies, l’extraction de l’ancre de texte est tentée en premier. En cas d’échec de l’extraction de l’ancrage de texte, l’extraction du champ de signature est effectuée.

  • Nombre maximum d’articles : 128

  • Nombre minimum d’articles : 1

hauteur

Entier

Hauteur du champ de signature.

id

Corde

L’UUID de la signature.

Motif : ^[w]+$

page_number

Entier

Le numéro de la page où la signature est insérée.

percent_height

Nombre

Hauteur du champ de signature par rapport à la dimension correspondante du document où il apparaît.

percent_width

Nombre

Largeur du champ de signature par rapport à la dimension correspondante du document où il apparaît.

rôle

Corde

Le rôle auquel cette signature est attribuée.

  • Longueur maximale : 32

  • Longueur minimale : 1

signature_block_text

Corde

Le texte qui apparaîtra sur un champ de signature accepté/signé. Le champ prend en charge des éléments de substitution tels que :

  • {$signer}

  • {$date_temps}

  • {$date}

  • {$time}

  • {$company}

Le champ prend en charge les nouveaux caractères de ligne ' '.

Texte par défaut : Signé par : {$signer} le {$date_time}

statut

Corde

L’état actuel de la signature.

Valeurs possibles :

  • Unsigned

  • non acceptée

  • accepté

  • confirmé

  • signé

Valeur par défaut : unsigned

type

Corde

Le type de signature.

Valeurs possibles :

  • acceptation

  • signature

  • sceau d’inviolabilité

  • paraphe

Valeur par défaut : signature

Largeur

Entier

Largeur du champ de signature.

x

Entier

La coordonnée X (en points PDF) sur la page où la signature est insérée.

x_percent

Nombre

Décalage en pourcentage de la coordonnée X (par rapport à la largeur de la page) sur la page où la signature est insérée.

Cette propriété est utilisée pour positionner la signature à l’écran.

y

Entier

La coordonnée Y (en points PDF) sur la page où la signature est insérée.

y_percent

Nombre

Décalage en pourcentage de la coordonnée Y (par rapport à la hauteur de la page) sur la page où la signature est insérée.

Cette propriété est utilisée pour positionner la signature à l’écran.

Exemple de propriétés de signature

[

  {
    "id": "922b4d10-beb1-4120-b642-2ecb040411d2",
    "status": "unsigned",
    "role": "signer1",

    "anchor_text": "SignHere:",

    "anchor_offset_x": "5"

    "anchor_offset_y": "10",
    "page_number": "1",
    "x": "1000",

    "y":"2000",

    "x_percent": "65",

    "y_percent": "35",

    "width": "250",

    "height": "50",
    "percent_width": "0.251",
    "percent_height": "0.082",
    "signature_block_text": "Signedby:{$signer}\non{$date_time}",
    "type": "signature"
},
{
    "id": "922b4d10-beb1-4120-b642-2ecb040411d2",
    "status": "signed",
    "role": "signer2",

    "anchor_text": "SignHere:",

    "anchor_offset_x": "5"

    "anchor_offset_y": "10",
    "page_number": "3",
    "x": "1000",

    "y": "2000",

    "x_percent": "65",

    "y_percent": "35",

    "width": "250",

    "height": "50",
    "percent_width": "0.251",
    "percent_height": "0.082",
    "signature_block_text": "Signedby:{$signer}\non{$date_time}",
    "type": "tamperseal"
  }
]

Propriétés du filigrane

Avec les filigranes, vous pouvez marquer une copie d’un document comme révision uniquement, ou une copie imprimable qui ne doit pas être signée. Le texte du filigrane peut être défini pour une instance de transaction donnée. La police du filigrane peut être configurée pour correspondre à la typographie d’un document.

Un filigrane est ajouté à toutes les pages du document si l’opération de filigrane se trouve dans la liste des opérations de prétraitement.

Propriétés du filigrane répertorie les propriétés du filigrane dans la vérification d’identité OneSpan.

Propriétés du filigrane

Propriété

Type

Description

font_name

Corde

La police utilisée pour le filigrane.

  • Longueur maximale : 256

  • Longueur minimale : 1

Valeur par défaut : Helvetica

font_size

Entier

La taille de la police utilisée pour le filigrane.

Valeur par défaut : 10

SMS

Corde

Le texte du filigrane.

Exemple de propriétés de filigrane

{

  "text": "COPY",
  "font_name": "Arial",
  "font_size": "12"

}