- 18 Nov 2024
- 6 Minutes à lire
- SombreLumière
- PDF
Paramètres de transaction pour le prêt numérique
- Mis à jour le 18 Nov 2024
- 6 Minutes à lire
- SombreLumière
- PDF
OneSpan Sign a créé une solution de prêt numérique qui permet de stocker un prêt ou d’autres documents connexes (p. ex., 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 chambre forte et dans quelle organisation et dans quel coffre-fort il doit être stocké. Une fois que la copie officielle d’un document est mise en chambre forte, elle est remplacée dans la base de données de OneSpan Sign par une copie filigranée ne faisant pas autorité (par défaut) ou un document vierge.
La création d’une transaction ou d’un modèle à l’aide de l’API REST implique toujours certains paramètres standard (voir Java SDK.
Si vous souhaitez afficher tous les appels existants, consultez notre spécification interactive Open API. À partir de là, vous pouvez télécharger le fichier YAML pour notre API REST , rechercher des points de terminaison spécifiques dans cette API et même essayer vous-même quelques appels.
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 au moyen d’un événement de rappel. Une fois que l’effort de stockage d’un document souffre d’une erreur non récupérable, OneSpan Sign envoie à l’expéditeur un e-mail concernant l’échec. Le template de cet e-mail ne peut pas être personnalisé.
Utilisation d’un coffre-fort eOriginal pour les opérations de prêt numériques
Actuellement, l’utilisation de Optional Signatures avec eOriginal n’est pas prise en charge. Par défaut, lors de l’utilisation d’eOriginal, les documents sont mis en coffre-fort dès que la dernière signature a été signée par le dernier signataire. Cependant, lors de l’utilisation de signatures 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 chambre forte.
Si vous souhaitez stocker un document dans un coffre-fort eOriginal, la première chose à faire est de demander à notre équipe d’assistance 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 data
la transaction le vaulting_data
champ JSON décrit ci-dessous.
eOriginal stocke un document de prêt d’une transaction OneSpan Sign avec le journal d’audit de la transaction.
À compter de 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 d’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 encodée en base 64. Lorsque le champ est décodé, les paramètres du tableau suivant peuvent être affichés.
Paramètre | Obligatoire? | Description |
---|---|---|
vaultTransactionTypeName | Non | Cela permet aux clients de stockage en chambre forte de transmettre le nom de type de transaction souhaité au système à l’aide du paramètre transactiontypename . Cela permet aux utilisateurs de distinguer la source de certaines transactions lors de la mise en chambre forte à partir de plusieurs sources qu’ils souhaitent suivre. |
vaultIdentifiants | Oui | Cet objet JSON contient les informations d’identification d’authentification permettant d’accéder à l’API de service eCore d’eOriginal. Cet objet doit contenir les champs obligatoires suivants :
Cet objet JSON contient également le champ facultatif suivant (une valeur par défaut sera utilisée si le champ de point de terminaison n’est pas spécifié) :
|
documentsToVault | Oui | Il s’agit d’un tableau JSON qui doit contenir les champs obligatoires suivants. Chaque entrée du tableau contient des informations de stockage en chambre forte pour un document spécifique.
loanId, loanAmount et lender ne sont envoyés à eOriginal que pour le premier élément du tableau. Pour les articles 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 | Une fois que la copie officielle d’un document est placée 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 :
Remarque : Les clients ne peuvent pas télécharger la copie officielle 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 aplatie ne faisant pas autorité dont chaque page portera le filigrane Copie non faisant autorité. |
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, à condition que son nom corresponde à celui d’un champ personnalisé configuré pour votre organisation client de service eOriginal eCore. |
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"
}
]
}
Modèle d’e-mail en cas d’échec du coffre-fort
Si une tentative de mise en chambre forte d’un document échoue, OneSpan Sign utilise le modèle suivant pour envoyer à l’expéditeur de la transaction associée un courriel concernant l’échec.
Ce modèle ne peut pas être personnalisé.
<?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>support@onespan.com</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 support@onespan.com
<br/>
<br/>
Thank you for e-signing.<br/>
<br/>
OSS Support
</content>
</body>
<priority>1</priority>
</email-template>
La notification d’échec ci-dessus ne sera pas envoyée si l’une des erreurs suivantes se produit dans le vaulting_data
champ JSON :
Erreur | Ce que la requête POST /api/packages renvoie |
---|---|
Le champ documentId du paramètre documentsToVault est incorrect (c’est-à-dire qu’il ne s’agit pas d’un documentID dans la transaction). | 200 |
Le champ username du paramètre vaultCredentials est incorrect. | 200 |
Le champ apiKey du paramètre vaultCredentials est incorrect. | 500 « messageKey » : « error.internal.default »,"technical » : « error.eslx.validation.eoclient.loginError » |
Le champ orgName du paramètre vaultCredentials est incorrect, mais le champ apiKey est correct. | 500 « messageKey » : « error.internal.default »,"technical » : « error.eslx.validation.eoclient.loginError » |
JSON incorrect : par exemple, référencement de vaultCredentials en tant que valutCredentials. | 200 |