{"openapi":"3.1.0","info":{"title":"ApexVerify API","summary":"ApexVerify Production API Server for Worldwide Data Verification","contact":{"name":"ApexVerify","url":"https://apexverify.com/","email":"contact@apexverify.com"},"version":"1.0.0"},"servers":[{"url":"https://api.apexverify.com","description":"Production API Server"}],"paths":{"/v1/account/credits":{"get":{"tags":["Account"],"summary":"Account Credits","description":"Retrieve the current credit balance for the account.","operationId":"get_credits_v1_account_credits_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountCreditResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/batch":{"get":{"tags":["Batch"],"summary":"Batch List","description":"List all batch files for the account, including each batch UUID, status, name, and creation date.","operationId":"batch_list_v1_batch_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"from_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"From Date"}},{"name":"to_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"To Date"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchListModelResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Batch"],"summary":"Batch Upload","description":"Upload a batch file for verification. Accepts a TXT file containing line-return delimited content.","operationId":"batch_upload_v1_batch_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_batch_upload_v1_batch_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SuccessBatchUploadModelResponse"},{"$ref":"#/components/schemas/FailedBatchUploadModelResponse"}],"discriminator":{"propertyName":"status","mapping":{"ok":"#/components/schemas/SuccessBatchUploadModelResponse","parse_error":"#/components/schemas/FailedBatchUploadModelResponse","error":"#/components/schemas/FailedBatchUploadModelResponse"}},"title":"Response Batch Upload V1 Batch Post"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/batch/{batch_uuid}":{"get":{"tags":["Batch"],"summary":"Batch Status","description":"Retrieve the current status of the batch. Once available, the response also includes execution costs, results, and refund information.","operationId":"status_v1_batch__batch_uuid__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"batch_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Batch Uuid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ParsingContentBatchStatusModel"},{"$ref":"#/components/schemas/ReadyForVerificationBatchStatusModel"},{"$ref":"#/components/schemas/VerificationOngoingBatchStatusModel"},{"$ref":"#/components/schemas/VerificationDoneBatchStatusModel"},{"$ref":"#/components/schemas/InternalErrorBatchStatusModel"}],"discriminator":{"propertyName":"status","mapping":{"parsing_content":"#/components/schemas/ParsingContentBatchStatusModel","ready_for_verification":"#/components/schemas/ReadyForVerificationBatchStatusModel","verification_ongoing":"#/components/schemas/VerificationOngoingBatchStatusModel","verification_done":"#/components/schemas/VerificationDoneBatchStatusModel","internal_error":"#/components/schemas/InternalErrorBatchStatusModel"}},"title":"Response Status V1 Batch Batch Uuid Get"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Batch"],"summary":"Batch Parameters Update","description":"Update the batch verification parameters before launch, including country, settings, cache options, and other related configuration.","operationId":"put_v1_batch__batch_uuid__put","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"batch_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Batch Uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchVerificationParametersModelPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Batch"],"summary":"Batch Preparation & Content Reprocessing","description":"Start parsing and preparing the batch for verification once upload done & all parameters are correctly configured. This operation can be triggered as much as required until parameters match requirements.","operationId":"patch_v1_batch__batch_uuid__patch","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"batch_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Batch Uuid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchPatchModelResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Batch"],"summary":"Batch Verification Launch","description":"Start batch verification if the batch status reached ready_for_verification.","operationId":"post_v1_batch__batch_uuid__post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"batch_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Batch Uuid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchPostModelResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}},"402":{"description":"Please reload your credits to proceed with the verification...","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Batch"],"summary":"Batch Deletion","description":"Delete the corresponding batch before or after verification, but not while processing is in progress.","operationId":"delete_v1_batch__batch_uuid__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"batch_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Batch Uuid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/batch/{batch_uuid}/export":{"get":{"tags":["Batch"],"summary":"Batch Result Export","description":"Export batch results in XLSX format, consistent with the frontend output, or as a JSON dump including data and result content, with optional additional sections such as statistics and details.","operationId":"batch_export_v1_batch__batch_uuid__export_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"batch_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Batch Uuid"}},{"name":"format","in":"query","required":true,"schema":{"$ref":"#/components/schemas/BatchExportFormatEnum"}},{"name":"include_details","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Include Details"}},{"name":"include_statistics","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Include Statistics"}}],"responses":{"200":{"description":"Batch export as JSON or XLSX","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchExportModelResponse"}},"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/batch/{batch_uuid}/details":{"get":{"tags":["Batch"],"summary":"Batch Details","description":"Retrieve detailed information about a batch file for the account, including its UUID, status, name, description, parameters, uploaded content, and related metadata.","operationId":"batch_details_v1_batch__batch_uuid__details_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"batch_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Batch Uuid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BaseBatchDetailsModelResponse"},{"$ref":"#/components/schemas/PendingBatchDetailsModelResponse"},{"$ref":"#/components/schemas/FinalBatchDetailsModelResponse"}],"discriminator":{"propertyName":"status","mapping":{"parsing_content":"#/components/schemas/BaseBatchDetailsModelResponse","internal_error":"#/components/schemas/BaseBatchDetailsModelResponse","ready_for_verification":"#/components/schemas/PendingBatchDetailsModelResponse","verification_ongoing":"#/components/schemas/PendingBatchDetailsModelResponse","verification_done":"#/components/schemas/FinalBatchDetailsModelResponse"}},"title":"Response Batch Details V1 Batch Batch Uuid Details Get"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/unit":{"post":{"tags":["Unit"],"summary":"Unit Verification","description":"Start unit verification to get real-time verification results for a given unit. The verification process can take up to 5 seconds to complete, depending on the complexity of the unit...","operationId":"post_v1_unit_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnitVerificationModelPayload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UnitVerificationSuccessModelResponse"},{"$ref":"#/components/schemas/UnitVerificationFailedModelResponse"}],"title":"Response Post V1 Unit Post","discriminator":{"propertyName":"status","mapping":{"ok":"#/components/schemas/UnitVerificationSuccessModelResponse","empty":"#/components/schemas/UnitVerificationFailedModelResponse","parse_error":"#/components/schemas/UnitVerificationFailedModelResponse","error":"#/components/schemas/UnitVerificationFailedModelResponse"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/format":{"post":{"tags":["Format"],"summary":"Data Format Normalization","description":"Normalize Data Format. Accepts a TXT file containing line-return delimited content.","operationId":"format_normalization_v1_format_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_format_normalization_v1_format_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatNormalizationModelResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AccountCreditResponse":{"properties":{"email_credit":{"type":"number","title":"Email Credit"},"phone_credit":{"type":"number","title":"Phone Credit"}},"type":"object","required":["email_credit","phone_credit"],"title":"AccountCreditResponse"},"BadRequestResponse":{"properties":{"message":{"type":"string","title":"Message","default":"Bad Request"}},"type":"object","title":"BadRequestResponse"},"BaseBatch":{"properties":{"batch_uuid":{"type":"string","format":"uuid","title":"Batch Uuid"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"status":{"$ref":"#/components/schemas/BatchStatusEnum"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["batch_uuid","name","description","status","created_at","updated_at"],"title":"BaseBatch"},"BaseBatchDetailsModelResponse":{"properties":{"batch_uuid":{"type":"string","format":"uuid","title":"Batch Uuid"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"status":{"type":"string","enum":["parsing_content","internal_error"],"title":"Status"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"parameters":{"anyOf":[{"$ref":"#/components/schemas/BatchVerificationParametersModelPayload"},{"type":"null"}]}},"type":"object","required":["batch_uuid","name","description","status","created_at","updated_at"],"title":"BaseBatchDetailsModelResponse"},"BatchExportFormatEnum":{"type":"string","enum":["xlsx","json"],"title":"BatchExportFormatEnum"},"BatchExportModelResponse":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BatchVerificationResultsEmailSerial"},{"$ref":"#/components/schemas/BatchVerificationResultsPhoneSerial"}]},"type":"object","title":"BatchExportModelResponse"},"BatchListModelResponse":{"items":{"$ref":"#/components/schemas/BaseBatch"},"type":"array","title":"BatchListModelResponse"},"BatchPatchModelResponse":{"properties":{"status":{"$ref":"#/components/schemas/BatchRequestStatusResponseEnum"}},"type":"object","required":["status"],"title":"BatchPatchModelResponse"},"BatchPostModelResponse":{"properties":{"status":{"$ref":"#/components/schemas/BatchPostRequestStatusResponseEnum"}},"type":"object","required":["status"],"title":"BatchPostModelResponse"},"BatchPostRequestStatusResponseEnum":{"type":"string","enum":["ok","error","not_ready_for_verification","verification_already_ongoing","verification_already_done"],"title":"BatchPostRequestStatusResponseEnum"},"BatchRequestStatusResponseEnum":{"type":"string","enum":["ok","error","parse_error"],"title":"BatchRequestStatusResponseEnum"},"BatchSetupVerificationCostEmail":{"properties":{"total_email_cost":{"type":"integer","title":"Total Email Cost"},"net_email_cost":{"type":"number","title":"Net Email Cost"},"email_cache_account_return":{"type":"integer","title":"Email Cache Account Return"},"email_cache_global_return":{"type":"integer","title":"Email Cache Global Return"}},"type":"object","required":["total_email_cost","net_email_cost","email_cache_account_return","email_cache_global_return"],"title":"BatchSetupVerificationCostEmail"},"BatchSetupVerificationCostPhone":{"properties":{"total_phone_cost":{"type":"integer","title":"Total Phone Cost"},"net_phone_cost":{"type":"number","title":"Net Phone Cost"},"phone_cache_account_return":{"type":"integer","title":"Phone Cache Account Return"},"phone_cache_global_return":{"type":"integer","title":"Phone Cache Global Return"}},"type":"object","required":["total_phone_cost","net_phone_cost","phone_cache_account_return","phone_cache_global_return"],"title":"BatchSetupVerificationCostPhone"},"BatchSetupVerificationParsingEmail":{"properties":{"valid_email":{"type":"integer","title":"Valid Email","default":0},"wrong_email":{"type":"integer","title":"Wrong Email","default":0},"duplicate_email":{"type":"integer","title":"Duplicate Email","default":0}},"type":"object","title":"BatchSetupVerificationParsingEmail"},"BatchSetupVerificationParsingPhone":{"properties":{"valid_phone":{"type":"integer","title":"Valid Phone","default":0},"wrong_phone":{"type":"integer","title":"Wrong Phone","default":0},"duplicate_phone":{"type":"integer","title":"Duplicate Phone","default":0}},"type":"object","title":"BatchSetupVerificationParsingPhone"},"BatchStatusEnum":{"type":"string","enum":["parsing_content","ready_for_verification","verification_ongoing","verification_done","internal_error"],"title":"BatchStatusEnum"},"BatchVerificationParametersModelPayload":{"properties":{"type":{"$ref":"#/components/schemas/BatchVerificationTypeEnum","title":"Verification Type","description":"Type of verification to apply to the batch.","examples":["email"]},"target_country":{"$ref":"#/components/schemas/CountryCodeIso2Enum","title":"Target Country","description":"Country against which the batch should be processed.","examples":["SG"]},"target_audience":{"anyOf":[{"$ref":"#/components/schemas/TargetAudienceEnum"},{"type":"null"}],"enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23],"title":"Target Audience","description":"1 = Agency / Consultants
2 = Creators & Influencers
3 = Customer Support & Success
4 = Developers & Technical Leads
5 = E-commerce & Retail Managers
6 = Enterprise Decision-Makers
7 = Finance & Operations Professionals
8 = Founders & C-Level Executives
9 = Freelancers & Solopreneurs
10 = Government & Public Sector Employees
11 = HR & Talent Acquisition
12 = Healthcare Professionals
13 = Hobbyists & Enthusiasts
14 = Investors & VCs
15 = Job Seekers
16 = Legal Professionals
17 = Marketing & Sales Professionals
18 = Non-Profit Leaders & Staff
19 = Parents & Families
20 = Product & Project Managers
21 = Real Estate Professionals
22 = Small-to-Medium Business (SMB) Owners
23 = Students & Educators","examples":[1]},"target_market_industry":{"anyOf":[{"$ref":"#/components/schemas/TargetIndustryEnum"},{"type":"null"}],"enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115],"title":"Target Market Industry","description":"1 = Accommodation
2 = Accommodation and Food Services
3 = Administrative and Support Services
4 = Administrative and Support and Waste Management and Remediation Services
5 = Agriculture, Forestry, Fishing and Hunting
6 = Air Transportation
7 = Ambulatory Health Care Services
8 = Amusement, Gambling, and Recreation Industries
9 = Animal Production
10 = Apparel Manufacturing
11 = Arts, Entertainment, and Recreation
12 = Beverage and Tobacco Product Manufacturing
13 = Broadcasting (except Internet)
14 = Building Material and Garden Equipment and Supplies Dealers
15 = Chemical Manufacturing
16 = Clothing and Clothing Accessories Stores
17 = Computer and Electronic Product Manufacturing
18 = Construction
19 = Construction of Buildings
20 = Couriers and Messengers
21 = Credit Intermediation and Related Activities
22 = Crop Production
23 = Data Processing, Hosting, and Related Services
24 = Education and Health Services
25 = Educational Services
26 = Electrical Equipment, Appliance, and Component Manufacturing
27 = Electronics and Appliance Stores
28 = Fabricated Metal Product Manufacturing
29 = Finance and Insurance
30 = Financial Activities
31 = Fishing, Hunting and Trapping
32 = Food Manufacturing
33 = Food Services and Drinking Places
34 = Food and Beverage Stores
35 = Forestry and Logging
36 = Funds, Trusts, and Other Financial Vehicles
37 = Furniture and Home Furnishings Stores
38 = Furniture and Related Product Manufacturing
39 = Gasoline Stations
40 = General Merchandise Stores
41 = Goods-Producing Industries
42 = Health Care and Social Assistance
43 = Health and Personal Care Stores
44 = Heavy and Civil Engineering Construction
45 = Hospitals
46 = Information
47 = Insurance Carriers and Related Activities
48 = Internet Publishing and Broadcasting
49 = Leather and Allied Product Manufacturing
50 = Leisure and Hospitality
51 = Lessors of Nonfinancial Intangible Assets (except Copyrighted Works)
52 = Machinery Manufacturing
53 = Management of Companies and Enterprises
54 = Manufacturing
55 = Merchant Wholesalers, Durable Goods
56 = Merchant Wholesalers, Nondurable Goods
57 = Mining (except Oil and Gas)
58 = Mining, Quarrying, and Oil and Gas Extraction
59 = Miscellaneous Manufacturing
60 = Miscellaneous Store Retailers
61 = Monetary Authorities - Central Bank
62 = Motion Picture and Sound Recording Industries
63 = Motor Vehicle and Parts Dealers
64 = Museums, Historical Sites, and Similar Institutions
65 = Natural Resources and Mining
66 = Nonmetallic Mineral Product Manufacturing
67 = Nonstore Retailers
68 = Nursing and Residential Care Facilities
69 = Oil and Gas Extraction
70 = Other Information Services
71 = Other Services (except Public Administration)
72 = Paper Manufacturing
73 = Performing Arts, Spectator Sports, and Related Industries
74 = Personal and Laundry Services
75 = Petroleum and Coal Products Manufacturing
76 = Pipeline Transportation
77 = Plastics and Rubber Products Manufacturing
78 = Postal Service
79 = Primary Metal Manufacturing
80 = Printing and Related Support Activities
81 = Private Households
82 = Professional and Business Services
83 = Professional, Scientific, and Technical Services
84 = Publishing Industries (except Internet)
85 = Rail Transportation
86 = Real Estate
87 = Real Estate and Rental and Leasing
88 = Religious, Grantmaking, Civic, Professional, and Similar Organizations
89 = Rental and Leasing Services
90 = Repair and Maintenance
91 = Retail Trade
92 = Scenic and Sightseeing Transportation
93 = Securities, Commodity Contracts, and Other Financial Investments and Related Activities
94 = Service-Providing Industries
95 = Social Assistance
96 = Specialty Trade Contractors
97 = Sporting Goods, Hobby, Book, and Music Stores
98 = Support Activities for Agriculture and Forestry
99 = Support Activities for Mining
100 = Support Activities for Transportation
101 = Telecommunications
102 = Textile Mills
103 = Textile Product Mills
104 = Trade, Transportation, and Utilities
105 = Transit and Ground Passenger Transportation
106 = Transportation Equipment Manufacturing
107 = Transportation and Warehousing
108 = Truck Transportation
109 = Utilities
110 = Warehousing and Storage
111 = Waste Management and Remediation Services
112 = Water Transportation
113 = Wholesale Electronic Markets and Agents and Brokers
114 = Wholesale Trade
115 = Wood Product Manufacturing","examples":[1]},"target_objective":{"anyOf":[{"$ref":"#/components/schemas/TargetObjectiveEnum"},{"type":"null"}],"enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],"title":"Target Objective","description":"1 = App Installs / Downloads
2 = Audience Building (Email/Community)
3 = Brand Awareness & Recall
4 = Customer Acquisition / Sales
5 = Free Trial or Freemium Signups
6 = Lead Generation (Top/Mid-Funnel)
7 = Loyalty & Referral Program Growth
8 = Market & Customer Research
9 = New Market Entry
10 = Partner & Affiliate Recruitment
11 = Product Engagement & Feature Adoption
12 = Sales-Ready Leads (Bottom-Funnel)
13 = Upsell / Cross-sell Revenue
14 = User Retention & Churn Reduction
15 = Waitlist / Pre-order Signups
16 = Website / App Traffic Acquisition","examples":[1]},"use_account_cache":{"type":"boolean","title":"Use Account Cache","description":"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.","default":true,"examples":[true]},"max_account_cache_backoff":{"type":"integer","maximum":180.0,"minimum":1.0,"title":"Maximum Account Cache Backoff","description":"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.","default":30,"examples":[30]},"use_global_cache":{"type":"boolean","title":"Use Global Cache","description":"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.","default":true,"examples":[true]},"max_global_cache_backoff":{"type":"integer","maximum":180.0,"minimum":1.0,"title":"Maximum Global Cache Backoff","description":"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.","default":30,"examples":[30]},"remove_duplicate":{"type":"boolean","title":"Remove Duplicates","description":"Whether duplicate rows should be removed during batch preparation.","default":true,"examples":[true]},"remove_wrong_email_format":{"type":"boolean","title":"Remove Invalid Email Format","description":"Whether rows with invalid email formatting should be removed during batch preparation.","default":true,"examples":[true]},"remove_wrong_phone_format":{"type":"boolean","title":"Remove Invalid Phone Format","description":"Whether rows with invalid phone formatting should be removed during batch preparation.","default":true,"examples":[true]}},"type":"object","required":["type","target_country"],"title":"BatchVerificationParametersModelPayload"},"BatchVerificationResultsEmailSerial":{"properties":{"email":{"type":"string","title":"Email"},"valid":{"type":"boolean","title":"Valid"},"wrong":{"type":"boolean","title":"Wrong"},"unknown":{"type":"boolean","title":"Unknown"},"quality":{"$ref":"#/components/schemas/EmailResultQuality"},"result":{"$ref":"#/components/schemas/EmailResultResult"},"is_syntax_error":{"type":"boolean","title":"Is Syntax Error"},"is_free":{"type":"boolean","title":"Is Free"},"is_role":{"type":"boolean","title":"Is Role"},"is_disposable":{"type":"boolean","title":"Is Disposable"},"is_catch_all":{"type":"boolean","title":"Is Catch All"}},"type":"object","required":["email","valid","wrong","unknown","quality","result","is_syntax_error","is_free","is_role","is_disposable","is_catch_all"],"title":"BatchVerificationResultsEmailSerial"},"BatchVerificationResultsPhoneSerial":{"properties":{"phone":{"type":"string","title":"Phone"},"valid":{"type":"boolean","title":"Valid"},"wrong":{"type":"boolean","title":"Wrong"},"unknown":{"type":"boolean","title":"Unknown"},"type":{"$ref":"#/components/schemas/PhoneResultNumberType"},"status":{"$ref":"#/components/schemas/PhoneResultLiveStatus"},"is_syntax_error":{"type":"boolean","title":"Is Syntax Error"},"is_ported":{"type":"boolean","title":"Is Ported"},"current_network_mcc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Current Network Mcc"},"current_network_mnc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Current Network Mnc"},"operator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Operator"}},"type":"object","required":["phone","valid","wrong","unknown","type","status","is_syntax_error","is_ported"],"title":"BatchVerificationResultsPhoneSerial"},"BatchVerificationTypeEnum":{"type":"string","enum":["email","phone"],"title":"BatchVerificationTypeEnum"},"Body_batch_upload_v1_batch_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":".TXT Batch File","description":"Batch file content to upload for verification."},"name":{"type":"string","maxLength":255,"minLength":1,"title":"Batch Name","description":"Display name of the batch.","examples":["My Island Customers List"]},"description":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}],"title":"Batch Description","description":"Optional description of the batch","examples":["Verification run for imported customer records."]},"type":{"$ref":"#/components/schemas/BatchVerificationTypeEnum","title":"Verification Type","description":"Type of verification to apply to the batch.","examples":["email"]},"target_country":{"$ref":"#/components/schemas/CountryCodeIso2Enum","title":"Target Country","description":"Country against which the batch should be processed.","examples":["SG"]},"target_audience":{"anyOf":[{"$ref":"#/components/schemas/TargetAudienceEnum"},{"type":"null"}],"enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23],"title":"Target Audience","description":"1 = Agency / Consultants
2 = Creators & Influencers
3 = Customer Support & Success
4 = Developers & Technical Leads
5 = E-commerce & Retail Managers
6 = Enterprise Decision-Makers
7 = Finance & Operations Professionals
8 = Founders & C-Level Executives
9 = Freelancers & Solopreneurs
10 = Government & Public Sector Employees
11 = HR & Talent Acquisition
12 = Healthcare Professionals
13 = Hobbyists & Enthusiasts
14 = Investors & VCs
15 = Job Seekers
16 = Legal Professionals
17 = Marketing & Sales Professionals
18 = Non-Profit Leaders & Staff
19 = Parents & Families
20 = Product & Project Managers
21 = Real Estate Professionals
22 = Small-to-Medium Business (SMB) Owners
23 = Students & Educators","examples":[1]},"target_market_industry":{"anyOf":[{"$ref":"#/components/schemas/TargetIndustryEnum"},{"type":"null"}],"enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115],"title":"Target Market Industry","description":"1 = Accommodation
2 = Accommodation and Food Services
3 = Administrative and Support Services
4 = Administrative and Support and Waste Management and Remediation Services
5 = Agriculture, Forestry, Fishing and Hunting
6 = Air Transportation
7 = Ambulatory Health Care Services
8 = Amusement, Gambling, and Recreation Industries
9 = Animal Production
10 = Apparel Manufacturing
11 = Arts, Entertainment, and Recreation
12 = Beverage and Tobacco Product Manufacturing
13 = Broadcasting (except Internet)
14 = Building Material and Garden Equipment and Supplies Dealers
15 = Chemical Manufacturing
16 = Clothing and Clothing Accessories Stores
17 = Computer and Electronic Product Manufacturing
18 = Construction
19 = Construction of Buildings
20 = Couriers and Messengers
21 = Credit Intermediation and Related Activities
22 = Crop Production
23 = Data Processing, Hosting, and Related Services
24 = Education and Health Services
25 = Educational Services
26 = Electrical Equipment, Appliance, and Component Manufacturing
27 = Electronics and Appliance Stores
28 = Fabricated Metal Product Manufacturing
29 = Finance and Insurance
30 = Financial Activities
31 = Fishing, Hunting and Trapping
32 = Food Manufacturing
33 = Food Services and Drinking Places
34 = Food and Beverage Stores
35 = Forestry and Logging
36 = Funds, Trusts, and Other Financial Vehicles
37 = Furniture and Home Furnishings Stores
38 = Furniture and Related Product Manufacturing
39 = Gasoline Stations
40 = General Merchandise Stores
41 = Goods-Producing Industries
42 = Health Care and Social Assistance
43 = Health and Personal Care Stores
44 = Heavy and Civil Engineering Construction
45 = Hospitals
46 = Information
47 = Insurance Carriers and Related Activities
48 = Internet Publishing and Broadcasting
49 = Leather and Allied Product Manufacturing
50 = Leisure and Hospitality
51 = Lessors of Nonfinancial Intangible Assets (except Copyrighted Works)
52 = Machinery Manufacturing
53 = Management of Companies and Enterprises
54 = Manufacturing
55 = Merchant Wholesalers, Durable Goods
56 = Merchant Wholesalers, Nondurable Goods
57 = Mining (except Oil and Gas)
58 = Mining, Quarrying, and Oil and Gas Extraction
59 = Miscellaneous Manufacturing
60 = Miscellaneous Store Retailers
61 = Monetary Authorities - Central Bank
62 = Motion Picture and Sound Recording Industries
63 = Motor Vehicle and Parts Dealers
64 = Museums, Historical Sites, and Similar Institutions
65 = Natural Resources and Mining
66 = Nonmetallic Mineral Product Manufacturing
67 = Nonstore Retailers
68 = Nursing and Residential Care Facilities
69 = Oil and Gas Extraction
70 = Other Information Services
71 = Other Services (except Public Administration)
72 = Paper Manufacturing
73 = Performing Arts, Spectator Sports, and Related Industries
74 = Personal and Laundry Services
75 = Petroleum and Coal Products Manufacturing
76 = Pipeline Transportation
77 = Plastics and Rubber Products Manufacturing
78 = Postal Service
79 = Primary Metal Manufacturing
80 = Printing and Related Support Activities
81 = Private Households
82 = Professional and Business Services
83 = Professional, Scientific, and Technical Services
84 = Publishing Industries (except Internet)
85 = Rail Transportation
86 = Real Estate
87 = Real Estate and Rental and Leasing
88 = Religious, Grantmaking, Civic, Professional, and Similar Organizations
89 = Rental and Leasing Services
90 = Repair and Maintenance
91 = Retail Trade
92 = Scenic and Sightseeing Transportation
93 = Securities, Commodity Contracts, and Other Financial Investments and Related Activities
94 = Service-Providing Industries
95 = Social Assistance
96 = Specialty Trade Contractors
97 = Sporting Goods, Hobby, Book, and Music Stores
98 = Support Activities for Agriculture and Forestry
99 = Support Activities for Mining
100 = Support Activities for Transportation
101 = Telecommunications
102 = Textile Mills
103 = Textile Product Mills
104 = Trade, Transportation, and Utilities
105 = Transit and Ground Passenger Transportation
106 = Transportation Equipment Manufacturing
107 = Transportation and Warehousing
108 = Truck Transportation
109 = Utilities
110 = Warehousing and Storage
111 = Waste Management and Remediation Services
112 = Water Transportation
113 = Wholesale Electronic Markets and Agents and Brokers
114 = Wholesale Trade
115 = Wood Product Manufacturing","examples":[1]},"target_objective":{"anyOf":[{"$ref":"#/components/schemas/TargetObjectiveEnum"},{"type":"null"}],"enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],"title":"Target Objective","description":"1 = App Installs / Downloads
2 = Audience Building (Email/Community)
3 = Brand Awareness & Recall
4 = Customer Acquisition / Sales
5 = Free Trial or Freemium Signups
6 = Lead Generation (Top/Mid-Funnel)
7 = Loyalty & Referral Program Growth
8 = Market & Customer Research
9 = New Market Entry
10 = Partner & Affiliate Recruitment
11 = Product Engagement & Feature Adoption
12 = Sales-Ready Leads (Bottom-Funnel)
13 = Upsell / Cross-sell Revenue
14 = User Retention & Churn Reduction
15 = Waitlist / Pre-order Signups
16 = Website / App Traffic Acquisition","examples":[1]},"remove_duplicate":{"type":"boolean","title":"Remove Duplicates","description":"Whether duplicate rows should be removed during batch preparation.","default":true,"examples":[true]},"remove_wrong_email_format":{"type":"boolean","title":"Remove Invalid Email Format","description":"Whether rows with invalid email formatting should be removed during batch preparation.","default":true,"examples":[true]},"remove_wrong_phone_format":{"type":"boolean","title":"Remove Invalid Phone Format","description":"Whether rows with invalid phone formatting should be removed during batch preparation.","default":true,"examples":[true]},"use_account_cache":{"type":"boolean","title":"Use Account Cache","description":"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.","default":true,"examples":[true]},"max_account_cache_backoff":{"type":"integer","maximum":180.0,"minimum":1.0,"title":"Maximum Account Cache Backoff","description":"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.","default":30,"examples":[30]},"use_global_cache":{"type":"boolean","title":"Use Global Cache","description":"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.","default":true,"examples":[true]},"max_global_cache_backoff":{"type":"integer","maximum":180.0,"minimum":1.0,"title":"Maximum Global Cache Backoff","description":"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.","default":30,"examples":[30]}},"type":"object","required":["file","name","type","target_country"],"title":"Body_batch_upload_v1_batch_post"},"Body_format_normalization_v1_format_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":".TXT Data Format File","description":"Data Format file content to upload for normalization."},"type":{"$ref":"#/components/schemas/BatchVerificationTypeEnum","title":"Data Type","description":"Type of data to apply to the formatting.","examples":["email"]},"target_country":{"$ref":"#/components/schemas/CountryCodeIso2Enum","title":"Target Country","description":"Country against which the format should be processed.","examples":["SG"]}},"type":"object","required":["file","type","target_country"],"title":"Body_format_normalization_v1_format_post"},"CountryCodeIso2Enum":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BR","BT","BW","BY","BZ","CA","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FO","FR","GA","GB","GD","GE","GG","GH","GI","GL","GN","GP","GQ","GR","GS","GT","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KM","KN","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SI","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TL","TM","TN","TO","TR","TT","TW","TZ","UA","UG","UM","US","UY","UZ","VC","VE","VG","VN","VU","WS","YE","YT","ZA","ZM","ZW"],"title":"CountryCodeIso2Enum"},"EmailResultQuality":{"type":"string","enum":["good","bad","risky","unknown"],"title":"EmailResultQuality"},"EmailResultResult":{"type":"string","enum":["ok","invalid","error","unknown"],"title":"EmailResultResult"},"FailedBatchUploadModelResponse":{"properties":{"status":{"type":"string","enum":["parse_error","error"],"title":"Status"}},"type":"object","required":["status"],"title":"FailedBatchUploadModelResponse"},"FinalBatchDetailsModelResponse":{"properties":{"batch_uuid":{"type":"string","format":"uuid","title":"Batch Uuid"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"status":{"type":"string","const":"verification_done","title":"Status"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"parameters":{"anyOf":[{"$ref":"#/components/schemas/BatchVerificationParametersModelPayload"},{"type":"null"}]},"found_content":{"anyOf":[{"$ref":"#/components/schemas/BatchSetupVerificationParsingEmail"},{"$ref":"#/components/schemas/BatchSetupVerificationParsingPhone"}],"title":"Found Content"},"found_cost":{"anyOf":[{"$ref":"#/components/schemas/BatchSetupVerificationCostEmail"},{"$ref":"#/components/schemas/BatchSetupVerificationCostPhone"}],"title":"Found Cost"},"stats":{"$ref":"#/components/schemas/VerificationStats"}},"type":"object","required":["batch_uuid","name","description","status","created_at","updated_at","found_content","found_cost","stats"],"title":"FinalBatchDetailsModelResponse"},"ForbiddenResponse":{"properties":{"message":{"type":"string","title":"Message","default":"Forbidden"}},"type":"object","title":"ForbiddenResponse"},"FormatNormalizationModelResponse":{"additionalProperties":{"type":"string"},"type":"object","title":"FormatNormalizationModelResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InternalErrorBatchStatusModel":{"properties":{"status":{"type":"string","const":"internal_error","title":"Status"},"message":{"type":"string","title":"Message"}},"type":"object","required":["status","message"],"title":"InternalErrorBatchStatusModel"},"InternalServerErrorResponse":{"properties":{"message":{"type":"string","title":"Message","default":"Internal Server Error. Please contact support at contact@apexverify.com..."}},"type":"object","title":"InternalServerErrorResponse"},"NotFoundResponse":{"properties":{"message":{"type":"string","title":"Message","default":"Not Found"}},"type":"object","title":"NotFoundResponse"},"ParsingContentBatchStatusModel":{"properties":{"status":{"type":"string","const":"parsing_content","title":"Status"}},"type":"object","required":["status"],"title":"ParsingContentBatchStatusModel"},"PaymentRequiredResponse":{"properties":{"message":{"type":"string","title":"Message","default":"Payment Required. Please reload your credits to proceed with the verification..."}},"type":"object","title":"PaymentRequiredResponse"},"PendingBatchDetailsModelResponse":{"properties":{"batch_uuid":{"type":"string","format":"uuid","title":"Batch Uuid"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"status":{"type":"string","enum":["ready_for_verification","verification_ongoing"],"title":"Status"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"parameters":{"anyOf":[{"$ref":"#/components/schemas/BatchVerificationParametersModelPayload"},{"type":"null"}]},"found_content":{"anyOf":[{"$ref":"#/components/schemas/BatchSetupVerificationParsingEmail"},{"$ref":"#/components/schemas/BatchSetupVerificationParsingPhone"}],"title":"Found Content"},"found_cost":{"anyOf":[{"$ref":"#/components/schemas/BatchSetupVerificationCostEmail"},{"$ref":"#/components/schemas/BatchSetupVerificationCostPhone"}],"title":"Found Cost"}},"type":"object","required":["batch_uuid","name","description","status","created_at","updated_at","found_content","found_cost"],"title":"PendingBatchDetailsModelResponse"},"PhoneResultLiveStatus":{"type":"string","enum":["live","dead","absent_subscriber","no_teleservice_provisioned","not_available_network_only","no_coverage","not_applicable","inconclusive"],"title":"PhoneResultLiveStatus"},"PhoneResultNumberType":{"type":"string","enum":["bad_format","mobile","landline","mobile_or_landline","toll_free","premium","shared_cost","voip","stage_and_screen","pager","universal_access_number","personal_number","voicemail_only","msrn","unknown"],"title":"PhoneResultNumberType"},"ReadyForVerificationBatchStatusModel":{"properties":{"status":{"type":"string","const":"ready_for_verification","title":"Status"},"found_content":{"anyOf":[{"$ref":"#/components/schemas/BatchSetupVerificationParsingEmail"},{"$ref":"#/components/schemas/BatchSetupVerificationParsingPhone"}],"title":"Found Content"},"found_cost":{"anyOf":[{"$ref":"#/components/schemas/BatchSetupVerificationCostEmail"},{"$ref":"#/components/schemas/BatchSetupVerificationCostPhone"}],"title":"Found Cost"}},"type":"object","required":["status","found_content","found_cost"],"title":"ReadyForVerificationBatchStatusModel"},"SuccessBatchUploadModelResponse":{"properties":{"status":{"type":"string","const":"ok","title":"Status"},"batch_uuid":{"type":"string","format":"uuid","title":"Batch Uuid"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["status","batch_uuid","created_at"],"title":"SuccessBatchUploadModelResponse"},"SuccessResponse":{"properties":{"message":{"type":"string","title":"Message","default":"Success"}},"type":"object","title":"SuccessResponse"},"TargetAudienceEnum":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23],"title":"TargetAudienceEnum"},"TargetIndustryEnum":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115],"title":"TargetIndustryEnum"},"TargetObjectiveEnum":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],"title":"TargetObjectiveEnum"},"TooManyRequestsResponse":{"properties":{"message":{"type":"string","title":"Message","default":"Too Many Requests"}},"type":"object","title":"TooManyRequestsResponse"},"UnauthorizedResponse":{"properties":{"message":{"type":"string","title":"Message","default":"Unauthorized"}},"type":"object","title":"UnauthorizedResponse"},"UnitVerificationFailedModelResponse":{"properties":{"status":{"type":"string","enum":["empty","parse_error","error"],"title":"Status"}},"type":"object","required":["status"],"title":"UnitVerificationFailedModelResponse"},"UnitVerificationModelPayload":{"properties":{"type":{"$ref":"#/components/schemas/BatchVerificationTypeEnum","title":"Verification Type","description":"Type of verification to apply to the batch.","examples":["email"]},"target_country":{"$ref":"#/components/schemas/CountryCodeIso2Enum","title":"Target Country","description":"Country against which the batch should be processed.","examples":["SG"]},"target_audience":{"anyOf":[{"$ref":"#/components/schemas/TargetAudienceEnum"},{"type":"null"}],"enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23],"title":"Target Audience","description":"1 = Agency / Consultants
2 = Creators & Influencers
3 = Customer Support & Success
4 = Developers & Technical Leads
5 = E-commerce & Retail Managers
6 = Enterprise Decision-Makers
7 = Finance & Operations Professionals
8 = Founders & C-Level Executives
9 = Freelancers & Solopreneurs
10 = Government & Public Sector Employees
11 = HR & Talent Acquisition
12 = Healthcare Professionals
13 = Hobbyists & Enthusiasts
14 = Investors & VCs
15 = Job Seekers
16 = Legal Professionals
17 = Marketing & Sales Professionals
18 = Non-Profit Leaders & Staff
19 = Parents & Families
20 = Product & Project Managers
21 = Real Estate Professionals
22 = Small-to-Medium Business (SMB) Owners
23 = Students & Educators","examples":[1]},"target_market_industry":{"anyOf":[{"$ref":"#/components/schemas/TargetIndustryEnum"},{"type":"null"}],"enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115],"title":"Target Market Industry","description":"1 = Accommodation
2 = Accommodation and Food Services
3 = Administrative and Support Services
4 = Administrative and Support and Waste Management and Remediation Services
5 = Agriculture, Forestry, Fishing and Hunting
6 = Air Transportation
7 = Ambulatory Health Care Services
8 = Amusement, Gambling, and Recreation Industries
9 = Animal Production
10 = Apparel Manufacturing
11 = Arts, Entertainment, and Recreation
12 = Beverage and Tobacco Product Manufacturing
13 = Broadcasting (except Internet)
14 = Building Material and Garden Equipment and Supplies Dealers
15 = Chemical Manufacturing
16 = Clothing and Clothing Accessories Stores
17 = Computer and Electronic Product Manufacturing
18 = Construction
19 = Construction of Buildings
20 = Couriers and Messengers
21 = Credit Intermediation and Related Activities
22 = Crop Production
23 = Data Processing, Hosting, and Related Services
24 = Education and Health Services
25 = Educational Services
26 = Electrical Equipment, Appliance, and Component Manufacturing
27 = Electronics and Appliance Stores
28 = Fabricated Metal Product Manufacturing
29 = Finance and Insurance
30 = Financial Activities
31 = Fishing, Hunting and Trapping
32 = Food Manufacturing
33 = Food Services and Drinking Places
34 = Food and Beverage Stores
35 = Forestry and Logging
36 = Funds, Trusts, and Other Financial Vehicles
37 = Furniture and Home Furnishings Stores
38 = Furniture and Related Product Manufacturing
39 = Gasoline Stations
40 = General Merchandise Stores
41 = Goods-Producing Industries
42 = Health Care and Social Assistance
43 = Health and Personal Care Stores
44 = Heavy and Civil Engineering Construction
45 = Hospitals
46 = Information
47 = Insurance Carriers and Related Activities
48 = Internet Publishing and Broadcasting
49 = Leather and Allied Product Manufacturing
50 = Leisure and Hospitality
51 = Lessors of Nonfinancial Intangible Assets (except Copyrighted Works)
52 = Machinery Manufacturing
53 = Management of Companies and Enterprises
54 = Manufacturing
55 = Merchant Wholesalers, Durable Goods
56 = Merchant Wholesalers, Nondurable Goods
57 = Mining (except Oil and Gas)
58 = Mining, Quarrying, and Oil and Gas Extraction
59 = Miscellaneous Manufacturing
60 = Miscellaneous Store Retailers
61 = Monetary Authorities - Central Bank
62 = Motion Picture and Sound Recording Industries
63 = Motor Vehicle and Parts Dealers
64 = Museums, Historical Sites, and Similar Institutions
65 = Natural Resources and Mining
66 = Nonmetallic Mineral Product Manufacturing
67 = Nonstore Retailers
68 = Nursing and Residential Care Facilities
69 = Oil and Gas Extraction
70 = Other Information Services
71 = Other Services (except Public Administration)
72 = Paper Manufacturing
73 = Performing Arts, Spectator Sports, and Related Industries
74 = Personal and Laundry Services
75 = Petroleum and Coal Products Manufacturing
76 = Pipeline Transportation
77 = Plastics and Rubber Products Manufacturing
78 = Postal Service
79 = Primary Metal Manufacturing
80 = Printing and Related Support Activities
81 = Private Households
82 = Professional and Business Services
83 = Professional, Scientific, and Technical Services
84 = Publishing Industries (except Internet)
85 = Rail Transportation
86 = Real Estate
87 = Real Estate and Rental and Leasing
88 = Religious, Grantmaking, Civic, Professional, and Similar Organizations
89 = Rental and Leasing Services
90 = Repair and Maintenance
91 = Retail Trade
92 = Scenic and Sightseeing Transportation
93 = Securities, Commodity Contracts, and Other Financial Investments and Related Activities
94 = Service-Providing Industries
95 = Social Assistance
96 = Specialty Trade Contractors
97 = Sporting Goods, Hobby, Book, and Music Stores
98 = Support Activities for Agriculture and Forestry
99 = Support Activities for Mining
100 = Support Activities for Transportation
101 = Telecommunications
102 = Textile Mills
103 = Textile Product Mills
104 = Trade, Transportation, and Utilities
105 = Transit and Ground Passenger Transportation
106 = Transportation Equipment Manufacturing
107 = Transportation and Warehousing
108 = Truck Transportation
109 = Utilities
110 = Warehousing and Storage
111 = Waste Management and Remediation Services
112 = Water Transportation
113 = Wholesale Electronic Markets and Agents and Brokers
114 = Wholesale Trade
115 = Wood Product Manufacturing","examples":[1]},"target_objective":{"anyOf":[{"$ref":"#/components/schemas/TargetObjectiveEnum"},{"type":"null"}],"enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],"title":"Target Objective","description":"1 = App Installs / Downloads
2 = Audience Building (Email/Community)
3 = Brand Awareness & Recall
4 = Customer Acquisition / Sales
5 = Free Trial or Freemium Signups
6 = Lead Generation (Top/Mid-Funnel)
7 = Loyalty & Referral Program Growth
8 = Market & Customer Research
9 = New Market Entry
10 = Partner & Affiliate Recruitment
11 = Product Engagement & Feature Adoption
12 = Sales-Ready Leads (Bottom-Funnel)
13 = Upsell / Cross-sell Revenue
14 = User Retention & Churn Reduction
15 = Waitlist / Pre-order Signups
16 = Website / App Traffic Acquisition","examples":[1]},"use_account_cache":{"type":"boolean","title":"Use Account Cache","description":"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.","default":true,"examples":[true]},"max_account_cache_backoff":{"type":"integer","maximum":180.0,"minimum":1.0,"title":"Maximum Account Cache Backoff","description":"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.","default":30,"examples":[30]},"use_global_cache":{"type":"boolean","title":"Use Global Cache","description":"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.","default":true,"examples":[true]},"max_global_cache_backoff":{"type":"integer","maximum":180.0,"minimum":1.0,"title":"Maximum Global Cache Backoff","description":"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.","default":30,"examples":[30]},"unit":{"type":"string","maxLength":320,"minLength":1,"title":"Unit Verification Data","description":"Email, Phone or Address to Verify.","examples":["island@gmail.com","+33612345678"]}},"type":"object","required":["type","target_country","unit"],"title":"UnitVerificationModelPayload"},"UnitVerificationSuccessModelResponse":{"properties":{"status":{"type":"string","const":"ok","title":"Status"},"verification_result":{"anyOf":[{"$ref":"#/components/schemas/BatchVerificationResultsEmailSerial"},{"$ref":"#/components/schemas/BatchVerificationResultsPhoneSerial"}],"title":"Verification Result"}},"type":"object","required":["status","verification_result"],"title":"UnitVerificationSuccessModelResponse"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VerificationDoneBatchStatusModel":{"properties":{"status":{"type":"string","const":"verification_done","title":"Status"},"found_content":{"anyOf":[{"$ref":"#/components/schemas/BatchSetupVerificationParsingEmail"},{"$ref":"#/components/schemas/BatchSetupVerificationParsingPhone"}],"title":"Found Content"},"found_cost":{"anyOf":[{"$ref":"#/components/schemas/BatchSetupVerificationCostEmail"},{"$ref":"#/components/schemas/BatchSetupVerificationCostPhone"}],"title":"Found Cost"},"stats":{"$ref":"#/components/schemas/VerificationStats"}},"type":"object","required":["status","found_content","found_cost","stats"],"title":"VerificationDoneBatchStatusModel"},"VerificationOngoingBatchStatusModel":{"properties":{"status":{"type":"string","const":"verification_ongoing","title":"Status"},"found_content":{"anyOf":[{"$ref":"#/components/schemas/BatchSetupVerificationParsingEmail"},{"$ref":"#/components/schemas/BatchSetupVerificationParsingPhone"}],"title":"Found Content"},"found_cost":{"anyOf":[{"$ref":"#/components/schemas/BatchSetupVerificationCostEmail"},{"$ref":"#/components/schemas/BatchSetupVerificationCostPhone"}],"title":"Found Cost"}},"type":"object","required":["status","found_content","found_cost"],"title":"VerificationOngoingBatchStatusModel"},"VerificationStats":{"properties":{"total_verification":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Verification","default":0},"total_verification_valid":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Verification Valid","default":0},"total_verification_wrong":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Verification Wrong","default":0},"total_verification_unknown":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Verification Unknown","default":0},"total_verification_duplicate":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Verification Duplicate","default":0},"total_verification_account_cache":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Verification Account Cache","default":0},"total_verification_global_cache":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Verification Global Cache","default":0},"total_verification_valid_perc":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Verification Valid Perc","default":0.0},"total_verification_wrong_perc":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Verification Wrong Perc","default":0.0},"total_verification_unknown_perc":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Verification Unknown Perc","default":0.0},"total_verification_account_cache_perc":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Verification Account Cache Perc","default":0.0},"total_verification_global_cache_perc":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Verification Global Cache Perc","default":0.0}},"type":"object","title":"VerificationStats"}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key"}}},"tags":[{"name":"Account","description":"Get account information and details"},{"name":"Batch","description":"Manage batch of data verification"},{"name":"Format","description":"Manage data formatting & normalization"},{"name":"Unit","description":"Manage unit of data verification"}]}