How can we help?

Set up Guide: SFTP Integration

Emily B
Emily B
  • Updated

10KC’s SFTP integration streamlines adding, updating, deleting, and deactivating member profiles. It works by importing a CSV file that you’ll upload to a SFTP server on a set cadence (weekly, monthly, etc). CSV files are usually exported from your HRIS, Identity Management, or CRM software. Each line in the CSV will represent one member’s profile. 

Capabilities

Updating profiles

  • Employees in the latest flat file with active 10KC accounts will have their 10KC profiles updated to match the values in the flat file.

Creating New Profiles

  • Employees added to the latest flat file who do not have 10KC accounts will receive an email invitation to create an account. Employees with existing 10KC accounts will not receive email invitations.

Deleting Profiles

  • Employees removed in the latest flat file will have their 10KC accounts deleted. Deleted accounts are removed from the platform entirely, though they can be restored within 30 days, if a request is submitted to our customer success team.

Deactivating Profiles

  • We’ll hide accounts for people who go on leave but are still active employees, like those on parental leave. Deactivated accounts don’t show up in search results, and other members cannot message them. Deactivated accounts don’t receive any 10KC communications. To set this functionality up, we need a field in the CSV that represents “Employee Status”. We expect the values “active” or “inactive. We will deactivate accounts when status changes to “inactive”. We will reactivate accounts if the status changes back to “active”.

Implementation

  1. Confirm file upload frequency. For most customers, a monthly frequency works best, although in some cases, we may recommend a weekly upload frequency.
  2. Sample CSV File Creation: You’ll share a sample CSV file.
  3. Sample CSV File Review: 10KC team will review the sample file to ensure it meets requirements.
  4. Profile Updates Verification: Using the sample CSV file, 10KC to share list of profiles to be updated, deleted, and created in the platform tenant. Your team will verify.
  5. Integration Activation: After verification, 10KC team will turn on the integration capabilities.

Team: whom to involve and when

You will need to involve other people in your organization to complete activities during different phases of the implementation.

A summary is below, along with the typical effort required, and which Implementation Phases they can expect to be involved in.

Role

Responsibilities

Effort

Implementation Phases

Program Owner

• Provide oversight

Low

• Discovery

• Testing

Project Manager

• Coordinate people to complete tasks

Medium

• All phases

Technical Implementer, SFTP

• Create and test SFTP accounts to facilitate transfer of member profile data

 

• Scheduled file upload (example: Cron job, Extract Transfer Load (ETL) pipeline, etc)

 

Low to medium

• All phases

Technical Implementer, HRIS or Identity Management Software

• Create demographic data for SFTP profile transfer

Low to medium

• All phases

 

How to create your membership data file

This guide will help you create a member data file for 10KC. Follow the steps to ensure a successful upload.

Sharing flat files with 10KC

Upload the flat files to a SFTP server. You can upload it on your own or use 10KC's SFTP server.

Your SFTP technical implementation team can automate uploading flat files to 10KC on a set cadence (weekly, monthly, or quarterly) by using the SFTP protocol.

A. If your team prefers their own SFTP server

We can configure 10KC to automatically pull files from your SFTP server on a scheduled basis.

To set this up, provide SFTP credentials to 10KC by sending them to integrations@10kc.com including:
- Host/IP address
- Port number
- Username
- Authentication method (password or SSH key)
- File path/directory where files will be placed

B. If your team wants to use 10KC's SFTP server

10KC will share SFTP credentials with your IT team.

They can then schedule an automated upload to the 10KC server using the following command:

sftp -P 2022 -i /path/to/rsa_private_key username@ip_address (we can provide the IP address upon request)

Secure File Transfer Requirements

All files transferred via SFTP must be encrypted using OpenPGP (RFC 4880) to ensure data security.

Here's what you need to know:

File Encryption
- Files must be encrypted using the OpenPGP standard before upload
- We support a variety of file extensions: .pgp, .gpg, .asc 
- We support both symmetric and asymmetric encryption methods

Getting Started with OpenPGP
1. When setting up the integration, contact integrations@10kc.com to:
- Receive 10KC's public PGP key for file encryption
- Share your public PGP key if using asymmetric encryption
2. Test your encryption setup by sending a sample encrypted file
3. Once verified, proceed with regular file uploads as described in "Sharing flat files with 10KC"

Security & Compliance

The 10KC platform is SOC 2 Type II certified, ISO 27001 compliant, and GDPR compliant. All data is encrypted both in transit (TLS 1.2) and at rest (AES-256), and the infrastructure is hosted on Google Cloud with enterprise-grade security controls. For information about 10KC's security, compliance, and data protection practices, please visit our Trust Center.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.