OneSpan Sign a créé une Digital Lending Solution qui peut stocker un prêt ou un autre document connexe (par exemple, un contrat, un acte mobilier) dans un coffre-fort numérique.

Certains paramètres de l'API REST associés à une transaction OneSpan Sign peuvent spécifier quel document doit être mis en coffre-fort, et dans quelle organisation et quel coffre-fort il doit être stocké. Une fois que la copie faisant autorité d'un document est mise en coffre-fort, elle est remplacée dans la base de données de OneSpan Sign par une copie non autorisée en filigrane (par défaut) ou par un document vierge.

eOriginal et OneSpan fournissent tous les deux des coffres-forts pour les documents. Les sections suivantes décrivent comment utiliser leurs coffres-forts :

• Utilisation d'un coffre-fort eOriginal
• Utilisation d'un coffre-fort OneSpan

La création d'une transaction ou d'un modèle avec l'API REST implique toujours certains paramètres standard - voir Paramètres de SDK Java.

Si vous souhaitez visualiser tous les appels existants, consultez notre Spécification API ouverte interactive. De là, vous pouvez télécharger le fichier YAML de notre API REST, rechercher des points d'extrémités 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-fort eOriginal échoue, OneSpan Sign envoie une notification à l'expéditeur de la transaction associée via un événement de rappel. Une fois que l'effort de voute d'un document subit une erreur non récupérable, OneSpan Sign envoie à l'expéditeur un courriel électronique signalant l'échec. Le modèle du courriel ne peut pas être personnalisé.

Utilisation d'un coffre-fort eOriginal

Actuellement, l'utilisation de signatures optionnelles avec eOriginal n'est pas prise en charge. Par défaut, lorsque vous utilisez eOriginal, les documents sont mis en coffre-fort dès que la dernière signature a été apposée par le dernier signataire. Toutefois, lorsque les signatures sont facultatives, il est possible d'effectuer une transaction sans remplir tous les champs de signature. Dans ce cas, le document ne serait pas mis en coffre-fort.

Si vous souhaitez stocker un document dans un coffre-fort eOriginal, la première chose à faire est de demander à notre équipe de soutien 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 data de la transaction le champ vaulting_data JSON décrit ci-dessous.

eOriginal met en sûreté un document de prêt 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-fort eOriginal peut stocker tous ces documents pour la transaction; (2) la piste d'audit eOriginal répertorie 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 visualisés.

Paramètre	Requis?	Description
vaultTransactionTypeName	Non	Cela permet aux clients du coffre-fort de transmettre au système le nom du type de transaction souhaité, via le paramètre transactiontypename . Cela permet aux utilisateurs de distinguer la source de certaines transactions lors de la mise en coffre-fort parmi plusieurs sources qu'ils souhaitent suivre.
vaultCredentials	Oui	Cet objet JSON contient les informations d'authentification pour accéder à l'API du service eCore d'eOriginal. Cet objet doit contenir les champs obligatoires suivants : NomUtilisateur - ID de connexion à l'API de l'utilisateur de l'API qui effectuera l'opération de dépôt dans le coffre-fort. orgName - Nom court de l'organisation pour l'organisation au sein du service eCore d'eOriginal, où le document sera stocké. apiKey - Clé API de 32 caractères de l'utilisateur de l'API. Cet objet JSON contient également le champ facultatif suivant (une valeur par défaut sera utilisée si le champ du point de terminaison n'est pas spécifié) : Point final - L'environnement eOriginal dans lequel les documents seront déposés. Les valeurs possibles sont : TestSurDemande - Il s'agit : (i) d'une des deux valeurs prises en charge pour les comptes Sandbox; (ii) de la valeur par défaut pour les comptes Sandbox. AperçuSurDemande - Il s'agit de l'autre valeur prise en charge pour les comptes Sandbox. ondemand - Il s'agit : (i) de la seule valeur prise en charge pour les comptes de production; (ii) de la valeur par défaut pour les comptes de production
documentsToVault	Oui	Il s'agit d'un tableau JSON qui doit contenir les champs obligatoires suivants. Chaque entrée du tableau contient des informations sur la mise en coffre-fort d'un document spécifique. documentId - ID du document OneSpan Sign qui sera mis en coffre-fort 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 d'un document dans la transaction. IdPrêt - ID unique du prêt, selon le système du client MontantPrêt - Montant initial du prêt en cents USD 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 en fonction du processus qui leur est associé dans votre entreprise. Cela doit correspondre à un type de document qui a été configuré pour votre service eOriginal eCore Customer Org.
version	Non	Version du protocole à utiliser. Actuellement, la seule valeur prise en charge est Lending-2.0.
postRegisterOption	Non	Une fois que la copie faisant autorité d'un document est mise en coffre-fort dans un coffre-fort eOriginal, elle est supprimée de OneSpan Sign. Ce paramètre spécifie comment cette copie faisant autorité sera remplacée dans OneSpan Sign. Les valeurs prises en charge sont les suivantes : watermark_doc (par défaut) - Après la mise en coffre d'un document, le contenu du PDF signé est marqué d'un filigrane, aplati et enregistré sur OneSpan Sign. blank_doc - Après la mise en coffre-fort d'un document, le contenu du PDF signé est remplacé en OneSpan Sign par un document vierge. Remarque : Les clients ne peuvent pas télécharger la copie faisant autorité d'un document qui sera déposé dans un coffre-fort eOriginal. S'ils essaient de le faire, ils finiront par télécharger une copie non autorisée aplatie dont chaque page portera le filigrane Copie non autorisée.
customFields	Non	Cet objet JSON contient des données qui seront ajoutées à la transaction eOriginal en tant que 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 eOriginal eCore Customer Org.

Exemple

Voici un exemple de décodage en base64 d'une 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"
        }
    ]
}

