Nous avons effectué des mises à jour ! Consultez notre portail de documentation mis à jour ! En savoir plus...

Paramètres des transactions pour les prêts hypothécaires

Prev Next

OneSpan Sign a créé une solution de prêt hypothécaire numérique qui peut stocker un e-Note provenant d’une transaction hypothécaire dans un coffre-fort numérique. Pour une transaction donnée, OneSpan Sign sauvegarde un seul e-Note au format SMART Document .

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 quel coffre-fort il doit être stocké. Après avoir été sauvé, le document SMART original est supprimé de la base de données OneSpan Sign.

Les modèles Smart Document utilisés par OneSpan Sign pour les transactions impliquant des hypothèques prennent en charge les sections ARC du modèle. Cette fonctionnalité est requise par la Federal Home Loan Mortgage Corporation des États-Unis (également connue sous le nom de Freddie Mac).

Créer une transaction ou un modèle avec l’API REST implique toujours certains paramètres standards — voir Paramètres de l’expérience du signataire.

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 sauvegarde d’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 email ne peut pas être personnalisé.

Utilisation d’un coffre eOriginal pour les transactions hypothécaires numériques

Si vous souhaitez stocker un e-Note 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 e-Note dans un coffre-fort eOriginal, les intégrateurs doivent ajouter les deux champs suivants au champ de data la transaction :

eOriginal sauvegarde un e-Note issu d’une transaction OneSpan Sign ainsi que le journal d’audit de la transaction.

