SFTP Integration

Overview

Secure File Transfer Protocol, or SFTP, is a secure method for transmitting files through a reliable data stream. It is particularly crucial for customers using LOS/POS/CRM systems not directly integrated with the XMP, as it provides a highly secure means of transmitting transaction data for automated ingestion. In industries like mortgage services, where sensitive information such as loan IDs, emails, names, loan amounts, addresses, and more is involved, ensuring the secure transfer of data is of utmost importance. SFTP serves as a safeguard to protect the confidentiality and integrity of this critical information during the transmission process.

How it Works

To initiate the file transfer process, our customers utilize an FTP client, such as FileZilla, to seamlessly transfer a file from their local computer to their designated XMP server. Once the file reaches the XMP server, IPRO (ingestion processing) takes over, conducting checks for duplicates and mismatches. Subsequently, it prepares the remaining transactions for collection within a campaign, ensuring a streamlined and efficient workflow for automated campaigns.

Creating an SFTP Connection

To transfer files for ingestion via an SFTP connection, there must be an active SFTP configuration within the account. Furthermore, for the campaigns to successfully send, the SFTP configuration will need to be connected in the Set Conditions of the campaign as the ingestion source. To create an SFTP Ingestion configuration in the XMP:

1. To create a new configuration, navigate to the Account Settings page and open the Ingestion Settings. Scroll to find and click SFTP, and then click the blue “New Connection” button.

Open

2. Some information is required to verify and activate the connection. Complete the following:

   1. Connection Name: give the connection a name. This can be anything, but make it easily identifiable to make connecting to campaigns quicker.

   2. File Name: maintain the existing file name (xmp.csv) or customize it according to your preference. For successful processing, every file transferred via this SFTP connection must bear the same designated file name.

   3. Point of Contact: an email address for a technical point of contact, in case an error occurs or if a reconnection is needed. Click the + button.

   4. Date Format: retain the default date format (mm/dd/yy) or customize it to suit your preference. For successful processing, ensure that files adhere to the correct date format, matching the specified format here.

Open

3. Next, you will need to create credentials for the SFTP configuration. This is how you will access the SFTP configuration each time you need to transfer a file of transactions. To create credentials, scroll toward the bottom and find the portion that says Generate.

   1. Generate: choose the type of credentials to create: Private Key or Password. The private key method is the most secure, although a randomly generated password can also be used for the credentials.

   2. Username: provide a username that you will use to log in and access the SFTP connection in your FTP client. Click the + button. When the connection is activated (in a few steps) an accompanying key file or password will be generated and displayed in this section.

4. Ensure the blue checkbox next to Activate Connection is checked, then click the blue Verify & Connect button.

Transferring Data Files via SFTP

Transferring data files via SFTP, as mentioned before, is safe and secure and requires credentials to access the connection's space where files can be transferred. Data must be in the correct file format, so it's useful to save the template below to use in the future when data needs to be formatted for ingestion.

Formatting the Data

To be ingested successfully, transaction data must be formatted per the template provided below. Improperly formatted data may fail the entire processing or specific transactions. Click on the file below or here to download the SFTP template.

Open

Accessing your SFTP Credentials

To access your specific SFTP server space, use the credentials created during the SFTP configuration process. Navigate to the Ingestion Setup for SFTP, then scroll down to the credentials.

If you selected key file credentials, download your key file; if you selected a password, copy the password to your clipboard. Also, take note of the Hostname provided above your credentials.

Use these credentials to log in to the server space created for transaction data files. Once you've gained access to the space in your FTP client, drag and drop or import the file from your desktop to the SFTP connection space.