Utilisation d'un coffre-fort OneSpan

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

Les coffres-fortsOneSpan sont administrés par le produit e-Vault Manager de l'entreprise.

données_de_registre

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 visualisés.

Paramètre	Requis?	Description
coffres-forts	Oui	Il s'agit d'un tableau JSON qui identifie un coffre-fort où le document sera stocké. Chaque entrée du tableau JSON doit contenir les champs obligatoires suivants : orgId - ID unique de l'organisation qui possède le coffre-fort où le document sera stocké. Il s'agit du même identifiant d'organisation que celui utilisé par les utilisateurs lorsqu'ils se connectent à la console e-Vault Manager. vaultId - L'ID numérique du coffre-fort où le document sera stocké. Un administrateur d'organisation peut voir cet identifiant en consultant les détails du coffre-fort dans l'organisation identifiée par orgId. Chaque entrée du tableau JSON peut contenir le champ facultatif suivant : transaction - Nom à donner à la transaction du gestionnaire de coffres-forts électroniques qui sera utilisée pour enregistrer le document auprès du gestionnaire de coffres-forts électroniques. La transaction peut contenir plusieurs documents.
registryRecords	Oui	Il s'agit d'un tableau JSON qui doit contenir les champs obligatoires suivants. Chaque entrée du tableau contient des informations sur la mise en coffre-fort d'un document spécifique. documentId - Nom du document OneSpan Sign qui sera enregistré dans le gestionnaire e-Vault. Ce document est généralement un prêt. La valeur de ce paramètre doit correspondre à l'ID d'un document dans la transaction. registryId - Nom qui sera donné au document dans le gestionnaire e-Vault. Ce nom doit être unique dans l'instance donnée de e-Vault Manager. emprunteurs - Un tableau JSON qui contient un ou plusieurs identifiants de rôle de OneSpan Sign. Avant que la transaction puisse être distribuée pour signature, chaque ID de rôle dans ce tableau doit correspondre à l'ID de rôle d'un rôle dans la transaction. IdPrêt - ID unique du prêt, selon le système du client MontantPrêt - Montant initial du prêt en cents USD Prêteur - Nom du prêteur pour ce prêt Le tableau JSON peut également contenir le champ facultatif suivant : vaultId - Il s'agit du vaultId de l'entrée dans le tableau des chambres fortes. Si ce paramètre n'est pas spécifié, le système utilise le vaultId du paramètre vaults. Si ce paramètre est spécifié, il doit correspondre au vaultId du paramètre vaults.
version	Non	Version du protocole à utiliser. Actuellement, la seule valeur prise en charge est Lending-1.0.
postRegisterOption	Non	Une fois que la copie faisant autorité d'un document est enregistrée dans e-Vault Manager, elle est retirée de OneSpan Sign. Ce paramètre indique comment cette copie faisant autorité sera remplacée. Les valeurs prises en charge sont les suivantes : watermark_doc (par défaut) - Après l'enregistrement d'un document dans e-Vault Manager, le contenu du PDF signé est marqué d'un filigrane, aplati et enregistré sur OneSpan Sign. blank_doc - Après l'enregistrement d'un document auprès d'e-Vault Manager, le contenu du PDF signé est remplacé dans OneSpan Sign par un document vierge.

Exemple

Voici un exemple de décodage en base64 d'une valeur « registry_data » décodée en base64 :

{
    "version": "Lending-1.0",
    "postRegisterOption": "watermark_doc",
    "vaults": [{
            "transaction": "sample-transaction1",
            "orgId": "org1",
            "vaultId": "1"
        }
    ],
    "registryRecords":[{
            "documentId":"UnsignedDocument01",
            "registryId": "loan123-Id01",
            "borrowers": ["Borrower2"],
            "loanId": "loan123",
            "loanAmount": "999999",
            "lender": "ABC Corporation",
            "vaultId": "1"
        },{
            "documentId":"UnsignedDocument02",
            "registryId": "loan123-Id02",
            "borrowers": ["Borrower3"],
            "loanId": "loan234",
            "loanAmount": "999",
            "lender": "Ajax Corporation",
            "vaultId": "1"
        }
    ]
}

<?xml version="1.0" encoding="UTF-8"?>
<email-template xmlns="urn:schema.awsng.silanis.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<from>
<email>[email protected]</email>
<display_name>OSS Support</display_name>
</from>
<to>
<address>
<email>%USER_EMAIL;</email>
<display_name>%USER_FIRST_NAME; %USER_LAST_NAME;</display_name>
</address>
</to>
                
<subject>e-Sign Ceremony Failure Notification</subject>
<body>
<content-type>text/html; charset="UTF-8"</content-type>
<content>
                
Dear %USER_FIRST_NAME; %USER_LAST_NAME;,<br/>
<br/>
An error has occurred for your package: <br/>
<br/>
%NOTIFICATION_MESSAGE;<br/>
<br/>
Should you have any problem, please contact OSS Support at [email protected]
<br/>
<br/>
                
Thank you for e-signing.<br/>
<br/>
                
OSS Support
</content>
</body>
<priority>1</priority>
                
</email-template>