Si une transaction hypothécaire comporte un document SMART et un ou plusieurs PDF : (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.

enote_data_section

Ce champ contient une chaîne XML codée en base64. Cette chaîne contient suffisamment d’informations pour créer le document SMART (y compris la valeur du prêt, les détails de l’emprunteur et l’adresse du bien hypothéqué).

Ce champ doit être formaté en utilisant le format XML de la section Data > Main de la spécification MISMO SMART Document 1.02 .

Exemple

Voici un exemple de valeur enote_data_section décodée en Base64 :

<LOAN MISMOVersionIdentifier="2.3">
        <_APPLICATION>
        <LOAN_PRODUCT_DATA>
        <LOAN_FEATURES LienPriorityType="FirstLien" LoanMaturityDate="2030-01-01" OriginalPrincipalAndInterestPaymentAmount="1111.99" ScheduledFirstPaymentDate="2020-01-01">
        <LATE_CHARGE _GracePeriod="15" _Rate="5.000"></LATE_CHARGE>
        <NOTE_PAY_TO _City="Springfield" _PostalCode="99999" _State="MI" _StreetAddress="5555 Example Drive"></NOTE_PAY_TO>
        </LOAN_FEATURES>
        </LOAN_PRODUCT_DATA>
        <MERS MERS_MINNumber="100316200000000012"/>
        <MORTGAGE_TERMS LenderLoanIdentifier="999999999" NoteRatePercent="5.300" OriginalLoanAmount="205000.00" PaymentRemittanceDay="1"></MORTGAGE_TERMS>
        <PROPERTY _City="Greenfield" _County="Green" _PostalCode="00000" _State="CA" _StreetAddress="100 Main Street">
        <PARSED_STREET_ADDRESS _HouseNumber="100" _StreetName="Main Street"></PARSED_STREET_ADDRESS>
        </PROPERTY>
        <BORROWER BorrowerID="N1001" NonPersonEntityIndicator="N" _FirstName="Homer" _LastName="Homeowner" _MiddleName="J." _SSN="555555559" _SequenceIdentifier="1" _UnparsedName="HomerJHomeowner"></BORROWER>
        <BORROWER BorrowerID="N1002" NonPersonEntityIndicator="N" _FirstName="Patricia" _LastName="Purchaser" _MiddleName="P." _SSN="666666669" _SequenceIdentifier="2" _UnparsedName="PatriciaPPurchaser"></BORROWER>
        </_APPLICATION>
        <_CLOSING_DOCUMENTS>
        <EXECUTION _City="Orange" _Date="2020-01-01" _State="CA"></EXECUTION>
        <LENDER _UnparsedName="Sample Banking Group"></LENDER>
        </_CLOSING_DOCUMENTS>
        </LOAN>
    

enote_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 consultés.

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

Paramètre

Obligatoire?

Description

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ù l’e-Note 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 des comptes de production.

enote_name

Oui

Nom qui sera donné à l’e-Note dans la transaction OneSpan Sign associée (puis plus tard à l’e-Note dans le coffre-fort eOriginal).

document_type

Oui

Ce paramètre est utilisé dans le service eCore d’eOriginal pour classer les documents selon leur processus lié au sein de votre entreprise. Il doit correspondre à un type de document configuré pour votre organisation client eCore originale du service eCore.

PrêtsOriginateurs

Oui

La valeur de ce paramètre est un tableau JSON qui doit contenir une ou plusieurs entrées, chacune comportant les trois éléments suivants :

  • nmlsId — Identifiant attribué à l’initiateur de prêt par le Système et le Registre Nationaux de Licence Hypothécaire

  • unparsedName — Nom de l’individu ou de l’organisation originateur de prêt

  • nonPersonEntityIndicator — Les valeurs possibles sont Y et N. Y indique que ces données d’originateur de prêts représentent une organisation. N indique que ces données d’originateur de prêts représentent un individu.

Version

Non

Version du protocole à utiliser. Actuellement, la seule valeur garantie est le Mortgage-2.0.

enote_template_name

Non

Nom du modèle qui sera utilisé pour créer le document SMART. Les valeurs prises en charge sont :

  • template_3200_enote.xml — Ceci correspond au formulaire Multistate Fixed Rate eNote 3200e.

  • template_3244-1_enote.xml — Ceci concerne le formulaire Texas Home Equity eNote 3244.1.

  • template_3244-2_enote.xml — Ceci correspond au formulaire Texas Home Equity eNote Second Lien.

additionalDocumentsToVault

Non

La valeur de ce paramètre est un tableau JSON qui doit contenir une ou plusieurs entrées. Chaque entrée : (1) contient des informations sur le voût pour un document spécifique ; (2) doit comporter les champs requis suivants :

  • documentId — ID du document OneSpan Sign qui sera enregistré avec le service eCore d’eOriginal. Ce document est généralement un prêt. La valeur de ce paramètre doit correspondre à l’identifiant du document d’un 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 — Paramètre utilisé dans le service eCore d’eOriginal pour classer les documents selon leur processus lié au sein de votre entreprise. Doit correspondre à un type de document configuré pour votre organisation cliente de service eCore originale.

loanId, loanAmount et lender ne sont envoyés à eOriginal que pour le premier élément de la liste. Pour les objets suivants, ces valeurs ne sont pas envoyées à eOriginal.

postRegisterOption

Non

Après que la copie officielle d’un document a été conservé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é enregistré, 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é 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 Texte non autorisé.

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 de enote_vaulting_data décodée en Base64 :

{
        "version": "Mortgage-2.0",
        "vaultCredentials": {
        "username": "SampleUsername",
        "orgName": "SampleOrganization",
        "apiKey": "ok0Sample0ApiKey0Just0An0Example",
        "endpoint":"testondemand"
        },
        "enote_name": "enote",
        "enote_template_name": "template_3200_enote.xml",
        "document_type": "eNote",
        "loanOriginators": [{
        "nmlsId": "1000000",
        "unparsedName": "Sample Lender Person",
        "nonPersonEntityIndicator": "N"
        },
        {
        "nmlsId": "1323233",
        "unparsedName": "Sample Lender Corp.",
        "nonPersonEntityIndicator": "Y"
        }],
        "customFields": {
        "externalId":"123ABC",
        "customField2":"value"
        },
        }
    

Modèle d’email pour une défaillance de la sauvegarde

Si une tentative de sauvegarde d’un e-Note échoue, OneSpan Sign utilise le modèle suivant pour envoyer un e-mail à l’expéditeur de la transaction associée 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 de défaillance ci-dessus ne sera pas envoyée si l’une des erreurs suivantes survient dans le vaulting_data champ JSON :

Erreur

Ce que la requête POST /api/packages restitue

Le champ documentId pour le paramètre documentsToVault est incorrect (c’est-à-dire qu’il ne s’agit pas d’un documentID dans la transaction).

200

Le champ de nom d’utilisateur pour les paramètres vaultCredentials est incorrect.

200

Le champ apiKey pour le paramètre vaultCredentials est incorrect.

500

« messageKey » : « error.internal.default »,"technical » : « error.eslx.validation.eoclient.loginError »

Le champ orgName pour les paramètres 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érencer vaultCredentials en valutCredentials.

200