Skip to main content

Getting Started

This guide walks you through setting up data integration with RiskScout.

Prerequisites​

Before you begin, ensure you have:

  • Contact information for your core system administrator
  • Ability to create scheduled data exports
  • SFTP client software (e.g., FileZilla, WinSCP, or command-line sftp)

Step 1: Receive SFTP Credentials​

Your RiskScout implementation specialist will provide:

  • Hostname: sftp.riskscout.com
  • Port: 22
  • Username: Your institution-specific username
  • SSH Key: Private key file for authentication
Credential Security

Store your SSH private key securely. Never share it via email or store it in source control.

Step 2: Review Data Requirements​

Familiarize yourself with the required data entities:

  1. Customers - Customer demographic and identification data
  2. Accounts - Account details and balances
  3. Transactions - Transaction activity
  4. Customer Relationships - Account ownership linkages
  5. Branches - Branch reference data (if applicable)

Each entity page describes required vs. optional fields and expected data formats.

Step 3: Map Your Fields​

Create a mapping between your core system fields and RiskScout fields:

Your FieldRiskScout FieldNotes
CUST_IDcustomer_numberPrimary customer identifier
ACCT_NOaccount_numberPrimary account identifier
.........

Your implementation specialist will work with you on code mappings for values like transaction types and account types.

Step 4: Configure File Exports​

Set up automated exports from your core system:

File Naming Convention​

{entity}_{YYYYMMDD}.csv

Examples:

  • customers_20240115.csv
  • transactions_20240115.csv
  • accounts_20240115.csv

File Format​

  • Format: CSV (comma-separated values)
  • Encoding: UTF-8
  • Header Row: Required (field names must match schema)
  • Quoting: Double-quote text fields containing commas
  • Date Format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS
  • Null Values: Empty string (no value between delimiters)

Example CSV​

customer_number,first_name,last_name,date_of_birth,tin,tin_type
C001234,John,Smith,1985-03-15,***-**-5678,SSN
C001235,Acme Corporation,,,,EIN

Step 5: Test File Submission​

  1. Generate test files with a small subset of data
  2. Upload via SFTP to your institution's folder
  3. Wait for processing (typically within 1 hour)
  4. Review results with your implementation specialist
# Example SFTP upload
sftp -i ~/.ssh/riskscout_key username@sftp.riskscout.com
put customers_20240115.csv /inbound/
put accounts_20240115.csv /inbound/
put transactions_20240115.csv /inbound/
exit

Step 6: Go Live​

Once test files validate successfully:

  1. Configure daily/weekly automated exports
  2. Set up scheduled SFTP transfers
  3. Monitor for processing notifications
  4. Contact support if issues arise

Directory Structure​

Your SFTP folder structure:

/
├── inbound/          # Upload files here
├── processed/        # Successfully processed files
├── quarantine/       # Files with errors
└── archive/          # Historical files

Troubleshooting​

Connection Issues​

  • Verify hostname and port
  • Ensure SSH key has correct permissions (chmod 600)
  • Check firewall allows outbound port 22

File Processing Errors​

  • Check email notifications for error details
  • Verify field names match schema exactly
  • Ensure date formats are consistent
  • Look for special characters in text fields

Need Help?​

Contact support@riskscout.com with:

  • Your institution name
  • File name(s) with issues
  • Error messages received
  • Sample data (redacted if sensitive)