Le modèle de transaction de vérification d'identité OneSpan définit des éléments de données qui contiennent toutes les métadonnées de transaction nécessaires à l'exécution d'un flux de travail d'entente électronique. Le modèle de transaction facilite les actions suivantes :
Produire les documents d'entente signés
Recueillir des preuves électroniques
Produire la piste d'audit et le pack de preuves uniques
Le modèle de transaction de vérification d'identité OneSpan est entièrement défini par des schémas JSON qui peuvent être utilisés pour générer des bibliothèques côté client pour accéder à l'API REST de vérification d'identité OneSpan.
Propriétés de la transaction
La structure de données de transaction de vérification d'identité OneSpan contient les métadonnées nécessaires à l'exécution d'un flux de travail d'entente électronique et à la collecte de preuves électroniques. Les preuves sont nécessaires pour faciliter la preuve de la conformité et de l'applicabilité.
La structure combine des données de transaction, d'utilisateurs, de documents, d'événements et de session (view_state). La transaction est une ressource de niveau supérieur qui est partagée entre tous les composants de vérification d'identité OneSpan.
Transaction properties répertorie les propriétés de la transaction dans la vérification d'identité OneSpan.
Chemin d'accès : .../propriétés/transaction
Type : objet
Propriété | Type | Description |
|---|---|---|
brand_id | Corde | L'UUID de la marque attribuée à la transaction. Les marques sont définies dans la configuration du locataire. Les locataires peuvent définir et utiliser plusieurs marques pour leurs transactions. Une fois que l'ID de marque est attribué, il ne peut pas être modifié après la création de la transaction.
|
terminé | Corde | La date et l'heure auxquelles une transaction a été effectuée.
|
configuration.consentement | Objet | Configuration pour le consentement implicite ou explicite. Dans le cas du consentement explicite, l'utilisateur doit donner son consentement explicite en cochant une case sur la page d'accueil. Pour obtenir la liste des propriétés de consentement , consultez propriétés configuration.consent. Restrictions relatives au consentement :
Pour plus d'informations, consultez la section Afficher les règles pour le texte de consentement. |
configuration.redirections | Tableau | La liste des URL qui remplacent les URL de transfert configurées correspondantes lors de la création de la transaction, à l'aide des valeurs de la transaction en cours de l'utilisateur. Ils peuvent être utilisés pour passer les paramètres suivants :
Les URL sont spécifiées avec des paires d'ID et d'URL. Pour obtenir la liste des propriétés de redirection , consultez propriétés configuration.redirects. |
créé | Corde | La date et l'heure de création de la transaction sont en UTC. Motif : ^[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}$ |
disable_notifications | Booléen | Cette propriété définit si les notifications sont désactivées pour la transaction en cours. Valeur par défaut : false |
disable_recording | Booléen | Cette propriété définit si l'enregistrement est désactivé pour la transaction en cours. Valeur par défaut : false |
documents | Tableau contenant les documents et leurs attributs définis dans la transaction en cours (voir Document model). Schéma : transaction.schema.3.0.documents.json#/définitions/documents | |
erasure_mark | Corde | Le jour où la transaction doit être supprimée à la demande du client. UTC ne prend désormais en compte que l'année, le mois et le jour.
|
erasure_mark_request | Corde | UTC : maintenant l'horodatage est en millisecondes. Le moment où la transaction a été marquée ou non marquée pour l'effacement.
|
expiry_period | Entier | Nombre de jours avant l'expiration de la transaction. Si elle n'est pas fournie, la valeur par défaut spécifiée dans la configuration du locataire sera utilisée. |
expiry_timestamp | Corde | La date et l'heure d'expiration de la transaction sont en UTC. Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[ 0-9]{3}Z$ |
id | Corde | L'UUID de la transaction.
|
Langue | Cette propriété définit la langue par défaut des transactions. Il peut être écrasé au niveau de la session. Dans le cadre d'une même transaction, plusieurs sessions interactives peuvent être exécutées dans différentes langues. Schéma : .. /commun/_common.schema.3.0.language.json | |
last_api_request | Corde | Date et heure de la dernière transaction avec une demande d'API. Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[ 0-9]{3}Z$ |
last_session_event | Corde | Date et heure du dernier événement d'une session de workflow active. Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[ 0-9]{3}Z$ |
opaque_id | Corde | Optionnel. L'ID opaque peut être fourni par l'application cliente et affecté à une transaction. Une fois l'ID opaque attribué, il ne peut pas être modifié après la création de la transaction. L'ID opaque sera inclus dans les données de notification d'événement avec l'ID de transaction. Il peut être utilisé par l'application cliente comme contexte supplémentaire pour le suivi des transactions.
|
request_ids | Tableau | ID des requêtes asynchrones. Articles:
|
session | Données de session (voir Session model). Schéma : transaction.schema.3.0.session.json#/definitions/session | |
statut | Corde | Statut actuel de la transaction. L'état peut être l'un des suivants :
Valeur par défaut : new |
status_changed | Corde | Date et heure auxquelles le statut de la transaction a changé.
|
tenant_id | Corde | L'UUID du locataire auquel appartient cette transaction. Lorsque la transaction est créée, le locataire est identifié par le JWT fourni avec la demande de création de transaction. Une fois l'ID de locataire attribué, il ne peut pas être modifié. Par conséquent, les transactions ne peuvent pas être réaffectées entre les locataires. Motif : ^[-w]+$ |
Jetons | Tableau contenant les jetons de création de session qui ont été émis pour cette transaction (voir Token model). Schéma : transaction.schema.3.0.tokens.json#/definitions/tokens | |
urlSetKey | Corde | Clé d'ensemble d'URL utilisée pour récupérer le point de terminaison du locataire. |
Utilisateurs | Tableau contenant des informations spécifiant les données d'identité du signataire (voir User model). Ce tableau contient une liste de ressources où chaque entrée de liste représente des informations sur un seul participant au processus d'e-agreement. Les données contiennent des informations d'identité personnelle, des informations d'adresse et d'autres données qui peuvent être utilisées pour la validation de l'identité en ligne. Schéma : transaction.schema.3.0.users.json#/definitions/users | |
Version | Entier | Version de l'enregistrement de la transaction. Propriété en lecture seule. Valeur par défaut : 0 |
workflow_id | Corde | UUID du flux de travail affecté à la transaction. Les flux de travail sont définis dans la configuration du locataire. Les locataires peuvent définir et utiliser plusieurs flux de travail pour leurs transactions. Une fois l'ID de flux de travail attribué, il ne peut pas être modifié après la création de la transaction.
|
Afficher les règles pour le texte de consentement
Les règles d'affichage suivantes s'appliquent :
Les liens au format <URL link="URL">Text</URL > doivent s'ouvrir dans un nouvel onglet du navigateur.
Les symboles HTML doivent être échappés et s'affichent tels quels.
Toutes les lignes sont conservées.
Afficher les règles pour le texte de consentement | |
Texte de consentement | Affiché sous la forme |
|---|---|
Veuillez confirmer <URL link="link"> un consentement </URL>. Merci | Veuillez confirmer votre consentement. Merci |
Veuillez confirmer <URL link="link"> un consentement </URL>. Merci | Veuillez confirmer votre consentement. Merci |
Veuillez confirmer <URL link="link"> un consentement </URL>. </> Merci | Veuillez confirmer votre consentement. </> Merci |
Veuillez confirmer <URL link="link"> un consentement </URL>. <URL > Merci | Veuillez confirmer votre consentement. <URL > Merci |
Veuillez confirmer <URL link="link"> un consentement </URL>. </URL > Merci | Veuillez confirmer votre consentement. </URL > Merci |
Veuillez confirmer < liens URL »> un consentement </> < /URL>. Merci | Veuillez confirmer un consentement </>. Merci |
Veuillez confirmer <URL link="link"> un consentement <URL > </URL>. Merci | Veuillez confirmer un consentement <URL>. Merci |
Veuillez confirmer <URL link="link"> un consentement </URL>. </URL> <URL links"> un < /URL> de consentement1. Merci | Veuillez confirmer votre consentement. </URL> un consentement1. Merci |
Exemple de demande
{
"workflow_id": "80b601c9-f102-4761-9eaa-90ba8fcb58b6",
"urlSetKey": "default"
"language": "english",
"opaque_id": "WorkflowExternalMitAtPwd=1234",
"brand_id": "a089f718-f12d-4b13-b82e-e1d8b324337d",
"disable_recording": "true",
"disable_notifications": "true",
"configuration": {
"redirects": [
{
"id": "REDIRECT_DOCID_PASS",
"url": "https://www.overriddenUrl.com/?user={{userRole}}&transaction={{transactionId}}&opaqueId={{opaqueId}}"
}
]
"status_changed":"2021-01-23T18:25:43.511Z"
"erasure_mark":"2012-04-23Z"
"erasure_mark_request":"2012-04-23T18:25:43.511Z"
},
"users":[{"...": "..."}],
"tokens": [{"...": "..."}],
"documents": [{"...": "..."}]
"expiry_period": 10
}Le contenu de cette API contient des éléments de données fournis par nos partenaires et est sujet à des modifications et mises à jour par nos partenaires. Ce contenu peut inclure des erreurs, des omissions, des erreurs techniques ou autres ou des inexactitudes. Nous vous aiderons au mieux de nos capacités, mais veuillez noter que nous ne contrôlons pas entièrement ce contenu.