Self-Service Batch Append
The Batch Upload feature in the Console allows enrichment workflows to be conducted in a self-service manner without hitting the API directly or interacting with a member of the Enigma team.
This method of enriching a file is recommended if:
- You are only looking to enrich records at the business location level, and
- You are not looking for any time-series data (if looking for Merchant Transaction Signals data the most recent available month of data is still available), and
- The number of records to be enriched is no more than 20k.
Accepted File Types
Enrichment (Batch Append) accepts and produces the following tabular data types:
File Extension Name Encoding .csv comma, separated, values utf-8 .tsv tab separated values utf-8 .psv pipe | separated | values utf-8 .parquet parquet binary file format
compression support:
snappy, lz4, gzip zstd
Using Batch Upload
File Content
To begin, prepare a tabular data file containing columns that correspond to the following fields:
| Field | Used on Match Type | Description | Example | Maximum |
|---|---|---|---|---|
business_name | Business Match, Business Location Match, KYB Match | This is the name under which the business location operates | Enigma Technologies Inc. | 2 |
street_address1 | Business Location Match, KYB Match | This is the primary (freeform) part of the street address of the business location (KYB only: or legally registered location of the business) | 245 Fifth Avenue | 2 sets of addresses |
street_address2 | Business Location Match, KYB Match | Secondary address components (e.g. floor, suite, apartment number) of the business location address (KYB only: or legally registered location of the business) | 8th fl | 2 sets of addresses |
city | Business Location Match, KYB Match | City or locality of the business location address (KYB only: or legally registered location of the business) | New York | 2 sets of addresses |
state | Business Location Match, KYB Match | 2-character state abbreviation of the business location address (KYB only: or legally registered location of the business) | NY | 2 sets of addresses |
postal_code | Business Location Match, KYB Match | Postal code (ZIP Code) of the business location address (KYB only: or legally registered location of the business). Either ZIP (10001) or ZIP4 (10001-3282) are accepted. | 10001-3282 | 2 sets of addresses |
first_name | Business Location Match, KYB Match | This is the first name of an owner or associated person | John | 1 |
last_name | Business Location Match, KYB Match | This is the last name of an owner or associated person | Loremipsum | 1 |
website | Business Match, KYB Match | Website or domain of business | enigma.com | 1 |
Additionally, KYB Match allows for persons connected to the business to be screened against USA sanctions watchlists .
Required Fields
Matches against the following entity types require at a minimum the following fields:
- Business Location: Two of the following: Business Name, Address, Person Name
- Business: Both the Business Name AND Address, or just the website
- KYB Match: Business Name, Address
Feel free to use the sample file, which has correctly formatted headers prepared. Populate these inputs for the business locations whose data you want to retrieve.
While it is not necessary to populate all these fields for every business location in your input file, omitting any of the headers will result in an error and an unsuccessful upload. The minimum inputs required for each row are similar to those required in our match endpoint for business locations, at least two of the following three must be provided: business name, address and/or person.
Matching Process
Once the file is ready, navigate to the Batch Upload tool in the Console and follow the instructions on the page. Drag and drop your file file directly into the browser window. Then, select the type of Enigma Entity you are looking (entity type: business, business location, or legal entity) . From there, choose your desired premium attributes (if only basic identifying attributes are needed, click "Skip and Submit"). Finally, hit "Submit Batch" when ready.
When a job is in progress, its status will be shown as "Pending" in the Batch Activity tab within the Batch Upload feature. Once the job is complete, you will receive an email containing a link to your output file. Alternatively, you can find it directly in the "Batch Activity" tab and download the result from there.
Later, you can also use the Batch Activity tab to track your batch upload history. You'll be able to see the name of the file you uploaded, when it was submitted, how many rows it contained, which premium attributes were requested, and which query parameters were used. Completed files are accessible to download for up to 1 year - please download completed files if you wish to access them at a later date.
Updated 5 months ago