You can now create and screen batches of customers via SFTP. In this article, you will learn the following:
- How to generate a file in the correct format and select a screening configuration
- How to request your SFTP user in Mesh
- How to connect to our SFTP server
- How to deposit files in our SFTP server
Generate a file
You can drop CSVs containing your list of customers to create-and-screen into our SFTP server. To ensure that the correct formatting is used, you can download templates from the file upload page in the Mesh web-app and use these to create your customer record files.
- Click on Download templates in the upper right corner.
- Select Download for the template and format you want to download.
The template will be downloaded to your computer.
- Fill in your customer data following the structure given in the template.
You can fill in as many columns as you want. The more data is provided, the better the risk scoring and screening assessment will be. You can also remove any columns that you know you won’t provide data for as long as all mandatory fields are included. The only mandatory fields are:
- customer.external_identifier
- customer.person.last_name OR customer.person.full_name, not both (if customer is a person)
- customer.company.legal_name (if customer is a company)
Please note that if you add columns to the file that do not match our schema (i.e., column headers that don't match those in the template), the file will fail validation.
Select a screening configuration
To define which screening configuration should be used to screen your customer, your file has to contain the column header customer.configuration.screening_configuration_identifier.
Fill in the ID of the screening configuration that should be used. The ID can be copied from the screening configuration page in Settings.
Be aware that if you don’t provide the screening ID, the customer will be screened against ALL sources by default.
Request Your SFTP User in Mesh
You will need to contact Support to create an SFTP user in Mesh. This is required to associate your Account on our SFTP server with a user in the Mesh platform.
Please contact Support at support@complyadvantage.com to request your SFTP user in Mesh.
Connecting To Our SFTP Server
SFTP Account User and Password
Upon request, ComplyAdvantage will create a unique SFTP user and password for your use, shared via a secure channel. In addition, if you want to apply IP restrictions to inbound connections for your user, ComplyAdvantage can provide these, and it will apply them on your behalf.
Host Key Pairs
ComplyAdvantage uses fixed and known host key pairs. SFTP users must ensure they validate their connections against the public keys provided to avoid the risk of sensitive data being sent to improper endpoints. Any change in public keys will be communicated in advance. Our Support team will share host key pairs with you during setup.
Local SFTP Client
You are free to use any SFTP client to manage file uploads locally. A popular choice is FileZilla, a free, open-source tool for connecting to SFTP servers, managing files, and uploading and downloading large files.
Please contact Support (support@complyadvantage.com) if you have any questions or need assistance getting started.
Uploading Your File To Our SFTP Server
Uploading a file
Once connected to our SFTP Server, you will see options for where to place your file to upload. We currently support the following upload workflows.
1. Create-and-Screen Customers
To upload files of customers to create and then screen for onboarding purposes, please deposit the file in the /customers/workflows/create-and-screen folder.
We will be adding additional workflows in the near future.
Checking the status of a file
Once you have dropped your file into our SFTP server, your file will show in the validation queue in the Mesh web-app.
When the file validation is successful, the file is uploaded and will show as completed. Please be aware that some processing steps are still happening in the background after the upload shows as completed. Your records may take up to 24 hours to appear.
Resolve validation errors
If your file contains any values that don’t match the required format, validation errors will be returned, and you will have to resolve all errors before the file can be re-uploaded.
Below is an example of a file that failed validation.
To resolve the errors:
- Click on File errors for the file that shows as failed in the validation queue.
- Review the errors in the pop-up.
Be aware that the number of returned errors is limited to 50. If your file contains more errors, these will be returned on re-upload until all errors have been resolved.
- Open your original file to correct the invalid values.
- Re-upload your corrected file.
Remove files that have failed validation
Files that failed validation will show in the validation queue until you dismiss them.
- Click the x icon in the upper right corner of the failed file to remove it.
- Click Remove file to confirm the removal.
A success notification is displayed.
Filter uploads table
By default, the 'All uploads' table shows all files that are Completed, Processing or Failed. The results are sorted by Upload date, the most recently uploaded file is at the top.
You can sort each table column by clicking into the column header. Also, you can use the filter option above the table to filter the results by their status. Click once to select and filter by a status, click another time to deselect.