Paramètres de transaction pour le prêt numérique

Prev Next

OneSpan Sign a créé une solution de prêt numérique qui peut stocker un prêt ou un autre document associé (par exemple, contrat, papier meuble) dans un coffre numérique.

Certains paramètres de l’API REST associés à une transaction OneSpan Sign peuvent spécifier quel document doit être stocké, ainsi que dans quelle organisation et dans quelle chambre forte il doit être stocké. Après que la copie autorisée d’un document a été archivée, elle est remplacée dans la base de données de OneSpan Sign soit par une copie non autorisée filigranée (par défaut), soit par un document vierge.

Créer une transaction ou un modèle avec l’API REST implique toujours certains paramètres standards — voir Java SDK.

Si vous souhaitez consulter tous les appels existants, consultez notre spécification interactive Open API. À partir de là, vous pouvez télécharger le fichier YAML de notre API REST, rechercher des points de terminaison spécifiques dans cette API, et même essayer quelques appels vous-même.

Chaque fois qu’une tentative de dépôt électronique de documents dans un coffre eOriginal échoue, OneSpan Sign envoie une notification à l’Expéditeur concernant la transaction associée via un événement de rappel. Une fois que l’effort de sauvegarder un document subit une erreur irrécupérable, OneSpan Sign envoie un e-mail à l’Expéditeur concernant l’échec. Le modèle de cet e-mail ne peut pas être personnalisé.

Utilisation d’un coffre eOriginal pour les transactions de prêt numériques

Actuellement, l’utilisation des signatures optionnelles avec eOriginal n’est pas prise en charge. Par défaut, lors de l’utilisation d’eOriginal, les documents sont archivés dès que la dernière signature a été signée par le dernier signataire. Cependant, lorsqu’on utilise des signatures optionnelles, il est possible de finaliser une transaction sans compléter tous les champs de signature. Dans ce cas, le document ne serait pas archivé.

Si vous souhaitez stocker un document dans un coffre-fort eOriginal, la première chose à faire est de demander à notre équipe Support d’activer cette fonctionnalité pour votre compte.

Pour demander à OneSpan Sign de stocker un document dans un coffre-fort eOriginal, les intégrateurs doivent ajouter au champ de la transaction data le vaulting_data champ JSON décrit ci-dessous.

  • eOriginal sauvegarde un document de prêt issu d’une transaction OneSpan Sign ainsi que le journal d’audit de la transaction.

  • Depuis la version 11.37 de OneSpan Sign, si une transaction comporte plusieurs documents de prêt : (1) un coffre eOriginal peut stocker tous ces documents pour la transaction ; (2) la trace d’audit d’eOriginal liste tous les événements liés à la transaction et à ses multiples documents.

vaulting_data

Ce champ doit être une chaîne JSON codée en base 64. Lorsque le champ est décodé, les paramètres du tableau suivant peuvent être consultés.

Les données de sauvegarde ne peuvent pas dépasser 4000 caractères.

Paramètre

Obligatoire ?

Description

NomTypeTransactionVault

Non

Cela permet aux clients de la sauvegarde de transmettre leur nom de type de transaction souhaité au système en utilisant le paramètre transactiontypename . Cela permet aux utilisateurs de distinguer la source de certaines transactions lors de la recherche de plusieurs sources qu’ils souhaitent suivre.

vaultCredentials

Oui

Cet objet JSON contient les identifiants d’authentification permettant d’accéder à l’API du service eCore d’eOriginal.

Cet objet doit contenir les champs requis suivants :

  • nom d’utilisateur — ID de connexion API de l’utilisateur API qui effectuera l’opération de dépôt du coffre.

  • orgNameNom abrégé de l’organisation au sein du service eCore d’eOriginal, où le document sera stocké.

  • apiKey — Clé API de 32 caractères de l’utilisateur.

Cet objet JSON contient également le champ optionnel suivant (une valeur par défaut sera utilisée si le champ de point d’arrivée n’est pas spécifié) :

  • point d’arrivée — L’environnement eOriginal dans lequel les documents seront déposés. Les valeurs possibles sont :

    • testondemand — C’est : (i) l’une des deux valeurs prises en charge pour les comptes bac à sable ; (ii) la valeur par défaut pour les comptes bac à sable.

    • previewondemand — C’est l’autre valeur prise en charge pour les comptes bac à sable.

    • à la demande — C’est : (i) la seule valeur prise en charge pour les comptes de production ; (ii) la valeur par défaut pour les comptes de production

documentsToVault

Oui

Il s’agit d’un tableau JSON qui doit contenir les champs requis suivants. Chaque entrée du tableau contient des informations de stockage pour un document spécifique.

  • documentId — ID du document OneSpan Sign qui sera stocké avec le service eCore d’eOriginal. Ce document est généralement un prêt. La valeur de ce paramètre doit correspondre à l’ID du document dans la transaction.

  • loanId — Identifiant unique du prêt, selon le système du client

  • Montant du prêt — Montant initial du prêt en centimes américains

  • Prêteur — Nom du prêteur pour ce prêt

  • type — Ce champ est utilisé dans le service eCore d’eOriginal pour classer les documents selon leur processus associé au sein de votre entreprise. Il doit correspondre à un Type de Document configuré pour votre service eCore Client Org original.

loanId, loanAmount et lender ne sont envoyés à eOriginal que pour le premier élément du tableau. Pour les éléments suivants, ces valeurs ne sont pas envoyées à eOriginal.

Version

Non

Version du protocole à utiliser. Actuellement, la seule valeur prise en charge est Lending-2.0.

postRegisterOption

Non

Après que la copie autorisée d’un document a été archivée dans un coffre-fort eOriginal, elle est retirée de OneSpan Sign. Ce paramètre précise comment cette copie autoritaire sera remplacée dans OneSpan Sign. Les valeurs prises en charge sont :

  • watermark_doc (par défaut) — Après la sauvegarde d’un document, le contenu PDF signé est filigrané, aplati et enregistré dans OneSpan Sign.

  • blank_doc — Après qu’un document a été archivé, le contenu PDF signé est remplacé dans OneSpan Sign par un document vierge.

Remarque : Les clients ne peuvent pas télécharger la copie officielle d’un document qui sera déposée dans un coffre eOriginal. S’ils essaient de le faire, ils finiront par télécharger une copie non autoritaire aplatie dont chaque page portera le filigrane Copie Non Autorisée.

Domaines personnalisés

Non

Cet objet JSON contient des données qui seront ajoutées à la transaction eOriginal sous forme de champs personnalisés.

Cet objet peut contenir n’importe quel champ tant que son nom correspond à celui d’un champ personnalisé configuré pour votre service eCore original Customer Org.

Exemple

Voici un exemple de valeur «vaulting_data » décodée en Base64 :

{
        "postRegisterOption":"watermark_doc",
        "vaultTransactionTypeName":"OneSpan Sign eTest",
        "vaultCredentials":{
        "username":"SampleUsername",
        "orgName":"SampleOrganization",
        "apiKey":"ok0Sample0ApiKey0Just0An0Example",
        "endpoint":"previewondemand"
        },
        "documentsToVault":[
        {
        "documentId":"DocumentName01",
        "loanId":"loanId_001",
        "loanAmount":"99999",
        "lender":"ABC Corporation",
        "type":"Loan Contract"
        },
        {
        "documentId":"DocumentName02",
        "loanId":"N/A",
        "loanAmount":"0",
        "lender":"N/A",
        "type":"Ancillary"
        }
        ]
        }