Skip to main content

​
Customer File Requirements

Required for all customer types.
  • Individual
  • Business
  • Sole Prop
If submitting Customer and / or Customer Relationship files multiple times a day, files should use batch-id. The batch ID needs to be a unique string in order for multiple file submissions to go through. If not planning on using multiple submissions per day, you may just use date as the batch ID. BatchID is used to group the Customer and Customer Relationship files together for each upload.

​
Batch ID Naming Convention

<Batch-ID>_<FileType>_<Version>.<FileExtension>

​
Examples

  • 2024-12-25-01-Batch-1_customer_V1.csv
  • 2024-12-25-01-batch-1_beneficial_owner_V1.csv

​
Updating Existing Files

Lead replaces the existing list with the new list provided. Files exhibit a PUT behavior so please provide the entire record.

​
Additional Requirements

Only required for:
  • Business
  • Sole Prop
If customer_type = business or sole_prop is supported in your program, please always provide both Customer and Customer Relationship files, even during the days with no entries. The two files work as a pair for Lead to perform validations. When creating customer_type = business or sole_prop, at the time of Customer Relationship creation, Lead will check for the following:
  • If customer_type = business,
    • client_individual_id and client_business_id must exist in Customer data submission up until Customer Relationship submission. If client_individual_id or client_business_id are not found in our record, we will raise an error.
      Lead expects at least one control person and all available beneficial owners.
  • If customer_type = sole_prop,
    • client_individual_id and client_sole_prop_id must exist in Customer data submission up until Customer Relationship submission. If client_individual_id or client_sole_prop_id are not found in our record, we will raise an error.
      Lead expects one sole proprietor.

​
Error Handling

  1. You will get a success message via Slack if the batch of files work with the list of files.
  2. Upon invalid file upload you will see the error messages in your Slack alert channel
  3. You can fix the batch by updating the version of the file that needed to be fixed and upload it again. Lead will kick off validation for the latest version of each file in the batch.