Batch Upload

View as Markdown

Upload a batch file for verification. Accepts a TXT file containing line-return delimited content.

Authentication

X-API-Keystring
API Key authentication via header

Request

This endpoint expects a multipart form containing a file.
filefileRequired
Batch file content to upload for verification.
namestringRequired1-255 characters
Display name of the batch.
descriptionstring or nullOptional<=2048 characters
Optional description of the batch
typeenumRequired
Type of verification to apply to the batch.
Allowed values:
target_countryenumRequired
Country against which the batch should be processed.
target_audienceenumOptional
1 = Agency / Consultants<br>2 = Creators & Influencers<br>3 = Customer Support & Success<br>4 = Developers & Technical Leads<br>5 = E-commerce & Retail Managers<br>6 = Enterprise Decision-Makers<br>7 = Finance & Operations Professionals<br>8 = Founders & C-Level Executives<br>9 = Freelancers & Solopreneurs<br>10 = Government & Public Sector Employees<br>11 = HR & Talent Acquisition<br>12 = Healthcare Professionals<br>13 = Hobbyists & Enthusiasts<br>14 = Investors & VCs<br>15 = Job Seekers<br>16 = Legal Professionals<br>17 = Marketing & Sales Professionals<br>18 = Non-Profit Leaders & Staff<br>19 = Parents & Families<br>20 = Product & Project Managers<br>21 = Real Estate Professionals<br>22 = Small-to-Medium Business (SMB) Owners<br>23 = Students & Educators
target_market_industryenumOptional
1 = Accommodation<br>2 = Accommodation and Food Services<br>3 = Administrative and Support Services<br>4 = Administrative and Support and Waste Management and Remediation Services<br>5 = Agriculture, Forestry, Fishing and Hunting<br>6 = Air Transportation<br>7 = Ambulatory Health Care Services<br>8 = Amusement, Gambling, and Recreation Industries<br>9 = Animal Production<br>10 = Apparel Manufacturing<br>11 = Arts, Entertainment, and Recreation<br>12 = Beverage and Tobacco Product Manufacturing<br>13 = Broadcasting (except Internet)<br>14 = Building Material and Garden Equipment and Supplies Dealers<br>15 = Chemical Manufacturing<br>16 = Clothing and Clothing Accessories Stores<br>17 = Computer and Electronic Product Manufacturing<br>18 = Construction<br>19 = Construction of Buildings<br>20 = Couriers and Messengers<br>21 = Credit Intermediation and Related Activities<br>22 = Crop Production<br>23 = Data Processing, Hosting, and Related Services<br>24 = Education and Health Services<br>25 = Educational Services<br>26 = Electrical Equipment, Appliance, and Component Manufacturing<br>27 = Electronics and Appliance Stores<br>28 = Fabricated Metal Product Manufacturing<br>29 = Finance and Insurance<br>30 = Financial Activities<br>31 = Fishing, Hunting and Trapping<br>32 = Food Manufacturing<br>33 = Food Services and Drinking Places<br>34 = Food and Beverage Stores<br>35 = Forestry and Logging<br>36 = Funds, Trusts, and Other Financial Vehicles<br>37 = Furniture and Home Furnishings Stores<br>38 = Furniture and Related Product Manufacturing<br>39 = Gasoline Stations<br>40 = General Merchandise Stores<br>41 = Goods-Producing Industries<br>42 = Health Care and Social Assistance<br>43 = Health and Personal Care Stores<br>44 = Heavy and Civil Engineering Construction<br>45 = Hospitals<br>46 = Information<br>47 = Insurance Carriers and Related Activities<br>48 = Internet Publishing and Broadcasting<br>49 = Leather and Allied Product Manufacturing<br>50 = Leisure and Hospitality<br>51 = Lessors of Nonfinancial Intangible Assets (except Copyrighted Works)<br>52 = Machinery Manufacturing<br>53 = Management of Companies and Enterprises<br>54 = Manufacturing<br>55 = Merchant Wholesalers, Durable Goods<br>56 = Merchant Wholesalers, Nondurable Goods<br>57 = Mining (except Oil and Gas)<br>58 = Mining, Quarrying, and Oil and Gas Extraction<br>59 = Miscellaneous Manufacturing<br>60 = Miscellaneous Store Retailers<br>61 = Monetary Authorities - Central Bank<br>62 = Motion Picture and Sound Recording Industries<br>63 = Motor Vehicle and Parts Dealers<br>64 = Museums, Historical Sites, and Similar Institutions<br>65 = Natural Resources and Mining<br>66 = Nonmetallic Mineral Product Manufacturing<br>67 = Nonstore Retailers<br>68 = Nursing and Residential Care Facilities<br>69 = Oil and Gas Extraction<br>70 = Other Information Services<br>71 = Other Services (except Public Administration)<br>72 = Paper Manufacturing<br>73 = Performing Arts, Spectator Sports, and Related Industries<br>74 = Personal and Laundry Services<br>75 = Petroleum and Coal Products Manufacturing<br>76 = Pipeline Transportation<br>77 = Plastics and Rubber Products Manufacturing<br>78 = Postal Service<br>79 = Primary Metal Manufacturing<br>80 = Printing and Related Support Activities<br>81 = Private Households<br>82 = Professional and Business Services<br>83 = Professional, Scientific, and Technical Services<br>84 = Publishing Industries (except Internet)<br>85 = Rail Transportation<br>86 = Real Estate<br>87 = Real Estate and Rental and Leasing<br>88 = Religious, Grantmaking, Civic, Professional, and Similar Organizations<br>89 = Rental and Leasing Services<br>90 = Repair and Maintenance<br>91 = Retail Trade<br>92 = Scenic and Sightseeing Transportation<br>93 = Securities, Commodity Contracts, and Other Financial Investments and Related Activities<br>94 = Service-Providing Industries<br>95 = Social Assistance<br>96 = Specialty Trade Contractors<br>97 = Sporting Goods, Hobby, Book, and Music Stores<br>98 = Support Activities for Agriculture and Forestry<br>99 = Support Activities for Mining<br>100 = Support Activities for Transportation<br>101 = Telecommunications<br>102 = Textile Mills<br>103 = Textile Product Mills<br>104 = Trade, Transportation, and Utilities<br>105 = Transit and Ground Passenger Transportation<br>106 = Transportation Equipment Manufacturing<br>107 = Transportation and Warehousing<br>108 = Truck Transportation<br>109 = Utilities<br>110 = Warehousing and Storage<br>111 = Waste Management and Remediation Services<br>112 = Water Transportation<br>113 = Wholesale Electronic Markets and Agents and Brokers<br>114 = Wholesale Trade<br>115 = Wood Product Manufacturing
target_objectiveenumOptional
1 = App Installs / Downloads<br>2 = Audience Building (Email/Community)<br>3 = Brand Awareness & Recall<br>4 = Customer Acquisition / Sales<br>5 = Free Trial or Freemium Signups<br>6 = Lead Generation (Top/Mid-Funnel)<br>7 = Loyalty & Referral Program Growth<br>8 = Market & Customer Research<br>9 = New Market Entry<br>10 = Partner & Affiliate Recruitment<br>11 = Product Engagement & Feature Adoption<br>12 = Sales-Ready Leads (Bottom-Funnel)<br>13 = Upsell / Cross-sell Revenue<br>14 = User Retention & Churn Reduction<br>15 = Waitlist / Pre-order Signups<br>16 = Website / App Traffic Acquisition
remove_duplicatebooleanOptionalDefaults to true
Whether duplicate rows should be removed during batch preparation.
remove_wrong_email_formatbooleanOptionalDefaults to true
Whether rows with invalid email formatting should be removed during batch preparation.
remove_wrong_phone_formatbooleanOptionalDefaults to true
Whether rows with invalid phone formatting should be removed during batch preparation.
use_account_cachebooleanOptionalDefaults to true
You can choose to enable or disable your account cache. If enabled, we may reuse your previous verification results to speed up processing and improve efficiency. When your account cache is used, you’ll receive a 50% credit refund for those verifications. You can enable both the account cache and the global cache, or disable both. Our system will always check your account cache first, then the global cache.
max_account_cache_backoffintegerOptional1-180Defaults to 30

Set the maximum number of days our system should look back to find matching verification results for this file. Min: 1 (only today) - Max: 180 days.

use_global_cachebooleanOptionalDefaults to true
You can choose to enable or disable the global cache. When the global cache is used, you’ll receive a 50% credit refund for the related verifications. If enabled, your verification results will be shared anonymously with other users, and you'll also gain access to anonymized results from other companies. This shared data is fully abstracted and anonymized, no personal or identifiable information is exposed. By enabling this option, you give us permission to reuse previous verification results across different clients to improve efficiency and reduce redundancy.
max_global_cache_backoffintegerOptional1-180Defaults to 30

Set the maximum number of days our system should look back to find matching verification results for this file. Min: 1 (only today) - Max: 180 days.

Response

Successful Response
okobject
OR
parse_errorobject
OR
errorobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error